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 Kmeans and AD command documentation #493

Merged
merged 2 commits into from
Mar 15, 2022
Merged

Add Kmeans and AD command documentation #493

merged 2 commits into from
Mar 15, 2022

Conversation

jackiehanyang
Copy link
Contributor

@jackiehanyang jackiehanyang commented Mar 14, 2022

Signed-off-by: jackieyanghan jkhanjob@gmail.com

Description

  • Add Kmeans and AD command documentation
  • Add doc-test for AD command. Not going to add doc-test for Kmeans command because the query result (ClusterID) serves as a symbol of different classifications, the map relationship is not fixed. Therefore, it's difficult to predict the query result in doc-test. Will add integration tests in the next PR to cover this.

Issues Resolved

#470

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.

@jackiehanyang jackiehanyang requested a review from a team as a code owner March 14, 2022 20:24
Signed-off-by: jackieyanghan <jkhanjob@gmail.com>
@codecov-commenter
Copy link

codecov-commenter commented Mar 14, 2022

Codecov Report

Merging #493 (5f4ce02) into main (fff24aa) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##               main     #493   +/-   ##
=========================================
  Coverage     95.25%   95.25%           
  Complexity     2746     2746           
=========================================
  Files           276      276           
  Lines          7416     7416           
  Branches        545      545           
=========================================
  Hits           7064     7064           
  Misses          298      298           
  Partials         54       54           
Flag Coverage Δ
query-workbench 62.91% <ø> (ø)
sql-engine 98.40% <ø> (ø)

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


Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update fff24aa...5f4ce02. Read the comment docs.

Signed-off-by: jackieyanghan <jkhanjob@gmail.com>
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.

replace checked-in ZIP with a dynamic dependency.
#491

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.

LGTM

@jackiehanyang
Copy link
Contributor Author

Need to replace ml-commons zip file with a dynamic dependency, related open issues: issue 495, issue 491

@penghuo penghuo merged commit ee4bce0 into opensearch-project:main Mar 15, 2022
opensearch-trigger-bot bot pushed a commit that referenced this pull request Mar 15, 2022
Signed-off-by: jackieyanghan <jkhanjob@gmail.com>
(cherry picked from commit ee4bce0)
penghuo pushed a commit that referenced this pull request Mar 16, 2022
Signed-off-by: jackieyanghan <jkhanjob@gmail.com>
(cherry picked from commit ee4bce0)
@opensearch-trigger-bot
Copy link
Contributor

The backport to 1.x failed:

The process '/usr/bin/git' failed with exit code 1

To backport manually, run these commands in your terminal:

# Fetch latest updates from GitHub
git fetch
# Create a new working tree
git worktree add .worktrees/backport-1.x 1.x
# Navigate to the new working tree
cd .worktrees/backport-1.x
# Create a new branch
git switch --create backport/backport-493-to-1.x
# Cherry-pick the merged commit of this pull request and resolve the conflicts
git cherry-pick -x --mainline 1 ee4bce03333b4f45379e6c5ae537011c6f4bf6f8
# Push it to GitHub
git push --set-upstream origin backport/backport-493-to-1.x
# Go back to the original working tree
cd ../..
# Delete the working tree
git worktree remove .worktrees/backport-1.x

Then, create a pull request where the base branch is 1.x and the compare/head branch is backport/backport-493-to-1.x.

opensearch-trigger-bot bot pushed a commit that referenced this pull request Mar 17, 2022
Signed-off-by: jackieyanghan <jkhanjob@gmail.com>
(cherry picked from commit ee4bce0)
joshuali925 pushed a commit that referenced this pull request Mar 17, 2022
Signed-off-by: jackieyanghan <jkhanjob@gmail.com>
(cherry picked from commit ee4bce0)

