Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify documentation for GetFeatureWeights in TreeEnsembleModelParameters #3339

Merged
merged 1 commit into from Apr 15, 2019

Conversation

Projects
None yet
3 participants
@rogancarr
Copy link
Contributor

rogancarr commented Apr 15, 2019

This PR clarifies the documentation for GetFeatureWeights() in TreeEnsembleModelParameters. Since IHaveFeatureWeights has become internal, the TreeEnsembleModelParameters are 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

@rogancarr rogancarr requested review from wschin, TomFinley and Ivanidzo4ka 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>

This comment has been minimized.

Copy link
@TomFinley

TomFinley Apr 15, 2019

Contributor

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
Copy link
Contributor

TomFinley left a comment

Thank you @rogancarr !

@codecov

This comment has been minimized.

Copy link

codecov bot commented Apr 15, 2019

Codecov Report

Merging #3339 into master will decrease coverage by <.01%.
The diff coverage is n/a.

@@            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
Flag Coverage Δ
#Debug 72.66% <ø> (-0.01%) ⬇️
#production 68.19% <ø> (-0.01%) ⬇️
#test 88.97% <ø> (ø) ⬆️
Impacted Files Coverage Δ
src/Microsoft.ML.FastTree/FastTree.cs 80.71% <ø> (ø) ⬆️
...ML.Transforms/Text/StopWordsRemovingTransformer.cs 86.1% <0%> (-0.16%) ⬇️
@Ivanidzo4ka
Copy link
Member

Ivanidzo4ka left a comment

:shipit:

@rogancarr rogancarr merged commit 0bb8163 into dotnet:master Apr 15, 2019

3 checks passed

MachineLearning-CI #20190415.10 succeeded
Details
MachineLearning-CodeCoverage #20190415.9 succeeded
Details
license/cla All CLA requirements met.

@rogancarr rogancarr deleted the rogancarr:1850_tree_featuregain_docs branch Apr 15, 2019

rogancarr added a commit to rogancarr/machinelearning that referenced this pull request Apr 15, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.