Skip to content

Commit df80f67

Browse files
albertvillanovakashif
authored andcommitted
Add docstring for OnlineTrainerState (#4166)
1 parent 8ba73ee commit df80f67

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

trl/trainer/utils.py

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -696,6 +696,15 @@ def print_rich_table(df: pd.DataFrame) -> None:
696696

697697
@dataclass
698698
class OnlineTrainerState(TrainerState):
699+
"""
700+
Training state for online/on-policy trainers.
701+
702+
Extends [`~transformers.TrainerState`] with an `episode` counter to track the current rollout/episode.
703+
704+
Args:
705+
episode (`int`, defaults to 0): Zero-based episode index.
706+
"""
707+
699708
episode: int = 0
700709

701710

0 commit comments

Comments
 (0)