docs: improve docstrings for Trainer, Checkpoint, concrete trainer#89
Open
mac-agent wants to merge 1 commit intopyfenn:mainfrom
Open
docs: improve docstrings for Trainer, Checkpoint, concrete trainer#89mac-agent wants to merge 1 commit intopyfenn:mainfrom
mac-agent wants to merge 1 commit intopyfenn:mainfrom
Conversation
…r classes \n\nExpand existing docstrings on the abstract Trainer class and the Checkpoint \nclass from minimal one-liners into full Google-style documentation. Improve \ntrainer.py, checkpoint.py, classification_trainer.py, regression_trainer.py \nwith detailed descriptions, Args sections, and usage examples.\n\nCloses pyfenn#88
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Expands documentation for the trainer and checkpoint modules from minimal one-liners to full Google-style docstrings, addressing #88.
Changes
trainer.py:
fit()explaining the validation/early stopping matrixpredict()docstring_move_to_device()and_replace_state()_should_save_checkpoint(),load_checkpoint(),load_checkpoint_at_epoch(),load_best_checkpoint()with Args and Raises sectionscheckpoint.py:
classification_trainer.py:
regression_trainer.py:
Testing
No behavioral changes — these are documentation improvements only. 4 files changed, 161 insertions(-), 34 deletions(-).