Unverified Commit 2a16d8b2 authored by Manuel's avatar Manuel Committed by GitHub
Browse files

improve unclear documentation (#23123)

parent a0bd4647
...@@ -534,7 +534,8 @@ class EarlyStoppingCallback(TrainerCallback): ...@@ -534,7 +534,8 @@ class EarlyStoppingCallback(TrainerCallback):
specified metric must improve to satisfy early stopping conditions. ` specified metric must improve to satisfy early stopping conditions. `
This callback depends on [`TrainingArguments`] argument *load_best_model_at_end* functionality to set best_metric This callback depends on [`TrainingArguments`] argument *load_best_model_at_end* functionality to set best_metric
in [`TrainerState`]. in [`TrainerState`]. Note that if the [`TrainingArguments`] argument *save_steps* differs from *eval_steps*, the
early stopping will not occur until the next save step.
""" """
def __init__(self, early_stopping_patience: int = 1, early_stopping_threshold: Optional[float] = 0.0): def __init__(self, early_stopping_patience: int = 1, early_stopping_threshold: Optional[float] = 0.0):
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment