Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 4, 2021
Merged

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

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion docs/reference/ml/df-analytics/apis/get-trained-models.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down