OpenSearch/docs/java-rest/high-level/ml
Benjamin Trent c8374dc9f3
[ML] add max_model_memory parameter to forecast request (#57254) (#57355)
This adds a max_model_memory setting to forecast requests. 
This setting can take a string value that is formatted according to byte sizes (i.e. "50mb", "150mb").

The default value is `20mb`.

There is a HARD limit at `500mb` which will throw an error if used.

If the limit is larger than 40% the anomaly job's configured model limit, the forecast limit is reduced to be strictly lower than that value. This reduction is logged and audited.

related native change: https://github.com/elastic/ml-cpp/pull/1238

closes: https://github.com/elastic/elasticsearch/issues/56420
2020-05-29 11:16:08 -04:00
..
close-job.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:28:02 -07:00
delete-calendar-event.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:28:02 -07:00
delete-calendar-job.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:28:02 -07:00
delete-calendar.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:28:02 -07:00
delete-data-frame-analytics.asciidoc [7.x][ML] Implement force deleting a data frame analytics job (#50553) (#50589) 2020-01-03 13:46:02 +02:00
delete-datafeed.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:28:02 -07:00
delete-expired-data.asciidoc [ML] relax throttling on expired data cleanup (#56711) (#56895) 2020-05-18 08:46:42 -04:00
delete-filter.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:28:02 -07:00
delete-forecast.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:28:02 -07:00
delete-job.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:28:02 -07:00
delete-model-snapshot.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:28:02 -07:00
delete-trained-model.asciidoc [7.x] [ML][Inference][HLRC] Delete trained model API (#49567) (#49585) 2019-11-26 08:27:08 -05:00
estimate-model-memory.asciidoc [ML] Add a model memory estimation endpoint for anomaly detection (#54129) 2020-03-24 22:55:11 +00:00
evaluate-data-frame.asciidoc [7.x] Implement `precision` and `recall` metrics for classification evaluation (#49671) (#50378) 2019-12-19 18:55:05 +01:00
explain-data-frame-analytics.asciidoc [7.x][ML] Explain data frame analytics API (#49455) (#49504) 2019-11-22 22:06:10 +02:00
find-file-structure.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:28:02 -07:00
flush-job.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:28:02 -07:00
forecast-job.asciidoc [ML] add max_model_memory parameter to forecast request (#57254) (#57355) 2020-05-29 11:16:08 -04:00
get-buckets.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:28:02 -07:00
get-calendar-events.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:28:02 -07:00
get-calendars.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:28:02 -07:00
get-categories.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:28:02 -07:00
get-data-frame-analytics-stats.asciidoc [DOCS] Fixes data frame analytics job terminology in HLRC (#46758) 2019-09-16 10:07:59 -07:00
get-data-frame-analytics.asciidoc [DOCS] Fixes data frame analytics job terminology in HLRC (#46758) 2019-09-16 10:07:59 -07:00
get-datafeed-stats.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:28:02 -07:00
get-datafeed.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:28:02 -07:00
get-filters.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:28:02 -07:00
get-influencers.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:28:02 -07:00
get-info.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:28:02 -07:00
get-job-stats.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:28:02 -07:00
get-job.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:28:02 -07:00
get-model-snapshots.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:28:02 -07:00
get-overall-buckets.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:28:02 -07:00
get-records.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:28:02 -07:00
get-trained-models-stats.asciidoc [7.x] [ML][Inference][HLRC] add GET _stats (#49562) (#49600) 2019-11-26 11:28:26 -05:00
get-trained-models.asciidoc [7.x] [ML][Inference] add tags url param to GET (#51330) (#51404) 2020-01-24 08:26:58 -05:00
open-job.asciidoc [ML] Return assigned node in start/open job/datafeed response (#55570) 2020-04-22 12:06:53 +01:00
post-calendar-event.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:28:02 -07:00
post-data.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:28:02 -07:00
preview-datafeed.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:28:02 -07:00
put-calendar-job.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:28:02 -07:00
put-calendar.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:28:02 -07:00
put-data-frame-analytics.asciidoc [7.x][ML] Add loss_function to regression (#56118) (#56187) 2020-05-05 14:59:51 +03:00
put-datafeed.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:28:02 -07:00
put-filter.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:28:02 -07:00
put-job.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:28:02 -07:00
put-trained-model.asciidoc [7.x] [ML] add new inference_config field to trained model config (#54421) (#54647) 2020-04-02 12:25:10 -04:00
revert-model-snapshot.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:28:02 -07:00
set-upgrade-mode.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:28:02 -07:00
start-data-frame-analytics.asciidoc [ML] Return assigned node in start/open job/datafeed response (#55570) 2020-04-22 12:06:53 +01:00
start-datafeed.asciidoc [ML] Return assigned node in start/open job/datafeed response (#55570) 2020-04-22 12:06:53 +01:00
stop-data-frame-analytics.asciidoc [DOCS] Fixes data frame analytics job terminology in HLRC (#46758) 2019-09-16 10:07:59 -07:00
stop-datafeed.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:28:02 -07:00
update-datafeed.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:28:02 -07:00
update-filter.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:28:02 -07:00
update-job.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:28:02 -07:00
update-model-snapshot.asciidoc [DOCS] Adds missing icons to ML HLRC APIs (#46515) 2019-09-10 08:28:02 -07:00