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 ml inference ingest processor documentation #7095

Merged
merged 21 commits into from
May 8, 2024

Conversation

mingshl
Copy link
Contributor

@mingshl mingshl commented May 3, 2024

Description

Add ml inference ingest processor documentation

Issues Resolved

Closes #7041

Checklist

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

@hdhalter
Copy link
Contributor

hdhalter commented May 3, 2024

Thanks so much, @mingshl! Do you need a tech review or is it ready for doc review? In the meantime, can you please see if you can address some of the Vale style errors?

@hdhalter hdhalter added 3 - Tech review PR: Tech review in progress release-notes PR: Include this PR in the automated release notes v2.14.0 labels May 3, 2024

**Step 1: Create a pipeline.**

The following example request creates an ingest pipeline where the model requires an `input` field and produces a `data` field in the prediction task and the document has a `passage_text` field, which will be converted into text embeddings and the embeddings will be stored in `passage_embedding` field.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggest create a model with one of our blueprints https://github.com/opensearch-project/ml-commons/tree/2.x/docs/remote_inference_blueprints, that will make it easier for user to create connector and model and try the ml_inference example below

Copy link
Contributor Author

Choose a reason for hiding this comment

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

will link with the tutorial and starting from creating connector, creating model, deploying model, creating index and upload documents.

Copy link
Contributor

Choose a reason for hiding this comment

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

@mingshl Have you added the tutorial? Once it's added, please tag me for the doc review. I'll also move it forward into editorial review.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

not yet. will create seperate PRs for the tutorials. I think this Pr is ready to merge/ Thanks @vagimeli

Copy link
Contributor

Choose a reason for hiding this comment

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

@mingshl It's going through editorial and then I'll merge once editor approves. Thank you.

Signed-off-by: Mingshi Liu <[email protected]>
@mingshl
Copy link
Contributor Author

mingshl commented May 7, 2024

@hdhalter addressed Vale style error. It's ready for tech review. Thanks!

Signed-off-by: Mingshi Liu <[email protected]>
@vagimeli vagimeli added 5 - Editorial review PR: Editorial review in progress and removed 3 - Tech review PR: Tech review in progress labels May 7, 2024
Copy link
Contributor

@vagimeli vagimeli left a comment

Choose a reason for hiding this comment

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

Doc review complete, with some edits for clarity and style guide compliance. Moving to editorial review.

Signed-off-by: Melissa Vagi <[email protected]>

Signed-off-by: Melissa Vagi <[email protected]>
mingshl and others added 2 commits May 7, 2024 10:19
Co-authored-by: Yaliang Wu <[email protected]>
Signed-off-by: Mingshi Liu <[email protected]>
Co-authored-by: Yaliang Wu <[email protected]>
Signed-off-by: Mingshi Liu <[email protected]>
Copy link
Collaborator

@natebower natebower left a comment

Choose a reason for hiding this comment

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

@mingshl @vagimeli Please see my comments and changes and let me know if you have any questions. Thanks!

_ingest-pipelines/processors/ml-inference.md Outdated Show resolved Hide resolved
_ingest-pipelines/processors/ml-inference.md Outdated Show resolved Hide resolved
_ingest-pipelines/processors/ml-inference.md Outdated Show resolved Hide resolved
_ingest-pipelines/processors/ml-inference.md Outdated Show resolved Hide resolved
_ingest-pipelines/processors/ml-inference.md Outdated Show resolved Hide resolved
_ingest-pipelines/processors/ml-inference.md Outdated Show resolved Hide resolved
_ingest-pipelines/processors/ml-inference.md Outdated Show resolved Hide resolved
_ingest-pipelines/processors/ml-inference.md Outdated Show resolved Hide resolved
_ingest-pipelines/processors/ml-inference.md Outdated Show resolved Hide resolved
_ingest-pipelines/processors/ml-inference.md Outdated Show resolved Hide resolved
vagimeli and others added 13 commits May 8, 2024 10:13
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Co-authored-by: Nathan Bower <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>
Signed-off-by: Melissa Vagi <[email protected]>

Signed-off-by: Melissa Vagi <[email protected]>
@vagimeli vagimeli merged commit ea08c2c into opensearch-project:main May 8, 2024
5 checks passed
@vagimeli vagimeli removed the 5 - Editorial review PR: Editorial review in progress label May 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release-notes PR: Include this PR in the automated release notes v2.14.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC] Add documentation for ML Inference Ingest Processor
5 participants