Browse Source

[DOCS] Adds hyperparameters option to the include setting of GET trained models API. (#69959)

István Zoltán Szabó 4 years ago
parent
commit
2ccc81081f
1 changed files with 5 additions and 1 deletions
  1. 5 1
      docs/reference/ml/df-analytics/apis/get-trained-models.asciidoc

+ 5 - 1
docs/reference/ml/df-analytics/apis/get-trained-models.asciidoc

@@ -78,8 +78,12 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=from-models]
 A comma delimited string of optional fields to include in the response body. The
 A comma delimited string of optional fields to include in the response body. The
 default value is empty, indicating no optional fields are included. Valid
 default value is empty, indicating no optional fields are included. Valid
 options are:
 options are:
- - `definition`: Includes the model definition
+ - `definition`: Includes the model definition.
  - `feature_importance_baseline`: Includes the baseline for {feat-imp} values.
  - `feature_importance_baseline`: Includes the baseline for {feat-imp} values.
+ - `hyperparameters`: Includes the information about hyperparameters used to 
+    train the model. This information consists of the value, the absolute and 
+    relative importance of the hyperparameter as well as an indicator of whether 
+    it was specified by the user or tuned during hyperparameter optimization.
  - `total_feature_importance`: Includes the total {feat-imp} for the training
  - `total_feature_importance`: Includes the total {feat-imp} for the training
    data set.
    data set.
 The baseline and total {feat-imp} values are returned in the `metadata` field
 The baseline and total {feat-imp} values are returned in the `metadata` field