Skip to content

Commit

Permalink
Fix two tiny typos in `pipelines/base.py::Pipeline::_sanitize_paramet…
Browse files Browse the repository at this point in the history
…ers()`'s docstring (#29102)

* Update base.py

* Fix a typo
  • Loading branch information
sadra-barikbin authored and Ita Zaporozhets committed May 14, 2024
1 parent d41bf60 commit f7eb3dc
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 5 deletions.
6 changes: 3 additions & 3 deletions src/transformers/pipelines/base.py
Original file line number Diff line number Diff line change
Expand Up @@ -1048,9 +1048,9 @@ def check_model_type(self, supported_models: Union[List[str], dict]):
def _sanitize_parameters(self, **pipeline_parameters):
"""
_sanitize_parameters will be called with any excessive named arguments from either `__init__` or `__call__`
methods. It should return 3 dictionnaries of the resolved parameters used by the various `preprocess`,
`forward` and `postprocess` methods. Do not fill dictionnaries if the caller didn't specify a kwargs. This
let's you keep defaults in function signatures, which is more "natural".
methods. It should return 3 dictionaries of the resolved parameters used by the various `preprocess`,
`forward` and `postprocess` methods. Do not fill dictionaries if the caller didn't specify a kwargs. This
lets you keep defaults in function signatures, which is more "natural".
It is not meant to be called directly, it will be automatically called and the final parameters resolved by
`__init__` and `__call__`
Expand Down
2 changes: 1 addition & 1 deletion src/transformers/pipelines/conversational.py
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,7 @@ def __call__(self, conversations: Union[List[Dict], Conversation, List[Conversat
Conversation to generate responses for. Inputs can also be passed as a list of dictionaries with `role`
and `content` keys - in this case, they will be converted to `Conversation` objects automatically.
Multiple conversations in either format may be passed as a list.
clean_up_tokenization_spaces (`bool`, *optional*, defaults to `False`):
clean_up_tokenization_spaces (`bool`, *optional*, defaults to `True`):
Whether or not to clean up the potential extra spaces in the text output.
generate_kwargs:
Additional keyword arguments to pass along to the generate method of the model (see the generate method
Expand Down
2 changes: 1 addition & 1 deletion src/transformers/pipelines/text_generation.py
Original file line number Diff line number Diff line change
Expand Up @@ -204,7 +204,7 @@ def __call__(self, text_inputs, **kwargs):
return_full_text (`bool`, *optional*, defaults to `True`):
If set to `False` only added text is returned, otherwise the full text is returned. Only meaningful if
*return_text* is set to True.
clean_up_tokenization_spaces (`bool`, *optional*, defaults to `False`):
clean_up_tokenization_spaces (`bool`, *optional*, defaults to `True`):
Whether or not to clean up the potential extra spaces in the text output.
prefix (`str`, *optional*):
Prefix added to prompt.
Expand Down

0 comments on commit f7eb3dc

Please sign in to comment.