Skip to content

Commit 2a66cb6

Browse files
authored
[DOCS] Adds hyperparameter metadata property to GET trained models API docs. (#67412) (#67426)
1 parent 85794b7 commit 2a66cb6

File tree

1 file changed

+37
-0
lines changed

1 file changed

+37
-0
lines changed

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

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,43 @@ created by {dfanalytics} contain `analysis_config` and `input` objects.
148148
An object that contains the baseline for {feat-imp} values. For {reganalysis},
149149
it is a single value. For {classanalysis}, there is a value for each class.
150150

151+
`hyperparameters`:::
152+
(array)
153+
List of the available hyperparameters optimized during the
154+
`fine_parameter_tuning` phase as well as specified by the user.
155+
+
156+
.Properties of hyperparameters
157+
[%collapsible%open]
158+
======
159+
`absolute_importance`::::
160+
(Optional, double)
161+
A positive number showing how much the parameter influences the variation of the
162+
{ml-docs}/dfa-regression.html#dfa-regression-lossfunction[loss function]. For
163+
hyperparameters with values that are not specified by the user but tuned during
164+
hyperparameter optimization.
165+
166+
`name`::::
167+
(string)
168+
Name of the hyperparameter.
169+
170+
`relative_importance`::::
171+
(Optional, double)
172+
A number between 0 and 1 showing the proportion of influence on the variation of
173+
the loss function among all tuned hyperparameters. For hyperparameters with
174+
values that are not specified by the user but tuned during hyperparameter
175+
optimization.
176+
177+
`supplied`::::
178+
(Boolean)
179+
Indicates if the hyperparameter is specified by the user (`true`) or optimized
180+
(`false`).
181+
182+
`value`::::
183+
(double)
184+
The value of the hyperparameter, either optimized or specified by the user.
185+
186+
======
187+
151188
`total_feature_importance`:::
152189
(array)
153190
An array of the total {feat-imp} for each feature used from

0 commit comments

Comments
 (0)