Co-authored-by: Jackie Han <41348518+jackiehanyang@users.noreply.github.com>
ps48 added a commit that referenced this pull request Jul 28, 2022
* Disable flaky test in JdbcTestIT. (#475)

Signed-off-by: penghuo <penghuo@gmail.com>

* Update dependency opensearch-ml-client group name (#477)

Signed-off-by: jackieyanghan <jkhanjob@gmail.com>

* Collected fixes related to bugs #280, #302, #783, #696 and 317 all together. (#479)

Signed-off-by: Yury Fridlyand <yuryf@bitquilltech.com>

* Add JDK 8 to CI Matrix  (#483) (#484)

* fixed references in java 8 and added to ci matrix
* filter test that fails due to jdk 8 bug
* use different degree to radian conversion for difference in jdk
* skip date time format tests that cause error due to jdk bug
* only disable DateTime unit test on Java 8

Bypassing failed DCO check

Signed-off-by: David Cui <davidcui@amazon.com>
(cherry picked from commit b6fccbd)

Co-authored-by: David Cui <53581635+davidcui1225@users.noreply.github.com>

* Add parse docs to PPL commands index (#486) (#487)

Signed-off-by: Joshua Li <joshuali925@gmail.com>

* Add 1.3.0 release notes (#492)

Signed-off-by: Eugene Lee <eugenesk@amazon.com>

* Add Kmeans and AD command documentation (#493) (#497)

Signed-off-by: jackieyanghan <jkhanjob@gmail.com>
(cherry picked from commit ee4bce0)

* Bump version to 1.3.1

Signed-off-by: Sayali Gaikawad <gaiksaya@amazon.com>

* Bump ml

Signed-off-by: Sayali Gaikawad <gaiksaya@amazon.com>

* Add new zip

Signed-off-by: Sayali Gaikawad <gaiksaya@amazon.com>

* Updated release drafter

Signed-off-by: Sayali Gaikawad <gaiksaya@amazon.com>

* Remove checked-in ml-commons dependency (#529)

Signed-off-by: jackieyanghan <jkhanjob@gmail.com>

* Bump workbench to 1.3.1 (#540)

Signed-off-by: Joshua Li <joshuali925@gmail.com>

* Bug Fix, return default ID when log4j ThreadContext is empty (#538) (#539) (#543)

Signed-off-by: penghuo <penghuo@gmail.com>
(cherry picked from commit 54b7257)

* Incremented version to 1.3.2. (#593)

Signed-off-by: Zelin Hao <zelinhao@amazon.com>
Signed-off-by: Joshua Li <joshuali925@gmail.com>

Co-authored-by: Joshua Li <joshuali925@gmail.com>

* Version bump 1.3.3

Signed-off-by: pgodithi <pgodithi@amazon.com>

* [1.3] Bump spring-beans to 5.2.20 (#632)

Signed-off-by: Joshua Li <joshuali925@gmail.com>

* Version bump 1.3.3

Signed-off-by: pgodithi <pgodithi@amazon.com>

* Incremented version to 1.3.4. (#681)

* Incremented version to 1.3.4.

Signed-off-by: Zelin Hao <zelinhao@amazon.com>

* bump jackson to 2.13.2

Signed-off-by: Joshua Li <joshuali925@gmail.com>

Co-authored-by: Joshua Li <joshuali925@gmail.com>

Co-authored-by: Peng Huo <penghuo@gmail.com>
Co-authored-by: Jackie Han <41348518+jackiehanyang@users.noreply.github.com>
Co-authored-by: Yury-Fridlyand <88679692+Yury-Fridlyand@users.noreply.github.com>
Co-authored-by: opensearch-trigger-bot[bot] <98922864+opensearch-trigger-bot[bot]@users.noreply.github.com>
Co-authored-by: David Cui <53581635+davidcui1225@users.noreply.github.com>
Co-authored-by: Eugene Lee <eugenesk@amazon.com>
Co-authored-by: Sayali Gaikawad <gaiksaya@amazon.com>
Co-authored-by: Sayali Gaikawad <61760125+gaiksaya@users.noreply.github.com>
Co-authored-by: Joshua Li <joshuali925@gmail.com>
Co-authored-by: Zelin Hao <87548827+zelinh@users.noreply.github.com>
Co-authored-by: pgodithi <pgodithi@amazon.com>
Co-authored-by: Anirudha (Ani) Jadhav <anirudha@nyu.edu>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants