frozenleaves/trl
1
0
Fork 0
mirror of https://github.com/huggingface/trl.git synced 2025-10-20 18:43:52 +08:00
Code Issues Packages Projects Releases Wiki Activity

Fix docstrings with Sphinx 'deprecated' directive (#4279)

Browse Source
This commit is contained in:
Albert Villanova del Moral
2025-10-15 10:39:12 +02:00
committed by GitHub
parent 56cb6ccf76
commit 927cf6ba46
1 changed files with 18 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
trl/extras/dataset_formatting.py
View File

@ -43,9 +43,12 @@ def conversations_formatting_function(
return a callable function that takes in a "messages" dataset and returns a formatted dataset, based on the
tokenizer apply chat template to the dataset along with the schema of the list of functions in the tools list.
.. deprecated:: 0.24.0
`conversations_formatting_function` is deprecated and will be removed in version 0.27. Please use
`tokenizer.apply_chat_template()` directly instead.
<Deprecated version="0.24.0">
`conversations_formatting_function` is deprecated and will be removed in version 0.27. Please use
`tokenizer.apply_chat_template()` directly instead.
</Deprecated>
"""
warnings.warn(
"`conversations_formatting_function` is deprecated and will be removed in TRL 0.27. "
@ -73,9 +76,12 @@ def instructions_formatting_function(tokenizer: AutoTokenizer):
return a callable function that takes in an "instructions" dataset and returns a formatted dataset, based on the
tokenizer apply chat template to the dataset
.. deprecated:: 0.24.0
`instructions_formatting_function` is deprecated and will be removed in version 0.27. Please use
`tokenizer.apply_chat_template()` directly instead.
<Deprecated version="0.24.0">
`instructions_formatting_function` is deprecated and will be removed in version 0.27. Please use
`tokenizer.apply_chat_template()` directly instead.
</Deprecated>
"""
warnings.warn(
"`instructions_formatting_function` is deprecated and will be removed in TRL 0.27. "
@ -121,9 +127,12 @@ def get_formatting_func_from_dataset(
Returns:
Callable: Formatting function if the dataset format is supported else None
.. deprecated:: 0.24.0
`get_formatting_func_from_dataset` is deprecated and will be removed in version 0.27. Please use
`tokenizer.apply_chat_template()` directly instead.
<Deprecated version="0.24.0">
`get_formatting_func_from_dataset` is deprecated and will be removed in version 0.27. Please use
`tokenizer.apply_chat_template()` directly instead.
</Deprecated>
"""
warnings.warn(
"`get_formatting_func_from_dataset` is deprecated and will be removed in TRL 0.27. "