[ML] Documentation for Data Frame Analytics high-level REST client #42288
Conversation
|
Pinging @elastic/ml-core |
przemekwitek
force-pushed
the
df-analyticsconfig-docs
branch
from
6c13b18 to
ca6d517
Compare
...high-level/src/test/java/org/elasticsearch/client/documentation/MlClientDocumentationIT.java
Outdated
Show resolved
Hide resolved
...high-level/src/test/java/org/elasticsearch/client/documentation/MlClientDocumentationIT.java
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
This should have callouts defined, and the match_all default mention should be in the callout for setQuery
There was a problem hiding this comment.
Do we want to document the OutlierDetection builder methods here as well? There are zero java docs for the class. We need to have at least some documentation (preferably here AND some java docs on the methods) on the builder methods.
There was a problem hiding this comment.
To make this future-proof, I think we should refer from here to another section where we will list creation of the various analysis types.
There was a problem hiding this comment.
Added a section about analysis. Not sure though how detailed it should be.
There was a problem hiding this comment.
Also add analyzed fields
There was a problem hiding this comment.
To make this future-proof, I think we should refer from here to another section where we will list creation of the various analysis types.
There was a problem hiding this comment.
Is the s at the end going to cause duplicate s'es ?
There was a problem hiding this comment.
No, the token translates to (see elastic/docs#889):
:dataframe-analytics: {dataframe} analytics config
and "s" makes it plural
There was a problem hiding this comment.
Also add a section about analyzed fields
There was a problem hiding this comment.
Done.
Added callout in "Data Frame Analytics Configuration" section
przemekwitek
force-pushed
the
df-analyticsconfig-docs
branch
from
9403dd9 to
21c5447
Compare
przemekwitek
force-pushed
the
df-analyticsconfig-docs
branch
from
21c5447 to
bcec93a
Compare
|
run elasticsearch-ci/bwc |
przemekwitek
force-pushed
the
df-analyticsconfig-docs
branch
2 times, most recently
from
231ebd8 to
c7fe885
Compare
przemekwitek
force-pushed
the
df-analyticsconfig-docs
branch
from
c7fe885 to
85ec8a6
Compare
There was a problem hiding this comment.
| The index to which data should be written by the {dataframe-job}. | |
| The index to which data should be written by the {dataframe-analytics}. |
There was a problem hiding this comment.
Please see my other comment.
There was a problem hiding this comment.
{dataframe-job} again rather than {dataframe-analytics}. Is this intentional have I misunderstood the naming?
There was a problem hiding this comment.
It is intentional.
{dataframe-job} resolves to "data frame analytics job" and {dataframe-analytics} resolves to "data frame analytics config". So I use the former when I write about the computational process and the latter when I talk about DataFrameAnalyticsConfig.
I may rename {dataframe-analytics} to {dataframe-analytics-config} if you find it clearer. WDYT?
There was a problem hiding this comment.
Thanks for the explanation. I see you renamed {dataframe-analytics} to {dataframe-analytics-config} that makes sense to me
przemekwitek
force-pushed
the
df-analyticsconfig-docs
branch
from
85ec8a6 to
3139167
Compare
jakelandis
added
v8.0.0-alpha1
>docs
|
Pinging @elastic/es-docs (Team:Docs) |
6 participants
Documentation for Data Frame Analytics high-level REST client.
Contains documentation as well as integration tests for 7 methods (Get, GetStats, Put, Delete, Start, Stop, Evaluate).
See also: elastic/docs#889