From 3049458b304987c5c76b7abc1c0c82720e766783 Mon Sep 17 00:00:00 2001 From: Nicolas Patry Date: Wed, 16 Nov 2022 11:29:17 +0100 Subject: [PATCH] Adding doctest for `text-generation` pipeline. --- src/transformers/pipelines/text_generation.py | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/src/transformers/pipelines/text_generation.py b/src/transformers/pipelines/text_generation.py index 4cb78c9bbe77..33ca788e45e4 100644 --- a/src/transformers/pipelines/text_generation.py +++ b/src/transformers/pipelines/text_generation.py @@ -23,6 +23,21 @@ class TextGenerationPipeline(Pipeline): Language generation pipeline using any `ModelWithLMHead`. This pipeline predicts the words that will follow a specified text prompt. + Example: + + ```python + >>> from transformers import pipeline + + >>> generator = pipeline(model="gpt2") + >>> generator("I can't believe you did such a ", do_sample=False) + [{'generated_text': "I can't believe you did such a icky thing to me. I'm so sorry. I'm so sorry. I'm so sorry. I'm so sorry. I'm so sorry. I'm so sorry. I'm so sorry. I"}] + + >>> # These parameters will return suggestions, and only the newly created text making it easier for prompting suggestions. + >>> outputs = generator("My tart needs some", num_return_sequences=4, return_full_text=False) + ``` + + [Learn more about the basics of using a pipeline in the [pipeline tutorial]](../pipeline_tutorial) + This language generation pipeline can currently be loaded from [`pipeline`] using the following task identifier: `"text-generation"`.