Skip to content

Commit 927cf6b

Browse files
Fix docstrings with Sphinx 'deprecated' directive (#4279)
1 parent 56cb6cc commit 927cf6b

File tree

1 file changed

+18
-9
lines changed

1 file changed

+18
-9
lines changed

trl/extras/dataset_formatting.py

Lines changed: 18 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -43,9 +43,12 @@ def conversations_formatting_function(
4343
return a callable function that takes in a "messages" dataset and returns a formatted dataset, based on the
4444
tokenizer apply chat template to the dataset along with the schema of the list of functions in the tools list.
4545
46-
.. deprecated:: 0.24.0
47-
`conversations_formatting_function` is deprecated and will be removed in version 0.27. Please use
48-
`tokenizer.apply_chat_template()` directly instead.
46+
<Deprecated version="0.24.0">
47+
48+
`conversations_formatting_function` is deprecated and will be removed in version 0.27. Please use
49+
`tokenizer.apply_chat_template()` directly instead.
50+
51+
</Deprecated>
4952
"""
5053
warnings.warn(
5154
"`conversations_formatting_function` is deprecated and will be removed in TRL 0.27. "
@@ -73,9 +76,12 @@ def instructions_formatting_function(tokenizer: AutoTokenizer):
7376
return a callable function that takes in an "instructions" dataset and returns a formatted dataset, based on the
7477
tokenizer apply chat template to the dataset
7578
76-
.. deprecated:: 0.24.0
77-
`instructions_formatting_function` is deprecated and will be removed in version 0.27. Please use
78-
`tokenizer.apply_chat_template()` directly instead.
79+
<Deprecated version="0.24.0">
80+
81+
`instructions_formatting_function` is deprecated and will be removed in version 0.27. Please use
82+
`tokenizer.apply_chat_template()` directly instead.
83+
84+
</Deprecated>
7985
"""
8086
warnings.warn(
8187
"`instructions_formatting_function` is deprecated and will be removed in TRL 0.27. "
@@ -121,9 +127,12 @@ def get_formatting_func_from_dataset(
121127
Returns:
122128
Callable: Formatting function if the dataset format is supported else None
123129
124-
.. deprecated:: 0.24.0
125-
`get_formatting_func_from_dataset` is deprecated and will be removed in version 0.27. Please use
126-
`tokenizer.apply_chat_template()` directly instead.
130+
<Deprecated version="0.24.0">
131+
132+
`get_formatting_func_from_dataset` is deprecated and will be removed in version 0.27. Please use
133+
`tokenizer.apply_chat_template()` directly instead.
134+
135+
</Deprecated>
127136
"""
128137
warnings.warn(
129138
"`get_formatting_func_from_dataset` is deprecated and will be removed in TRL 0.27. "

0 commit comments

Comments
 (0)