Add XML doc to the ITrainerEstimator interface #2847
Merged
Conversation
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
Codecov Report
@@ Coverage Diff @@
## master #2847 +/- ##
=========================================
+ Coverage 71.71% 71.81% +0.1%
=========================================
Files 809 812 +3
Lines 142522 142644 +122
Branches 16114 16090 -24
=========================================
+ Hits 102203 102441 +238
+ Misses 35884 35822 -62
+ Partials 4435 4381 -54
|
artidoro
reviewed
Mar 7, 2019
| /// <summary> | ||
| /// Interface for the Trainer Estimator. | ||
| /// </summary> | ||
| /// <typeparam name="TTransformer"></typeparam> |
There was a problem hiding this comment.
Suggested change
| /// <typeparam name="TTransformer"></typeparam> | |
| /// <typeparam name="TTransformer">The type of the transformer returned by the estimator.</typeparam> |
| /// Interface for the Trainer Estimator. | ||
| /// </summary> | ||
| /// <typeparam name="TTransformer"></typeparam> | ||
| /// <typeparam name="TPredictor"></typeparam> |
There was a problem hiding this comment.
Suggested change
| /// <typeparam name="TPredictor"></typeparam> | |
| /// <typeparam name="TPredictor">The type of the model parameters.</typeparam> |
artidoro
reviewed
Mar 7, 2019
| /// Interface for the Trainer Estimator. | ||
| /// </summary> | ||
| /// <typeparam name="TTransformer"></typeparam> | ||
| /// <typeparam name="TPredictor"></typeparam> | ||
| public interface ITrainerEstimator<out TTransformer, out TPredictor> : IEstimator<TTransformer> |
There was a problem hiding this comment.
Interesting! It's still named TPredictor, we have switched to TModel in out public facing API. If you could rename it here it would be great!
ghost
locked as resolved and limited conversation to collaborators
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Just a quick draft for the XML docs to help fix #2629