Skip to content
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.

Sign up for GitHub

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

Add parameters documentation #314

Merged
merged 1 commit into from
Oct 24, 2023
Merged

Add parameters documentation #314

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -638,6 +638,13 @@ returns a JSON string where the keys are the keys of the parameters
object and the values are the values for the parameters field. Note that
you need to parse this string using `json.loads` to convert it to a dictionary.

Starting from 23.11 release, parameters may be provided to the `InferenceRequest`
object during construction. The parameters should be a dictionary of key value
pairs, where keys are `str` and values are `bool`, `int` or `str`.
```python
request = pb_utils.InferenceRequest(parameters={"key": "value"}, ...)
```

You can read more about the inference request parameters in the [parameters
extension](https://github.com/triton-inference-server/server/blob/main/docs/protocol/extension_parameters.md)
documentation.
Expand Down
Loading