docs: warn when --ubatch-size is too small in --embeddings mode#25841
Open
chinmaykamjith001 wants to merge 1 commit into
Open
docs: warn when --ubatch-size is too small in --embeddings mode#25841chinmaykamjith001 wants to merge 1 commit into
chinmaykamjith001 wants to merge 1 commit into
Conversation
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Overview
In --embeddings mode with pooling, there was a silent HTTP 500 error due to undocumented --ubatch-size behavior. This happens when input token size exceeds --ubatch-size. This PR aims to document that behavior and include appropriate warnings to users.
In embeddings/pooling configuration, the entire input must fit within a single ubatch of --ubatch-size which is unlike normal inference where the input is split into chunks. This is not documented anywhere, leading users to set small values (e.g. 8 or 512) and get unexplained 500 errors
Changes:
Additional information
Fixes #25293
Related: #6263 (fixed the crash but left the behavior undocumented)
Requirements
I have read and agree with the contributing guidelines
-YES
AI usage disclosure: Yes, AI was used in final verification process of whether my code contained any apparent errosr/unintended effects.