Skip to content

Add semantic highlighter related docs #9603

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Add semantic highlighter related docs #9603

wants to merge 6 commits into from

Conversation

junqiu-lei
Copy link
Member

@junqiu-lei junqiu-lei commented Apr 11, 2025 •
edited
Loading

Description

Add semantic highlighter related docs:

  • Updated existing highlighter doc to include new semantic type highlighter
  • Updated pre-trained model doc to include new semantic sentence highlighting model
    • TODO: need update model artifact link once model published
  • Added tutorial for semantic highlighting

Issues Resolved

Closes #9583

Version

OpenSearch 3.0 beta

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.

@github-actions GitHub Actions
Copy link

Thank you for submitting your PR. The PR states are In progress (or Draft) -> Tech review -> Doc review -> Editorial review -> Merged.

Before you submit your PR for doc review, make sure the content is technically accurate. If you need help finding a tech reviewer, tag a maintainer.

When you're ready for doc review, tag the assignee of this PR. The doc reviewer may push edits to the PR directly or leave comments and editorial suggestions for you to address (let us know in a comment if you have a preference). The doc reviewer will arrange for an editorial review.

@junqiu-lei junqiu-lei force-pushed the semantic-highlighter branch from cb898fc to 23fe677 Compare April 11, 2025 17:24
@junqiu-lei junqiu-lei force-pushed the semantic-highlighter branch from 23fe677 to c32780c Compare April 11, 2025 20:11
@junqiu-lei junqiu-lei marked this pull request as ready for review April 11, 2025 20:11
junqiu-lei
junqiu-lei commented Apr 14, 2025
View reviewed changes
_ml-commons-plugin/pretrained-models.md

| Model name | Version | TorchScript artifact | Description |
|:---|:---|:---|:---|
| `opensearch/semantic-sentence-highlighter-model-v1` | 1.0.0 | - [model_url](placeholder-link) <br>- [config_url](placeholder-link) | A model optimized for identifying semantically relevant sentences for highlighting. (Artifacts coming soon) |
Copy link
Member Author

Choose a reason for hiding this comment

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

Will update the placeholder-link once model published soon before this PR merge.

@kolchfa-aws kolchfa-aws added the release-notes PR: Include this PR in the automated release notes label Apr 15, 2025
@junqiu-lei junqiu-lei force-pushed the semantic-highlighter branch from c32780c to af3117b Compare April 17, 2025 18:17
@kolchfa-aws
Doc review
f9b081f 
Signed-off-by: Fanit Kolchina <[email protected]>
@kolchfa-aws
Resolve merge conflicts
ccd9164 
Signed-off-by: Fanit Kolchina <[email protected]>
@kolchfa-aws
Copy link
Collaborator

@junqiu-lei Doc review complete. Please verify that my changes are accurate and the tutorial works. Thanks!

@kolchfa-aws kolchfa-aws added the 4 - Doc review PR: Doc review in progress label Apr 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@heemin32 heemin32 heemin32 approved these changes

@kolchfa-aws kolchfa-aws Awaiting requested review from kolchfa-aws kolchfa-aws is a code owner

@Naarcha-AWS Naarcha-AWS Awaiting requested review from Naarcha-AWS Naarcha-AWS is a code owner

@AMoo-Miki AMoo-Miki Awaiting requested review from AMoo-Miki AMoo-Miki is a code owner

@natebower natebower Awaiting requested review from natebower natebower is a code owner

@dlvenable dlvenable Awaiting requested review from dlvenable dlvenable is a code owner

@epugh epugh Awaiting requested review from epugh epugh is a code owner

At least 1 approving review is required to merge this pull request.

Assignees

@kolchfa-aws kolchfa-aws

Labels
4 - Doc review PR: Doc review in progress release-notes PR: Include this PR in the automated release notes v3.0.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[DOC] Add semantic highlighter feature and related pre-trained model documentation
3 participants
@junqiu-lei @kolchfa-aws @heemin32