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

Updating ML Commons API documentation #156

Merged
merged 4 commits into from
May 16, 2023

Conversation

AlibiZhenis
Copy link
Contributor

@AlibiZhenis AlibiZhenis commented Apr 29, 2023

Description

Updating ML Commons API documentation

Check List

  • 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.

Signed-off-by: Alibi Zhenis <alibizhenis4@gmail.com>
@codecov-commenter
Copy link

codecov-commenter commented Apr 29, 2023

Codecov Report

Merging #156 (12fee52) into main (c74e1fb) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #156   +/-   ##
=======================================
  Coverage   90.67%   90.67%           
=======================================
  Files          36       36           
  Lines        3989     3989           
=======================================
  Hits         3617     3617           
  Misses        372      372           

Copy link
Collaborator

@dhrubo-os dhrubo-os left a comment

Choose a reason for hiding this comment

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

I remember we also had a discussion to add a read me for this document generation.

@@ -0,0 +1,6 @@
Upload Pretrained Model
==================
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can you cover this line upto Model

@@ -12,6 +12,13 @@ Upload Model

api/ml_commons_upload_api

Upload Pretrained Model
~~~~~~~~~~~~~~
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can you please cover this line upto Model?

@@ -33,6 +40,13 @@ Get Model Info

api/ml_commons_get_model_info_api

Generate Embedding
~~~~~~~~~~~~~~
Copy link
Collaborator

Choose a reason for hiding this comment

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

Can you please cover this line upto Embedding

Signed-off-by: Alibi Zhenis <alibizhenis4@gmail.com>
Signed-off-by: Alibi Zhenis <alibizhenis4@gmail.com>
@dhrubo-os dhrubo-os merged commit d1101a2 into opensearch-project:main May 16, 2023
opensearch-trigger-bot bot pushed a commit that referenced this pull request May 16, 2023
* updating ML Commons API documentation

Signed-off-by: Alibi Zhenis <alibizhenis4@gmail.com>

* updating developer guide

Signed-off-by: Alibi Zhenis <alibizhenis4@gmail.com>

---------

Signed-off-by: Alibi Zhenis <alibizhenis4@gmail.com>
(cherry picked from commit d1101a2)
dhrubo-os pushed a commit that referenced this pull request May 16, 2023
* updating ML Commons API documentation

Signed-off-by: Alibi Zhenis <alibizhenis4@gmail.com>

* updating developer guide

Signed-off-by: Alibi Zhenis <alibizhenis4@gmail.com>

---------

Signed-off-by: Alibi Zhenis <alibizhenis4@gmail.com>
(cherry picked from commit d1101a2)

Co-authored-by: Alibi Zhenis <92104549+AlibiZhenis@users.noreply.github.com>
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