Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add document for ml command. #1001

Merged
merged 3 commits into from
Nov 3, 2022
Merged

Add document for ml command. #1001

merged 3 commits into from
Nov 3, 2022

Conversation

jngz-es
Copy link
Contributor

@jngz-es jngz-es commented Nov 1, 2022

Signed-off-by: Jing Zhang [email protected]

Description

Add document for the generic ml command in PPL.

Issues Resolved

#849

Check List

  • New functionality includes testing.
    • All tests pass, including unit test, integration test and doctest
  • New functionality has been documented.
    • New functionality has javadoc added
    • New functionality has user manual doc added
  • Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@jngz-es jngz-es requested a review from a team as a code owner November 1, 2022 02:27
@Yury-Fridlyand
Copy link
Collaborator

Please update docs/user/ppl/index.rst

@jngz-es
Copy link
Contributor Author

jngz-es commented Nov 1, 2022

Thanks, will update it.

Signed-off-by: Jing Zhang <[email protected]>
@codecov-commenter
Copy link

codecov-commenter commented Nov 1, 2022

Codecov Report

Merging #1001 (e8ed0d2) into 2.x (c6b234c) will decrease coverage by 2.67%.
The diff coverage is n/a.

@@             Coverage Diff              @@
##                2.x    #1001      +/-   ##
============================================
- Coverage     98.18%   95.51%   -2.68%     
  Complexity     3223     3223              
============================================
  Files           310      320      +10     
  Lines          8058     8716     +658     
  Branches        524      643     +119     
============================================
+ Hits           7912     8325     +413     
- Misses          142      334     +192     
- Partials          4       57      +53     
Flag Coverage Δ
query-workbench 62.76% <ø> (?)
sql-engine 98.18% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
...h/public/components/QueryLanguageSwitch/Switch.tsx 85.71% <0.00%> (ø)
workbench/public/components/Main/main.tsx 53.00% <0.00%> (ø)
workbench/public/components/Header/Header.tsx 100.00% <0.00%> (ø)
...ublic/components/QueryResults/QueryResultsBody.tsx 68.32% <0.00%> (ø)
workbench/public/utils/PanelWrapper.tsx 100.00% <0.00%> (ø)
workbench/public/components/SQLPage/SQLPage.tsx 100.00% <0.00%> (ø)
...ch/public/components/QueryResults/QueryResults.tsx 61.60% <0.00%> (ø)
workbench/public/application.tsx 0.00% <0.00%> (ø)
workbench/public/components/PPLPage/PPLPage.tsx 56.52% <0.00%> (ø)
workbench/public/components/app.tsx 0.00% <0.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

@penghuo
Copy link
Collaborator

penghuo commented Nov 1, 2022

add deprecation on Kmeans and AD docs?

penghuo
penghuo previously approved these changes Nov 1, 2022
Copy link
Collaborator

@penghuo penghuo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks.

* time_field(string): mandatory. It specifies the time field for RCF to use as time-series data.
* date_format(string): optional. It's used for formatting time_field field. The default formatting is "yyyy-MM-dd HH:mm:ss".
* time_zone(string): optional. It's used for setting time zone for time_field filed. The default time zone is UTC.
* category_field(string): optional. It specifies the category field used to group inputs. Each category will be independently predicted.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we support category field now?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it's a temporary solution implemented in PPL #952

@dai-chen dai-chen added documentation Improvements or additions to documentation ml Issues related to integration with ML commons and plugin PPL Piped processing language labels Nov 2, 2022
@jngz-es jngz-es requested review from ylwu-amzn and penghuo and removed request for penghuo and ylwu-amzn November 2, 2022 23:23
@dai-chen dai-chen merged commit 4e418c7 into opensearch-project:2.x Nov 3, 2022
opensearch-trigger-bot bot pushed a commit that referenced this pull request Nov 3, 2022
* Add document for ml command.

Signed-off-by: Jing Zhang <[email protected]>

* Update the index.

Signed-off-by: Jing Zhang <[email protected]>

* Add deprecation for AD and KMEANS documents.

Signed-off-by: Jing Zhang <[email protected]>

Signed-off-by: Jing Zhang <[email protected]>
(cherry picked from commit 4e418c7)
penghuo pushed a commit that referenced this pull request Nov 3, 2022
* Add document for ml command.

Signed-off-by: Jing Zhang <[email protected]>

* Update the index.

Signed-off-by: Jing Zhang <[email protected]>

* Add deprecation for AD and KMEANS documents.

Signed-off-by: Jing Zhang <[email protected]>

Signed-off-by: Jing Zhang <[email protected]>
(cherry picked from commit 4e418c7)

Co-authored-by: Jing Zhang <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport 2.4 documentation Improvements or additions to documentation ml Issues related to integration with ML commons and plugin PPL Piped processing language
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants