From 8a96b0f10a89c1a26d37385d81fa7e3a3ea0a601 Mon Sep 17 00:00:00 2001 From: Patrick von Platen Date: Thu, 17 Mar 2022 20:05:28 +0100 Subject: [PATCH] [Generate Docs] Correct docs (#16133) * [Generate Docs] Correct docs * Apply suggestions from code review Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com> Co-authored-by: Steven Liu <59462357+stevhliu@users.noreply.github.com> --- docs/source/main_classes/text_generation.mdx | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/docs/source/main_classes/text_generation.mdx b/docs/source/main_classes/text_generation.mdx index 509dfe750a..94deeeae89 100644 --- a/docs/source/main_classes/text_generation.mdx +++ b/docs/source/main_classes/text_generation.mdx @@ -12,12 +12,13 @@ specific language governing permissions and limitations under the License. # Generation -The methods for auto-regressive text generation, namely [`~generation_utils.GenerationMixin.generate`] (for the PyTorch models), [`~generation_tf_utils.TFGenerationMixin.generate`] (for the TensorFlow models) and [`~generation_flax_utils.FlaxGenerationMixin.generate`] (for the Flax/JAX models), are implemented in [`~generation_utils.GenerationMixin`], [`~generation_tf_utils.TFGenerationMixin`] and [`~generation_flax_utils.FlaxGenerationMixin`] respectively. +Each framework has a generate method for auto-regressive text generation implemented in their respective `GenerationMixin` class: -The `GenerationMixin` classes are inherited by the corresponding base model classes, *e.g.* [`PreTrainedModel`], [`TFPreTrainedModel`], and [`FlaxPreTrainedModel`] respectively, therefore exposing all -methods for auto-regressive text generation to every model class. +- PyTorch [`~generation_utils.GenerationMixin.generate`] is implemented in [`~generation_utils.GenerationMixin`]. +- TensorFlow [`~generation_tf_utils.TFGenerationMixin.generate`] is implemented in [`~generation_tf_utils.TFGenerationMixin`]. +- Flax/JAX [`~generation_flax_utils.FlaxGenerationMixin.generate`] is implemented in [`~generation_flax_utils.FlaxGenerationMixin`]. -## GenerationMixn +## GenerationMixin [[autodoc]] generation_utils.GenerationMixin - generate @@ -28,12 +29,12 @@ methods for auto-regressive text generation to every model class. - group_beam_search - constrained_beam_search -## TFGenerationMixn +## TFGenerationMixin [[autodoc]] generation_tf_utils.TFGenerationMixin - generate -## FlaxGenerationMixn +## FlaxGenerationMixin [[autodoc]] generation_flax_utils.FlaxGenerationMixin - generate