Skip to content

XML documentation for FastForest binary classification. - #3399

Merged
codemzs merged 7 commits into
dotnet:masterfrom
codemzs:fastforestbcdoc
Apr 19, 2019
Merged

XML documentation for FastForest binary classification.#3399
codemzs merged 7 commits into
dotnet:masterfrom
codemzs:fastforestbcdoc

Conversation

@codemzs

@codemzs codemzs commented Apr 18, 2019

Copy link
Copy Markdown
Member

towards #2522

Comment thread src/Microsoft.ML.FastTree/TreeTrainersCatalog.cs Outdated
Comment thread src/Microsoft.ML.FastTree/TreeTrainersCatalog.cs Outdated
Comment thread src/Microsoft.ML.FastTree/TreeTrainersCatalog.cs Outdated
Comment thread src/Microsoft.ML.FastTree/RandomForestClassification.cs

/// <summary>
/// Predict a target using a decision tree regression model trained with the <see cref="FastForestBinaryTrainer"/> and advanced options.
/// Create <see cref="FastForestBinaryTrainer"/> with <see cref="FastForestBinaryTrainer.Options"/>, which predicts a target using a decision tree regression model.

@shmoradims shmoradims Apr 19, 2019

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[](start = 62, length = 45)

just say "with advanced options" to be consistent with the template #Closed

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done.


In reply to: 277064586 [](ancestors = 277064586)

Comment thread src/Microsoft.ML.FastTree/TreeTrainersCatalog.cs Outdated
Comment thread docs/api-reference/fastforest.md
///
/// [!include[io](~/../docs/samples/docs/api-reference/io-columns-binary-classification.md)]
///
/// [!include[algorithm](~/../docs/samples/docs/api-reference/fastforest.md)]

@shmoradims shmoradims Apr 19, 2019

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fastforest [](start = 66, length = 10)

use 'algo-details-xxx' pattern. in this case 'algo-details-fastforest.md' #Resolved

@shmoradims shmoradims left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:shipit:

@codecov

codecov Bot commented Apr 19, 2019

Copy link
Copy Markdown

Codecov Report

Merging #3399 into master will increase coverage by 0.03%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master    #3399      +/-   ##
==========================================
+ Coverage   72.69%   72.73%   +0.03%     
==========================================
  Files         807      807              
  Lines      145172   145206      +34     
  Branches    16225    16230       +5     
==========================================
+ Hits       105533   105613      +80     
+ Misses      35223    35176      -47     
- Partials     4416     4417       +1
Flag Coverage Δ
#Debug 72.73% <ø> (+0.03%) ⬆️
#production 68.27% <ø> (+0.04%) ⬆️
#test 88.98% <ø> (ø) ⬆️
Impacted Files Coverage Δ
...icrosoft.ML.FastTree/RandomForestClassification.cs 78.07% <ø> (ø) ⬆️
src/Microsoft.ML.FastTree/TreeTrainersCatalog.cs 94.18% <ø> (ø) ⬆️
src/Microsoft.ML.Data/Transforms/KeyToValue.cs 79.16% <0%> (-0.65%) ⬇️
...ML.Transforms/MutualInformationFeatureSelection.cs 78.58% <0%> (-0.33%) ⬇️
...soft.ML.Tests/Transformers/CategoricalHashTests.cs 100% <0%> (ø) ⬆️
src/Microsoft.ML.Transforms/KernelCatalog.cs 33.33% <0%> (ø) ⬆️
...icrosoft.ML.Transforms/RandomFourierFeaturizing.cs 83.41% <0%> (ø) ⬆️
src/Microsoft.ML.Transforms/NormalizerCatalog.cs 84.78% <0%> (ø) ⬆️
src/Microsoft.ML.OnnxTransformer/OnnxTransform.cs 86.24% <0%> (ø) ⬆️
test/Microsoft.ML.Functional.Tests/ONNX.cs 100% <0%> (ø) ⬆️
... and 10 more

@codemzs
codemzs merged commit 09b72da into dotnet:master Apr 19, 2019
@codemzs codemzs added the documentation Related to documentation of ML.NET label Apr 22, 2019
@ghost ghost locked as resolved and limited conversation to collaborators Mar 22, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

documentation Related to documentation of ML.NET

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants