Skip to content

Commit a0df357

Browse files
Fix docstrings with 'deprecated' Sphinx directive (#4174)
1 parent 864e593 commit a0df357

File tree

2 files changed

+12
-8
lines changed

2 files changed

+12
-8
lines changed

trl/trainer/nash_md_trainer.py

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -96,10 +96,13 @@ class NashMDTrainer(OnlineDPOTrainer):
9696
preprocess_logits_for_metrics (`Callable[[torch.Tensor, torch.Tensor], torch.Tensor]`):
9797
The function to use to preprocess the logits before computing the metrics.
9898
99-
.. deprecated:: 0.22.0
100-
The following parameters are deprecated and will be removed in a future version:
99+
reward_model:
101100
102-
* `reward_model`: Use `reward_funcs` instead. For example, change `reward_model=model` to `reward_funcs=model`.
101+
<Deprecated version="0.22.0">
102+
103+
This parameter is deprecated and will be removed in version 0.25.0. Use `reward_funcs` instead.
104+
105+
</Deprecated>
103106
"""
104107

105108
_tag_names = ["trl", "nash-md"]

trl/trainer/xpo_trainer.py

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -96,12 +96,13 @@ class XPOTrainer(OnlineDPOTrainer):
9696
preprocess_logits_for_metrics (`Callable[[torch.Tensor, torch.Tensor], torch.Tensor]`):
9797
The function to use to preprocess the logits before computing the metrics.
9898
99-
.. deprecated:: 0.22.0
100-
The following parameters are deprecated and will be removed in a future version:
99+
reward_model:
101100
102-
* `reward_model`: Use `reward_funcs` instead. For example, change `reward_model=model` to `reward_funcs=model`.
103-
* `reward_processing_class`: Use `reward_processing_classes` instead. For example, change
104-
`reward_processing_class=tokenizer` to `reward_processing_classes=tokenizer`.
101+
<Deprecated version="0.22.0">
102+
103+
This parameter is deprecated and will be removed in version 0.25.0. Use `reward_funcs` instead.
104+
105+
</Deprecated>
105106
"""
106107

107108
_tag_names = ["trl", "xpo"]

0 commit comments

Comments
 (0)