honeymoose
/
OpenSearch
mirror of https://github.com/honeymoose/OpenSearch.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Add tips for num_top_classes classification parameter (#63781)

This commit is contained in:
Lisa Cawley 2020-10-21 09:27:13 -07:00 committed by lcawl
parent f0e6684a95
commit 25be69ceaf
1 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/reference/ml/df-analytics/apis/put-dfanalytics.asciidoc
View File

@ -134,9 +134,17 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=max-trees]
`num_top_classes`::::
(Optional, integer)
Defines the number of categories for which the predicted probabilities are
reported. It must be non-negative or -1 (which denotes all categories). If it is
greater than the total number of categories, the API reports all category
probabilities. Defaults to 2.
reported. It must be non-negative or -1. If it is -1 or greater than the total
number of categories, probabilities are reported for all categories; if you have
a large number of categories, there could be a significant effect on the size of your destination index. Defaults to 2.
+
--
NOTE: To use the
{ml-docs}/ml-dfanalytics-evaluate.html#ml-dfanalytics-class-aucroc[AUC ROC evaluation method],
`num_top_classes` must be set to `-1` or a value greater than or equal to the
total number of categories.
--
`num_top_feature_importance_values`::::
(Optional, integer)