Unverified Commit d44e1ae0 authored by Jun's avatar Jun Committed by GitHub
Browse files

Fix link in Pipeline documentation (#30948)



fix documentation as suggested by stevhliu
Co-authored-by: default avatarJun <jun@reliant.ai>
parent 0948c827
...@@ -270,7 +270,7 @@ class ConversationalPipeline(Pipeline): ...@@ -270,7 +270,7 @@ class ConversationalPipeline(Pipeline):
Whether or not to clean up the potential extra spaces in the text output. Whether or not to clean up the potential extra spaces in the text output.
generate_kwargs: generate_kwargs:
Additional keyword arguments to pass along to the generate method of the model (see the generate method Additional keyword arguments to pass along to the generate method of the model (see the generate method
corresponding to your framework [here](./model#generative-models)). corresponding to your framework [here](./main_classes/text_generation)).
Returns: Returns:
[`Conversation`] or a list of [`Conversation`]: Conversation(s) with updated generated responses for those [`Conversation`] or a list of [`Conversation`]: Conversation(s) with updated generated responses for those
......
...@@ -154,7 +154,7 @@ class Text2TextGenerationPipeline(Pipeline): ...@@ -154,7 +154,7 @@ class Text2TextGenerationPipeline(Pipeline):
max_length instead of throwing an error down the line. max_length instead of throwing an error down the line.
generate_kwargs: generate_kwargs:
Additional keyword arguments to pass along to the generate method of the model (see the generate method Additional keyword arguments to pass along to the generate method of the model (see the generate method
corresponding to your framework [here](./model#generative-models)). corresponding to your framework [here](./main_classes/text_generation)).
Return: Return:
A list or a list of list of `dict`: Each result comes as a dictionary with the following keys: A list or a list of list of `dict`: Each result comes as a dictionary with the following keys:
...@@ -257,7 +257,7 @@ class SummarizationPipeline(Text2TextGenerationPipeline): ...@@ -257,7 +257,7 @@ class SummarizationPipeline(Text2TextGenerationPipeline):
Whether or not to clean up the potential extra spaces in the text output. Whether or not to clean up the potential extra spaces in the text output.
generate_kwargs: generate_kwargs:
Additional keyword arguments to pass along to the generate method of the model (see the generate method Additional keyword arguments to pass along to the generate method of the model (see the generate method
corresponding to your framework [here](./model#generative-models)). corresponding to your framework [here](./main_classes/text_generation)).
Return: Return:
A list or a list of list of `dict`: Each result comes as a dictionary with the following keys: A list or a list of list of `dict`: Each result comes as a dictionary with the following keys:
...@@ -359,7 +359,7 @@ class TranslationPipeline(Text2TextGenerationPipeline): ...@@ -359,7 +359,7 @@ class TranslationPipeline(Text2TextGenerationPipeline):
for single pair translation models for single pair translation models
generate_kwargs: generate_kwargs:
Additional keyword arguments to pass along to the generate method of the model (see the generate method Additional keyword arguments to pass along to the generate method of the model (see the generate method
corresponding to your framework [here](./model#generative-models)). corresponding to your framework [here](./main_classes/text_generation)).
Return: Return:
A list or a list of list of `dict`: Each result comes as a dictionary with the following keys: A list or a list of list of `dict`: Each result comes as a dictionary with the following keys:
......
...@@ -240,7 +240,7 @@ class TextGenerationPipeline(Pipeline): ...@@ -240,7 +240,7 @@ class TextGenerationPipeline(Pipeline):
truncate a lot of the prompt and not suitable when generation exceed the model capacity) truncate a lot of the prompt and not suitable when generation exceed the model capacity)
generate_kwargs (`dict`, *optional*): generate_kwargs (`dict`, *optional*):
Additional keyword arguments to pass along to the generate method of the model (see the generate method Additional keyword arguments to pass along to the generate method of the model (see the generate method
corresponding to your framework [here](./model#generative-models)). corresponding to your framework [here](./main_classes/text_generation)).
Return: Return:
A list or a list of lists of `dict`: Returns one of the following dictionaries (cannot return a combination A list or a list of lists of `dict`: Returns one of the following dictionaries (cannot return a combination
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment