[Train] Add PrintCallback
#21261
[Train] Add PrintCallback
#21261
Conversation
| class PrintCallback(TrainingCallback): | ||
| """A callback that prints training results to STDOUT. | ||
|
|
||
| Example: |
There was a problem hiding this comment.
Can we change the example to show usage with Trainer? Users shouldn't be calling handle_result directly, so I think this docstring could be confusing.
There was a problem hiding this comment.
Good point, we can also take the handle_result example and move it to the handle_result docstring?
python/ray/train/callbacks/print.py
Outdated
| >>> from ray import train | ||
| >>> from ray.train import Trainer | ||
| >>> from ray.train.callbacks import PrintCallback | ||
|
|
||
| >>> def train_func(): | ||
| ... for i in range(2): | ||
| ... train.report(worker_idx=train.world_rank(), epoch=i) |
There was a problem hiding this comment.
nit: Preference on >>> vs. ..code-block formatting? Personally prefer to just be able to copy/paste the example and run it.
There was a problem hiding this comment.
My reasoning was that the >>> formatting would be easier to show what's actually being printed out. If we do ..code-block then we would have to show the stdout as a comment. But good point on being able to copy paste. I don't really have a strong preference here, so am happy to change it to code block.
Why are these changes needed?
Related issue number
Closes #20806
Checks
scripts/format.shto lint the changes in this PR.