OpenSearch/docs/en/rest-api/ml
Dimitris Athanasiou 79d46d1d17 [ML] Set explicit defaults to AnalysisLimits (elastic/x-pack-elasticsearch#4015)
Analysis limits contain settings that affect the resources
used by ML jobs. Those limits always take place. However,
explictly setting them is not required as they have reasonable
defaults. For a long time those defaults lived on the c++ side.
The job could just not have any explicit limits and that meant
defaults would be used at the c++ side. This has the disadvantage
that it is not obvious to the users what these settings are set to.
Additionally, users might not be aware of the settings existence.

On top of that, since 6.1, the default model_memory_limit was lowered
from 4GB to 1GB. For BWC, this meant that jobs where model_memory_limit
is null, the default of 4GB applies. Jobs that were created from 6.1
onwards, contain an explicit setting for model_memory_limit, which is
1GB unless the user sets it differently. This adds additional confusion.

This commit makes analysis limits an always explicit setting on the job.
Regardless of whether the user sets custom limits or not, the job object
(and response) will contain the full analysis limits values.

The possibilities for interpretation of missing values are:

  - the entire analysis_limits is null: this may only happen for jobs
  created prior to 6.1. Thus we set the model_memory_limit to 4GB.
  - analysis_limits are non-null but model_memory_limit is: this also
  may only happen for jobs prior to 6.1. Again, we set memory limit to
  4GB.
  - model_memory_limit is non-null: this either means the user set an
  explicit value or the job was created from 6.1 onwards and it has
  the explicit default of 1GB. We simply keep the given value.

For categorization_examples_limit the default has always been 4, so
we fill that in when it's missing.

Finally, note that we still need to handle potential null values
for the situation of a mixed cluster.

Original commit: elastic/x-pack-elasticsearch@5b6994ef75
2018-02-27 17:49:05 +00:00
..
calendarresource.asciidoc [DOCS] Added ML add and delete calendar event APIs (elastic/x-pack-elasticsearch#3394) 2018-01-24 08:14:23 -08:00
close-job.asciidoc [DOCS] Enabled more ML code snippet testing (elastic/x-pack-elasticsearch#3764) 2018-02-09 09:16:24 -08:00
datafeedresource.asciidoc [DOCS] Identify informational ML properties (elastic/x-pack-elasticsearch#3773) 2018-02-19 11:48:09 -08:00
delete-calendar-event.asciidoc [DOCS] Added ML add and delete calendar event APIs (elastic/x-pack-elasticsearch#3394) 2018-01-24 08:14:23 -08:00
delete-calendar-job.asciidoc [ML] Enable adding multiple jobs to a calendar (elastic/x-pack-elasticsearch#3786) 2018-02-08 11:44:16 +00:00
delete-calendar.asciidoc [DOCS] Added ML add and delete calendar event APIs (elastic/x-pack-elasticsearch#3394) 2018-01-24 08:14:23 -08:00
delete-datafeed.asciidoc [DOCS] Enabled more ML code snippet testing (elastic/x-pack-elasticsearch#3764) 2018-02-09 09:16:24 -08:00
delete-job.asciidoc [DOCS] Enabled more ML code snippet testing (elastic/x-pack-elasticsearch#3764) 2018-02-09 09:16:24 -08:00
delete-snapshot.asciidoc [DOCS] Fixed short descriptions for ML APIs 2018-01-15 08:44:08 -08:00
eventresource.asciidoc [DOCS] Added ML add and delete calendar event APIs (elastic/x-pack-elasticsearch#3394) 2018-01-24 08:14:23 -08:00
flush-job.asciidoc [DOCS] Add skip_time to Flush Jobs API (elastic/x-pack-elasticsearch#1955) 2018-02-19 11:04:12 -08:00
forecast.asciidoc [DOCS] Fixed short descriptions for ML APIs 2018-01-15 08:44:08 -08:00
get-bucket.asciidoc [DOCS] Fixed short descriptions for ML APIs 2018-01-15 08:44:08 -08:00
get-calendar-event.asciidoc [DOCS] Added ML add and delete calendar event APIs (elastic/x-pack-elasticsearch#3394) 2018-01-24 08:14:23 -08:00
get-calendar.asciidoc [DOCS] Added ML add and delete calendar event APIs (elastic/x-pack-elasticsearch#3394) 2018-01-24 08:14:23 -08:00
get-category.asciidoc [DOCS] Fixed short descriptions for ML APIs 2018-01-15 08:44:08 -08:00
get-datafeed-stats.asciidoc [ML][DOCS] Fix substitution in ML docs code snipppet (elastic/x-pack-elasticsearch#4006) 2018-02-22 09:32:52 +00:00
get-datafeed.asciidoc [DOCS] Enabled code snippet testing for more ML APIs (elastic/x-pack-elasticsearch#3990) 2018-02-20 11:08:37 -08:00
get-influencer.asciidoc [DOCS] Fixed short descriptions for ML APIs 2018-01-15 08:44:08 -08:00
get-job-stats.asciidoc [DOCS] Fixed short descriptions for ML APIs 2018-01-15 08:44:08 -08:00
get-job.asciidoc [ML] Set explicit defaults to AnalysisLimits (elastic/x-pack-elasticsearch#4015) 2018-02-27 17:49:05 +00:00
get-overall-buckets.asciidoc [DOCS] Fixed short descriptions for ML APIs 2018-01-15 08:44:08 -08:00
get-record.asciidoc [DOCS] Fixed short descriptions for ML APIs 2018-01-15 08:44:08 -08:00
get-snapshot.asciidoc [DOCS] Fixed short descriptions for ML APIs 2018-01-15 08:44:08 -08:00
jobcounts.asciidoc Add opening state to Job states (elastic/x-pack-elasticsearch#2317) 2017-11-24 11:35:51 +00:00
jobresource.asciidoc [DOCS] Clarified model snapshot retention (elastic/x-pack-elasticsearch#4000) 2018-02-21 08:58:17 -08:00
open-job.asciidoc [DOCS] Fixed short descriptions for ML APIs 2018-01-15 08:44:08 -08:00
post-calendar-event.asciidoc [DOCS] Added ML add and delete calendar event APIs (elastic/x-pack-elasticsearch#3394) 2018-01-24 08:14:23 -08:00
post-data.asciidoc [DOCS] Fixed short descriptions for ML APIs 2018-01-15 08:44:08 -08:00
preview-datafeed.asciidoc [DOCS] Fixed short descriptions for ML APIs 2018-01-15 08:44:08 -08:00
put-calendar-job.asciidoc [ML] Enable adding multiple jobs to a calendar (elastic/x-pack-elasticsearch#3786) 2018-02-08 11:44:16 +00:00
put-calendar.asciidoc [DOCS] Added ML add and delete calendar event APIs (elastic/x-pack-elasticsearch#3394) 2018-01-24 08:14:23 -08:00
put-datafeed.asciidoc [DOCS] Enabled more ML code snippet testing (elastic/x-pack-elasticsearch#3764) 2018-02-09 09:16:24 -08:00
put-job.asciidoc [ML] Set explicit defaults to AnalysisLimits (elastic/x-pack-elasticsearch#4015) 2018-02-27 17:49:05 +00:00
resultsresource.asciidoc [DOCS] Identify informational ML properties (elastic/x-pack-elasticsearch#3773) 2018-02-19 11:48:09 -08:00
revert-snapshot.asciidoc Remove AcknowledgedRestListener in favour of RestToXContentListener (elastic/x-pack-elasticsearch#3985) 2018-02-22 09:13:58 +01:00
snapshotresource.asciidoc [DOCS] Clarified model snapshot retention (elastic/x-pack-elasticsearch#4000) 2018-02-21 08:58:17 -08:00
start-datafeed.asciidoc [DOCS] Fixed short descriptions for ML APIs 2018-01-15 08:44:08 -08:00
stop-datafeed.asciidoc [DOCS] Fixed short descriptions for ML APIs 2018-01-15 08:44:08 -08:00
update-datafeed.asciidoc [DOCS] Enabled code snippet testing for more ML APIs (elastic/x-pack-elasticsearch#3990) 2018-02-20 11:08:37 -08:00
update-job.asciidoc [ML] Set explicit defaults to AnalysisLimits (elastic/x-pack-elasticsearch#4015) 2018-02-27 17:49:05 +00:00
update-snapshot.asciidoc [DOCS] Fixed short descriptions for ML APIs 2018-01-15 08:44:08 -08:00
validate-detector.asciidoc [DOCS] Fixed short descriptions for ML APIs 2018-01-15 08:44:08 -08:00
validate-job.asciidoc [DOCS] Fixed short descriptions for ML APIs 2018-01-15 08:44:08 -08:00