[Docs] Explain prompt hidden states in pipeline - #4821
Open
zcxGGmu wants to merge 1 commit into
Open
Conversation
Signed-off-by: zq <zhouquan1511@163.com>
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.
Motivation
The pipeline docs only showed how to fetch last-layer hidden states for generated tokens with
output_last_hidden_state='generation'. Issue #3456 asks how to obtain the prompt/prefill hidden states.Refs #3456
Modification
GenerationConfig(output_last_hidden_state='all').generationreturns generated-token hidden states, whileallalso includes prompt/prefill hidden states.output_last_hidden_state='all'.BC-breaking (Optional)
No. Documentation only.
Use cases (Optional)
Users who need prompt/prefill hidden states can use:
Checklist
PYTHONPATH= python -m pre_commit run --files docs/en/llm/pipeline.md docs/zh_cn/llm/pipeline.mdoutput_last_hidden_state='all'examples.docs/en/llm/pipeline.mdanddocs/zh_cn/llm/pipeline.md.