-
Notifications
You must be signed in to change notification settings - Fork 2.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Python config API docs #22951
Open
RyanUnderhill
wants to merge
2
commits into
gh-pages
Choose a base branch
from
RyanUnderhill/python_config_docs
base: gh-pages
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Python config API docs #22951
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -28,6 +28,65 @@ pip install onnxruntime-genai | |
import onnxruntime_genai | ||
``` | ||
|
||
## Config class | ||
|
||
If the config needs to be modified at runtime to change providers/set provider options, this object can be first created and used, then a model can be created from this config object. If no runtime config changes are needed, a model can be directly created from the model_folder. | ||
|
||
### Load a config | ||
|
||
```python | ||
onnxruntime_genai.Config(model_folder: str) -> onnxruntime_genai.Config | ||
``` | ||
#### Parameters | ||
|
||
- `model_folder`: Location of model and configuration on disk | ||
|
||
#### Returns | ||
|
||
`onnxruntime_genai.Config` | ||
|
||
### Add a provider to the list | ||
|
||
If the provider isn't already in the list of providers, this adds it to the end of the onnxruntime provider priority list. | ||
|
||
```python | ||
onnxruntime_genai.Config.append_provider(provider_name: str) | ||
``` | ||
|
||
#### Parameters | ||
|
||
- `provider_name`: (Required) The provider to set the option on (for example, "dml" or "cuda") | ||
|
||
### Clear list of providers | ||
|
||
Clears the list of providers. This is the only way to remove existing providers to enforce using only a specific provider. | ||
|
||
```python | ||
onnxruntime_genai.Config.clear_providers() | ||
``` | ||
|
||
Example to override the config and only use the dml provider: | ||
```python | ||
config=onnxruntime_genai.Config("model_path") | ||
config.clear_providers() | ||
config.append_provider("dml") | ||
model=onnxruntime_genai.Model(config) | ||
``` | ||
|
||
### Set an option for a provider | ||
|
||
Set an option for a provider. If the provider is not already in the list, it will be added at the end (automatically calls append_provider internally). | ||
|
||
```python | ||
onnxruntime_genai.Config.set_provider_option(provider_name: str, option_name: str, option_value: str) | ||
``` | ||
|
||
#### Parameters | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Please add an example of setting a new provider, as that is the scenario we are addressing with this change |
||
|
||
- `provider_name`: (Required) The provider to set the option on (for example, "dml" or "cuda") | ||
- `option_name`: (Required) Name of the option | ||
- `option_value`: (Required) Value of the option | ||
|
||
## Model class | ||
|
||
### Load a model | ||
|
@@ -46,6 +105,18 @@ onnxruntime_genai.Model(model_folder: str) -> onnxruntime_genai.Model | |
|
||
`onnxruntime_genai.Model` | ||
|
||
### Load a model from a config | ||
|
||
Loads the ONNX model(s) from a config object | ||
|
||
```python | ||
onnxruntime_genai.Model(config: config) -> onnxruntime_genai.Model | ||
``` | ||
|
||
#### Parameters | ||
|
||
- `config`: Config object previously created through onnxruntime_genai.Config | ||
|
||
### Generate method | ||
|
||
```python | ||
|
@@ -369,4 +440,4 @@ onnxruntime_genai.Generator(adapters: Generators::Adapters, adapter: str) -> Non | |
|
||
#### Return value | ||
|
||
None | ||
None |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Once the list is cleared, what provider is used? CPU? Can you state that?