Clarify documentation for GetFeatureWeights in TreeEnsembleModelParameters #3339
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
TomFinley
reviewed
Apr 15, 2019
| /// <param name="weights">a <see cref="VBuffer{T}"/> where feature weights would be assigned to. | ||
| /// The i-th element in <paramref name="weights"/> stores the weight of the i-th feature.</param> | ||
| /// <param name="weights">A <see cref="VBuffer{T}"/> to hold the cumulative split gain value for each feature. | ||
| /// The i-th element in <paramref name="weights"/> stores the cumulative split gain of the i-th feature.</param> |
There was a problem hiding this comment.
Thank you @rogancarr! As discussed "weights" is a bit of an unfortunate word for "cumulative split gains," but it's probably too late to change the API at this point.
TomFinley
approved these changes
Apr 15, 2019
Codecov Report
@@ Coverage Diff @@
## master #3339 +/- ##
==========================================
- Coverage 72.66% 72.66% -0.01%
==========================================
Files 807 807
Lines 145191 145191
Branches 16223 16223
==========================================
- Hits 105503 105502 -1
Misses 35268 35268
- Partials 4420 4421 +1
|
rogancarr
added a commit
to rogancarr/machinelearning
that referenced
this pull request
Apr 15, 2019
…meters (dotnet#3339) (cherry picked from commit 0bb8163)
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.
This PR clarifies the documentation for
GetFeatureWeights()inTreeEnsembleModelParameters. SinceIHaveFeatureWeightshas becomeinternal, theTreeEnsembleModelParametersare now the only place where this method is visible, and it is unclear from the API what this returns. This PR adds documentation to specify that the "weights" returned are the cumulative split gains for all the trees in the ensemble.Fixes #1850