Commit Graph

21 Commits

Author SHA1 Message Date
lcawley c243d6eb21 [DOCS] Fixed short descriptions for ML APIs
Original commit: elastic/x-pack-elasticsearch@75937c0da1
2018-01-15 08:44:08 -08: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
lcawley 4f1866db69 [DOCS] Updated titles of ML APIs
Original commit: elastic/x-pack-elasticsearch@3b3d856a89
2017-12-14 10:52:49 -08: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 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
Dimitris Athanasiou 4e03c657a3 [ML] Write model_memory_limit with units into the cluster state (elastic/x-pack-elasticsearch#1934)
This is step 2 of elastic/x-pack-elasticsearch#1604

This change stores `model_memory_limit` as a string with `mb` unit.
I considered using the `toString` method of `ByteSizeValue` but it
can lead to accuracy loss. Adding the fixed `mb` unit maintains
the accuracy, while making clear what unit the value is in.

Original commit: elastic/x-pack-elasticsearch@4dc48f0ce8
2017-07-06 15:40:19 +01: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 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 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 a615532866 [DOCS] ML 5.4 docs final tuning (elastic/x-pack-elasticsearch#1265)
Original commit: elastic/x-pack-elasticsearch@91e4af140d
2017-05-01 11:30:19 -07:00
Lisa Cawley d709a64638 [DOCS] Change allows to enables in ML docs (elastic/x-pack-elasticsearch#1230)
Original commit: elastic/x-pack-elasticsearch@a408fd59f6
2017-04-26 15:29:55 -07:00
Lisa Cawley 268f5a95af [DOCS] Add authorization section to ML API pages (elastic/x-pack-elasticsearch#1205)
* [DOCS] Edits for description of ML results resource

* [DOCS] Adds Authorization section to ML API pages

Original commit: elastic/x-pack-elasticsearch@797761e7ae
2017-04-25 14:21: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
Zachary Tong d993926ba4 [DOCS] Re-enable XPack doc testing (elastic/x-pack-elasticsearch#1146)
Adds a gradle build for documentation testing, partially stolen from the xpack meta repo. Updated to make work with the current setup

index.asciidoc was updated/enabled as a test, and various pre-existing tests appear to be working. There are a large number of tests still ignored due to missing proper // CONSOLE tags

Original commit: elastic/x-pack-elasticsearch@1d596f0be3
2017-04-21 11:23:27 -04: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
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