Skip to content

Commit 15d6be4

Browse files
authored
[DOCS] Adds hyperparameters option to the include setting of GET trained models API. (elastic#69959) (elastic#69979)
1 parent e48b3be commit 15d6be4

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

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

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

0 commit comments

Comments
 (0)