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

docs: fix dynamic batching documentation #6068

Merged
merged 1 commit into from
Oct 4, 2023
Merged

docs: fix dynamic batching documentation #6068

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
4 changes: 2 additions & 2 deletions docs/concepts/serving/executor/dynamic-batching.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,8 +157,8 @@ with Deployment(uses='config.yml') as dep:
## Parameters
The following parameters allow you to configure the dynamic batching behavior on each Executor endpoint:
* `preferred_batch_size`: Target number of Documents in a batch. The batcher collects requests until
`preferred_batch_size` is reached, or until `timeout` is reached. Therefore, the actual batch size could be smaller or
larger than `preferred_batch_size`.
`preferred_batch_size` is reached, or until `timeout` is reached. The batcher then makes sure that the Executor
only receives documents in groups of maximum the `preferred_batch_size` Therefore, the actual batch size could be smaller than `preferred_batch_size`.
* `timeout`: Maximum time in milliseconds to wait for a request to be assigned to a batch.
If the oldest request in the queue reaches a waiting time of `timeout`, the batch is passed to the Executor, even
if it contains fewer than `preferred_batch_size` Documents. Default is 10,000ms (10 seconds).