Get data frame analytics job stats
- GET /_ml/data_frame/analytics/{id}/_stats
- GET /_ml/data_frame/analytics/_stats
- Cluster privileges:
monitor_ml
Path Parameters
-
idstring Idoptional -
Identifier for the data frame analytics job. If you do not specify this option, the API returns information for the first hundred data frame analytics jobs.
Leave it out to use
/_ml/data_frame/analytics/_stats.
Query Parameters
-
allow_no_matchboolean · default: true Specifies what to do when the request:
- Contains wildcard expressions and there are no data frame analytics jobs that match.
- Contains the
_allstring or no identifiers and there are no matches. - Contains wildcard expressions and there are only partial matches.
The default value returns an empty data_frame_analytics array when there are no matches and the subset of results when there are partial matches. If this parameter is
false, the request returns a 404 status code when there are no matches or only partial matches.-
fromnumber · default: 0 Skips the specified number of data frame analytics jobs.
-
sizenumber · default: 100 Specifies the maximum number of data frame analytics jobs to obtain.
-
verboseboolean · default: false Defines whether the stats response should be verbose.
Response
-
countnumberrequired -
data_frame_analyticsDataframeAnalyticsrequired -
An array of objects that contain usage information for data frame analytics jobs, which are sorted by the id value in ascending order.
-
analysis_statsDataframeAnalyticsStatsContainer -
An object containing information about the analysis job.
-
classification_statsDataframeAnalyticsStatsHyperparameters -
An object containing information about the classification analysis job.
-
hyperparametersHyperparametersrequired -
An object containing the parameters of the classification analysis job.
-
alphanumber -
Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This parameter affects loss calculations by acting as a multiplier of the tree depth. Higher alpha values result in shallower trees and faster training times. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to zero.
-
lambdanumber -
Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies an L2 regularization term which applies to leaf weights of the individual trees in the forest. A high lambda value causes training to favor small leaf weights. This behavior makes the prediction function smoother at the expense of potentially not being able to capture relevant relationships between the features and the dependent variable. A small lambda value results in large individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value.
-
gammanumber -
Advanced configuration option. Regularization parameter to prevent overfitting on the training data set. Multiplies a linear penalty associated with the size of individual trees in the forest. A high gamma value causes training to prefer small trees. A small gamma value results in larger individual trees and slower training. By default, this value is calculated during hyperparameter optimization. It must be a nonnegative value.
-
etanumber -
Advanced configuration option. The shrinkage applied to the weights. Smaller values result in larger forests which have a better generalization error. However, larger forests cause slower training. By default, this value is calculated during hyperparameter optimization. It must be a value between
0.001and1. -
eta_growth_rate_per_treenumber -
Advanced configuration option. Specifies the rate at which
etaincreases for each new tree that is added to the forest. For example, a rate of 1.05 increasesetaby 5% for each extra tree. By default, this value is calculated during hyperparameter optimization. It must be between0.5and2. -
feature_bag_fractionnumber -
Advanced configuration option. Defines the fraction of features that will be used when selecting a random bag for each candidate split. By default, this value is calculated during hyperparameter optimization.
-
downsample_factornumber -
Advanced configuration option. Controls the fraction of data that is used to compute the derivatives of the loss function for tree training. A small value results in the use of a small fraction of the data. If this value is set to be less than 1, accuracy typically improves. However, too small a value may result in poor convergence for the ensemble and so require more trees. By default, this value is calculated during hyperparameter optimization. It must be greater than zero and less than or equal to 1.
-
max_attempts_to_add_treenumber -
If the algorithm fails to determine a non-trivial tree (more than a single leaf), this parameter determines how many of such consecutive failures are tolerated. Once the number of attempts exceeds the threshold, the forest training stops.
-
max_optimization_rounds_per_hyperparameternumber -
Advanced configuration option. A multiplier responsible for determining the maximum number of hyperparameter optimization steps in the Bayesian optimization procedure. The maximum number of steps is determined based on the number of undefined hyperparameters times the maximum optimization rounds per hyperparameter. By default, this value is calculated during hyperparameter optimization.
-
max_treesnumber -
Advanced configuration option. Defines the maximum number of decision trees in the forest. The maximum value is 2000. By default, this value is calculated during hyperparameter optimization.
-
num_foldsnumber -
The maximum number of folds for the cross-validation procedure.
-
num_splits_per_featurenumber -
Determines the maximum number of splits for every feature that can occur in a decision tree when the tree is trained.
-
soft_tree_depth_limitnumber -
Advanced configuration option. Machine learning uses loss guided tree growing, which means that the decision trees grow where the regularized loss decreases most quickly. This soft limit combines with the
soft_tree_depth_toleranceto penalize trees that exceed the specified depth; the regularized loss increases quickly beyond this depth. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0. -
soft_tree_depth_tolerancenumber -
Advanced configuration option. This option controls how quickly the regularized loss increases when the tree depth exceeds
soft_tree_depth_limit. By default, this value is calculated during hyperparameter optimization. It must be greater than or equal to 0.01. -
iterationnumberrequired -
The number of iterations on the analysis.
-
timestampEpochTimeUnitMillisrequired -
The timestamp when the statistics were reported in milliseconds since the epoch.
-
timing_statsTimingStatsrequired -
An object containing time statistics about the data frame analytics job.
-
elapsed_timeDurationValueUnitMillisrequired -
Runtime of the analysis in milliseconds.
-
iteration_timeDurationValueUnitMillis -
Runtime of the latest iteration of the analysis in milliseconds.
-
validation_lossValidationLossrequired -
An object containing information about validation loss.
-
fold_valuesstringrequired -
Validation loss values for every added decision tree during the forest growing procedure.
-
loss_typestringrequired -
The type of the loss metric. For example, binomial_logistic.
-
outlier_detection_statsDataframeAnalyticsStatsOutlierDetection -
An object containing information about the outlier detection job.
-
parametersOutlierDetectionParametersrequired -
The list of job parameters specified by the user or determined by algorithmic heuristics.
-
compute_feature_influenceboolean · default: true -
Specifies whether the feature influence calculation is enabled.
-
feature_influence_thresholdnumber · default: 0.1 -
The minimum outlier score that a document needs to have in order to calculate its feature influence score. Value range: 0-1
-
methodstring -
The method that outlier detection uses. Available methods are
lof,ldof,distance_kth_nn,distance_knn, andensemble. The default value is ensemble, which means that outlier detection uses an ensemble of different methods and normalises and combines their individual outlier scores to obtain the overall outlier score. -
n_neighborsnumber -
Defines the value for how many nearest neighbors each method of outlier detection uses to calculate its outlier score. When the value is not set, different values are used for different ensemble members. This default behavior helps improve the diversity in the ensemble; only override it if you are confident that the value you choose is appropriate for the data set.
-
outlier_fractionnumber -
The proportion of the data set that is assumed to be outlying prior to outlier detection. For example, 0.05 means it is assumed that 5% of values are real outliers and 95% are inliers.
-
standardization_enabledboolean · default: true -
If
true, the following operation is performed on the columns before computing outlier scores: (x_i - mean(x_i)) / sd(x_i). -
timestampEpochTimeUnitMillisrequired -
The timestamp when the statistics were reported in milliseconds since the epoch.
-
timing_statsTimingStatsrequired -
An object containing time statistics about the data frame analytics job.
-
elapsed_timeDurationValueUnitMillisrequired -
Runtime of the analysis in milliseconds.
-
iteration_timeDurationValueUnitMillis -
Runtime of the latest iteration of the analysis in milliseconds.
-
regression_statsDataframeAnalyticsStatsHyperparameters -
An object containing information about the regression analysis.
-
assignment_explanationstring -
For running jobs only, contains messages relating to the selection of a node to run the job.
-
data_countsDataframeAnalyticsStatsDataCountsrequired -
An object that provides counts for the quantity of documents skipped, used in training, or available for testing.
-
skipped_docs_countnumberrequired -
The number of documents that are skipped during the analysis because they contained values that are not supported by the analysis. For example, outlier detection does not support missing fields so it skips documents with missing fields. Likewise, all types of analysis skip documents that contain arrays with more than one element.
-
test_docs_countnumberrequired -
The number of documents that are not used for training the model and can be used for testing.
-
training_docs_countnumberrequired -
The number of documents that are used for training the model.
-
idstring Idrequired -
The unique identifier of the data frame analytics job.
-
memory_usageDataframeAnalyticsStatsMemoryUsagerequired -
An object describing memory usage of the analytics. It is present only after the job is started and memory usage is reported.
-
memory_reestimate_bytesnumber -
This value is present when the status is hard_limit and it is a new estimate of how much memory the job needs.
-
peak_usage_bytesnumberrequired -
The number of bytes used at the highest peak of memory usage.
-
statusstringrequired -
The memory usage status.
-
timestampEpochTimeUnitMillis -
The timestamp when memory usage was calculated.
-
nodeNodeAttributes -
Contains properties for the node that runs the job. This information is available only for running jobs.
-
attributesmap string to stringrequired -
Lists node attributes.
-
ephemeral_idstring Idrequired -
The ephemeral ID of the node.
-
idstring -
The unique identifier of the node.
-
namestringrequired -
The unique identifier of the node.
-
transport_addressstringrequired -
The host and port where transport HTTP connections are accepted.
-
progressDataframeAnalyticsStatsProgressrequired -
The progress report of the data frame analytics job by phase.
-
phasestringrequired -
Defines the phase of the data frame analytics job.
-
progress_percentnumberrequired -
The progress that the data frame analytics job has made expressed in percentage.
-
stateDataframeStaterequired -
The status of the data frame analytics job, which can be one of the following values: failed, started, starting, stopping, stopped.
-
Values:
startedstoppedstartingstoppingfailed