Docs: add more cross-references to the KV cache docs #33323
Merged
Conversation
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
gante
commented
Sep 5, 2024
| @@ -51,11 +51,11 @@ More concretely, key-value cache acts as a memory bank for these generative mode | |||
|
|
|||
|
|
|||
| See an example below for how to implement your own generation loop. | |||
|
|
|||
There was a problem hiding this comment.
(my VSCode automatically removes any hanging space on save 🤗 )
gante
commented
Sep 5, 2024
gante
commented
Sep 5, 2024
Comment on lines
+432
to
+433
| - a [`~cache_utils.Cache`] instance, see our | ||
| [kv cache guide](https://huggingface.co/docs/transformers/en/kv_cache); |
There was a problem hiding this comment.
Update added to all models supporting Cache classes
gante
commented
Sep 5, 2024
Comment on lines
-731
to
-732
| Two formats are allowed: | ||
| - a [`~cache_utils.Cache`] instance; |
There was a problem hiding this comment.
This is not true for TF models 👀
|
The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update. |
LysandreJik
approved these changes
Sep 5, 2024
gante
commented
Sep 5, 2024
zucchini-nlp
approved these changes
Sep 5, 2024
zucchini-nlp
pushed a commit
to zucchini-nlp/transformers
that referenced
this pull request
Sep 6, 2024
* add more cross-references * nit * import guard * more import guards * nit * Update src/transformers/generation/configuration_utils.py
itazap
pushed a commit
to NielsRogge/transformers
that referenced
this pull request
Sep 20, 2024
* add more cross-references * nit * import guard * more import guards * nit * Update src/transformers/generation/configuration_utils.py
AlpinDale
added a commit
to AlpinDale/transformers
that referenced
this pull request
Sep 26, 2024
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.
What does this PR do?
@zucchini-nlp wrote a great guide for our KV caches. This PR adds more cross-references to that guide in relevant places.
These references were added because: