Docs: fix generate-related rendering issues
#30600
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
|
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. |
gante
changed the title
generate-related rendering issues
gante
commented
May 2, 2024
| @@ -21,7 +21,7 @@ more. It also plays a role in a variety of mixed-modality applications that have | |||
| and vision-to-text. Some of the models that can generate text include | |||
| GPT2, XLNet, OpenAI GPT, CTRL, TransformerXL, XLM, Bart, T5, GIT, Whisper. | |||
|
|
|||
| Check out a few examples that use [`~transformers.generation_utils.GenerationMixin.generate`] method to produce | |||
| Check out a few examples that use [`~generation.GenerationMixin.generate`] method to produce | |||
There was a problem hiding this comment.
The text was not being converted to a link. I've checked in the doc preview that it is now a link:
gante
commented
May 2, 2024
| @@ -256,25 +255,21 @@ class GenerationConfig(PushToHubMixin): | |||
| `batch_size`. Indicating a list enables different start ids for each element in the batch | |||
| (e.g. multilingual models with different target languages in one batch) | |||
|
|
|||
|
|
|||
| > Generation parameters exclusive to [assistant generation](https://arxiv.org/abs/2211.17192) | |||
| > Generation parameters exclusive to assistant generation | |||
There was a problem hiding this comment.
Links do not work within the doc section header:
gante
commented
May 2, 2024
| @@ -218,8 +218,7 @@ class GenerationConfig(PushToHubMixin): | |||
| Switch to sequential beam search and sequential topk for contrastive search to reduce peak memory. | |||
| Used with beam search and contrastive search. | |||
|
|
|||
|
|
|||
| > Parameters that define the output variables of `generate` | |||
| > Parameters that define the output variables of generate | |||
There was a problem hiding this comment.
Special formatting with ` does not work here:
amyeroberts
approved these changes
May 2, 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?
See title :)