Reformatting, documentation, and slight API tweaks #1827
Merged
Conversation
This file contains 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
b6eecf5
to
77428cc
Compare
mrwyattii
reviewed
Mar 12, 2021
also includes some updated documentation for training algorithms, as
well as a slight API modification ("get_name" is now "get_type", and
names are user-specified).
This reverts commit 8afcc99.
a01c062
to
9fb45b2
Compare
NOTE: training_algorithm::get_type() is not entirely correct here. It could cause problems if multiple instances of the same callback are checkpointed at the same time, but currently we don't do this. The issue with "get_name()" is that we might not know the name of the training algorithm on restore (since the training algos themselves are not checkpointed).
bvanessen
approved these changes
Apr 7, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
The API tweaks are:
execution_contextandtermination_criteriapolymorphically destructible.training_algorithmto haveget_type(), which returns a string description of the algorithm's type ("sgd", etc.), andget_name(), which allows users to assign an identifier to the algorithm.training_algorithm::setup_models(...).training_algorithms are nowCloneable.The rest is documentation and formatting.