Skip to content

Fix docstrings with Sphinx 'deprecated' directive #4279

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 15, 2025
Merged

Fix docstrings with Sphinx 'deprecated' directive #4279

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 18 additions & 9 deletions trl/extras/dataset_formatting.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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. "
Expand Down Expand Up @@ -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. "
Expand Down Expand Up @@ -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. "
Expand Down
Loading