From 072c7f42e3f8b82a257edac5410e1633b19a4c64 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Thu, 4 Mar 2021 11:43:31 +0100 Subject: [PATCH] [DOCS] Adds hyperparameters option to the include setting of GET trained models API. --- .../ml/df-analytics/apis/get-trained-models.asciidoc | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/docs/reference/ml/df-analytics/apis/get-trained-models.asciidoc b/docs/reference/ml/df-analytics/apis/get-trained-models.asciidoc index 2b25c12c3e8c2..e103d0031ae81 100644 --- a/docs/reference/ml/df-analytics/apis/get-trained-models.asciidoc +++ b/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 default value is empty, indicating no optional fields are included. Valid options are: - - `definition`: Includes the model definition + - `definition`: Includes the model definition. - `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 data set. The baseline and total {feat-imp} values are returned in the `metadata` field