Commit Graph

36 Commits

Author SHA1 Message Date
Lisa Cawley b6c9e96304 [DOCS] Added job ID requirements (elastic/x-pack-elasticsearch#3727)
Original commit: elastic/x-pack-elasticsearch@71f0073708
2018-01-25 09:23:56 -08:00
Lisa Cawley 9f6064f9ac [DOCS] Edited documentation for ML categorization_analyzer (elastic/x-pack-elasticsearch#3587)
Original commit: elastic/x-pack-elasticsearch@6dd179107a
2018-01-17 13:11:36 -08:00
lcawley 86f612ae3a [DOCS] Fixed link to Analyze API
Original commit: elastic/x-pack-elasticsearch@e203d839c2
2018-01-15 08:29:08 -08:00
David Roberts e9dafbd78d [DOCS] Add documentation for ML categorization_analyzer (elastic/x-pack-elasticsearch#3554)
This is the documentation for the changes made in elastic/x-pack-elasticsearch#3372.

Relates elastic/machine-learning-cpp#491

Original commit: elastic/x-pack-elasticsearch@7d67e9d894
2018-01-15 15:47:19 +00:00
Dimitrios Athanasiou f977632a17 [DOCS] Change `detector_rules` to `rules` in ML docs
Original commit: elastic/x-pack-elasticsearch@49699286d3
2017-12-20 14:38:00 +00:00
Lisa Cawley c67ec73cb5 [DOCS] Add xpack.ml.max_model_memory_limit (elastic/x-pack-elasticsearch#2787)
* [DOCS] Add xpack.ml.max.model_memory_limit

* [DOCS] Addressed feedback on model limit setting

Original commit: elastic/x-pack-elasticsearch@77a10bfe0e
2017-10-25 09:15:19 -07:00
David Roberts ea94ef3aa9 [ML] Update docs for change to default model memory limit (elastic/x-pack-elasticsearch#2308)
This is the doc change for elastic/x-pack-elasticsearch#2300

Original commit: elastic/x-pack-elasticsearch@acd683d06a
2017-08-21 16:51:30 +01:00
Lisa Cawley 17b4720df7 [DOCS] Add missing ML create job API options (elastic/x-pack-elasticsearch#2268)
* [DOCS] Add missing ML create job API options

* [DOCS] Small fixes in ML create job API

Original commit: elastic/x-pack-elasticsearch@369bd5bfbb
2017-08-18 13:00:15 -07:00
Lisa Cawley e97b6dcc47 [DOCS] Add job groups to ML create/update job APIs (elastic/x-pack-elasticsearch#2290)
* [DOCS] Add job groups to ML create/update job APIs

* [DOCS] Fix ML update job API example

* [DOCS] Address feedback for ML create/update job APIs

Original commit: elastic/x-pack-elasticsearch@0e7bb47342
2017-08-17 12:52:29 -07:00
Lisa Cawley bf92450fc4 [DOCS] Update multivariate_by_fields (elastic/x-pack-elasticsearch#2147)
Original commit: elastic/x-pack-elasticsearch@a26025ac5e
2017-08-02 08:25:46 -07:00
Lisa Cawley 6614c86413 [DOCS] Fix ML latency definition (elastic/x-pack-elasticsearch#2091)
Original commit: elastic/x-pack-elasticsearch@78c9cb387c
2017-07-27 08:25:14 -07:00
Lisa Cawley 449064337d [DOCS] Clarify null behaviour in ML resources (elastic/x-pack-elasticsearch#2090)
* [DOCS] Clarify null behaviour in ML resources

* [DOCS] Add category error information

Original commit: elastic/x-pack-elasticsearch@21cdb4fb36
2017-07-27 08:02:46 -07:00
Lisa Cawley 31b02c3941 [DOCS] Update model_memory_limit (elastic/x-pack-elasticsearch#1928)
* [DOCS] Update model_memory_limit

* [DOCS] Clarify minimum model_memory_limit value

* [DOCS] More updates to model_memory_limit

* [DOCS] Address feedback in jobresource.asciidoc

Original commit: elastic/x-pack-elasticsearch@3c62719037
2017-07-10 08:50:38 -07:00
Sophie Chang a9f86f6d1b [DOCS] Model plot updates (elastic/x-pack-elasticsearch#1803)
* [DOCS] Model plot updates

Add to job create.
Remove terms from job resource.

* [DOCS] Describing terms as experimental

Original commit: elastic/x-pack-elasticsearch@815fa0ec37
2017-06-28 07:40:08 -07:00
lcawley 0b51f7326d [DOCS] Fixed terms typo
Original commit: elastic/x-pack-elasticsearch@25d5e829d3
2017-06-26 07:46:47 -07:00
lcawley 431118b123 [DOCS] Add links to population analysis
Original commit: elastic/x-pack-elasticsearch@52e1cd36e2
2017-06-23 11:24:47 -07:00
Lisa Cawley b41ff62bcc [DOCS] Update ML APIs for Elasticsearch Reference (elastic/x-pack-elasticsearch#1718)
* [DOCS] Update ML APIs for Elasticsearch Reference

* [DOCS] Add X-Pack icon for ML APIs

* [DOCS] Add role attribute to ML APIs

Original commit: elastic/x-pack-elasticsearch@997ea39759
2017-06-19 18:23:58 -07:00
Lisa Cawley 62ee1bc635 [DOCS] Add ML categorization of messages (elastic/x-pack-elasticsearch#1666)
* [DOCS] Add ML categorization of messages

* [DOCS] Describe ML categorization_examples_limit property

* [DOCS] Updated ML categorization of messages

* [DOCS] Add links to ML categorization

Original commit: elastic/x-pack-elasticsearch@6403f6ce84
2017-06-12 10:41:14 -07:00
Lisa Cawley 63138f02c5 [DOCS] Move ML APIs up a level in TOC (elastic/x-pack-elasticsearch#1644)
Original commit: elastic/x-pack-elasticsearch@6048721806
2017-06-06 13:42:47 -07:00
David Roberts babe27afe0 [ML] Add a detector_index field to detectors, and use it for updates (elastic/x-pack-elasticsearch#1613)
Detectors now have a field called detector_index.  This is also now the
field that needs to be supplied when updating a detector.  (Previously
it was simply index, which was confusing.)

When detectors are added to an analysis_config it will reassign
ascending detector_index values starting from 0.  The intention is
never to allow deletion of detectors from an analysis_config, but
possibly to allow disabling them in the future.  This ensures that
detector_index values in results will always tie up with detector_ids
in the detectors that created them.

relates elastic/x-pack-elasticsearch#1275

Original commit: elastic/x-pack-elasticsearch@20a660b07b
2017-06-02 10:26:01 +01:00
Lisa Cawley cf5f8e4bad [DOCS] Clarify model snapshots (elastic/x-pack-elasticsearch#1447)
Original commit: elastic/x-pack-elasticsearch@55f307cf89
2017-05-17 09:02:52 -07:00
Lisa Cawley 0542d730c9 [DOCS] Fix minor ML documentation problems (elastic/x-pack-elasticsearch#1336)
Original commit: elastic/x-pack-elasticsearch@53e65b90fc
2017-05-08 06:53:04 -07:00
Lisa Cawley 45cfc17ea1 [DOCS] Add ML analytical functions (elastic/x-pack-elasticsearch#1319)
* [DOCS] Add ML analytical functions

* [DOCS] Add pages for ML analytical functions

* [DOCS] Add links to ML functions from API definitions

Original commit: elastic/x-pack-elasticsearch@ae50b431d3
2017-05-05 10:41:53 -07:00
Lisa Cawley 33c50f1201 [DOCS] Add property table for ML Update Jobs API (elastic/x-pack-elasticsearch#1268)
* [DOCS] Add property table for ML Update Jobs API

* [DOCS] Updates based on feedback for ML Update Jobs API

* [DOCS] Removed detector properties from ML Update Jobs API

* [DOCS] Fixes typos

Original commit: elastic/x-pack-elasticsearch@68d1b5598c
2017-05-02 15:38:41 -07:00
Lisa Cawley 9b2fb6ac16 [DOCS] Change "data feed" to "datafeed" in Machine Learning documentation (elastic/x-pack-elasticsearch#1277)
* [DOCS] Add xpackml attribute to XPack Reference

* [DOCS] Use attribute for datafeed terms

Original commit: elastic/x-pack-elasticsearch@f37bf48ee4
2017-05-02 12:45:42 -07:00
Lisa Cawley af47002654 [DOCS] Edits for ML doc changes in elastic/x-pack-elasticsearch#1169 (elastic/x-pack-elasticsearch#1177)
Original commit: elastic/x-pack-elasticsearch@84f8b4b9bd
2017-04-24 10:56:26 -07:00
Sophie Chang 528ac3d902 [DOCS] ML API docs review (elastic/x-pack-elasticsearch#1169)
* [DOCS] Fix for prelertcategory

* [DOCS] _preview returns a page of data

* [DOCS] Added adv options e.g. background_persist_interval"

* [DOCS] Clarify meanings of model_snapshot params

* [DOCS] Format fixes

* [DOCS] Include _all keyword

* [DOCS] Explain retain.

* [DOCS] Further explanations for model size limits

* [DOCS] Format fixes in quick ref

* [DOCS] Update for exclude_interim

* [DOCS] Update for exclude_interim

* [DOCS] Update for exclude_interim

Original commit: elastic/x-pack-elasticsearch@cdd2fcefdd
2017-04-24 10:07:51 -07:00
Lisa Cawley ded8edcc3d [DOCS] Fixes build and typo issues in ML API update elastic/x-pack-elasticsearch#1118
Original commit: elastic/x-pack-elasticsearch@3ef20792ac
2017-04-19 13:31:07 -07:00
Sophie Chang e2cc00ab8e [DOCS] Review of API docs part 1 (elastic/x-pack-elasticsearch#1118)
* [DOCS] Review of close job and job stats

* [DOCS] Add force close

* [DOCS] Remove invalid params from get records

* [DOCS] Remove invalid params from get buckets

* [DOCS] Job resource corrections

Original commit: elastic/x-pack-elasticsearch@bc68d05097
2017-04-19 11:43:30 -07:00
Lisa Cawley 5223acdd9f [DOCS] Multiple fixes related to privileges in ML documentation (elastic/x-pack-elasticsearch#1110)
* [DOCS] Add privilege requirements to ML API docs

* [DOCS] Document ML cluster-level privileges

Original commit: elastic/x-pack-elasticsearch@221c67d395
2017-04-18 15:13:21 -07:00
lcawley 412bb63383 [DOCS] Remove data type formatting from API pages
Original commit: elastic/x-pack-elasticsearch@fb06ece3f0
2017-04-11 20:17:29 -07:00
lcawley 1a6f813d5a [DOCS] Update all ML API examples with latest build output
Original commit: elastic/x-pack-elasticsearch@f9fa3b813a
2017-04-11 20:15:50 -07:00
lcawley a0771019a5 [DOCS] Remove redundant batch_span and period from job config
Original commit: elastic/x-pack-elasticsearch@95e162eaa9
2017-04-11 13:30:03 -07:00
Lisa Cawley 90575b18f4 [DOCS] Add ML data feed API examples (elastic/x-pack-elasticsearch#1016)
* [DOCS] Added examples for all ML job APIs

* [DOCS] Add ML datafeed API examples

Original commit: elastic/x-pack-elasticsearch@9634356371
2017-04-10 09:06:34 -07:00
Lisa Cawley e339cf82df [DOCS] Added examples for all ML job APIs (elastic/x-pack-elasticsearch#980)
Original commit: elastic/x-pack-elasticsearch@7911b53af9
2017-04-06 08:07:49 -07:00
Lisa Cawley 843a0d8b3f [DOCS] Add ML documentation to master (elastic/x-pack-elasticsearch#959)
Original commit: elastic/x-pack-elasticsearch@666a10bd23
2017-04-04 15:26:39 -07:00