[ADD] Documentation update in base_trainer.py
#468
Merged
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.
Types of changes
Checklist:
Description
I have updated the documentation of
base_trainer
for #406 in places where it seemed reasonable to add documentation.Motivation and Context
Changes fix #406. This pull request includes the changes after the comments on PR 447 which reported additional changes due to rebase.
How has this been tested?
Since the changes are only in the documentation, I have not executed any tests for this issue.