Skip to content

Add Documentation for creating Neural Sparse Remote Model #3857

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

Merged
merged 8 commits into from
Jul 8, 2025

Conversation

zhichao-aws
Copy link
Member

Description

Add Documentation for creating Neural Sparse Remote Model

Related Issues

Resolves opensearch-project/documentation-website#9714

Check List

  • New functionality includes testing.
  • New functionality has been documented.
  • API changes companion pull request created.
  • Commits are signed per the DCO using --signoff.
  • Public documentation issue/PR created.

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: zhichao-aws <[email protected]>
Signed-off-by: zhichao-aws <[email protected]>
Signed-off-by: zhichao-aws <[email protected]>
Signed-off-by: zhichao-aws <[email protected]>
@zhichao-aws zhichao-aws had a problem deploying to ml-commons-cicd-env-require-approval May 19, 2025 07:30 — with GitHub Actions Failure
@zhichao-aws zhichao-aws had a problem deploying to ml-commons-cicd-env-require-approval May 19, 2025 07:30 — with GitHub Actions Failure
@zhichao-aws zhichao-aws had a problem deploying to ml-commons-cicd-env-require-approval May 19, 2025 07:30 — with GitHub Actions Failure
@zhichao-aws zhichao-aws had a problem deploying to ml-commons-cicd-env-require-approval May 19, 2025 07:30 — with GitHub Actions Failure
@zhichao-aws zhichao-aws had a problem deploying to ml-commons-cicd-env-require-approval June 10, 2025 00:07 — with GitHub Actions Failure
@zhichao-aws zhichao-aws had a problem deploying to ml-commons-cicd-env-require-approval June 10, 2025 00:07 — with GitHub Actions Failure
@zhichao-aws zhichao-aws had a problem deploying to ml-commons-cicd-env-require-approval June 10, 2025 00:07 — with GitHub Actions Failure
@zhichao-aws zhichao-aws had a problem deploying to ml-commons-cicd-env-require-approval June 10, 2025 00:07 — with GitHub Actions Failure
Signed-off-by: zhichao-aws <[email protected]>
@zhichao-aws zhichao-aws had a problem deploying to ml-commons-cicd-env-require-approval July 7, 2025 03:39 — with GitHub Actions Failure
@zhichao-aws zhichao-aws had a problem deploying to ml-commons-cicd-env-require-approval July 7, 2025 03:39 — with GitHub Actions Failure
@zhichao-aws zhichao-aws had a problem deploying to ml-commons-cicd-env-require-approval July 7, 2025 03:39 — with GitHub Actions Failure
@zhichao-aws zhichao-aws had a problem deploying to ml-commons-cicd-env-require-approval July 7, 2025 03:39 — with GitHub Actions Failure
Signed-off-by: zhichao-aws <[email protected]>
@zhichao-aws zhichao-aws had a problem deploying to ml-commons-cicd-env-require-approval July 7, 2025 06:09 — with GitHub Actions Failure
@zhichao-aws zhichao-aws had a problem deploying to ml-commons-cicd-env-require-approval July 7, 2025 06:09 — with GitHub Actions Failure
@zhichao-aws zhichao-aws had a problem deploying to ml-commons-cicd-env-require-approval July 7, 2025 06:09 — with GitHub Actions Failure
@zhichao-aws zhichao-aws had a problem deploying to ml-commons-cicd-env-require-approval July 7, 2025 06:09 — with GitHub Actions Failure
"source": [
"import os\n",
"\n",
"bucket_name = \"your_bucket_name\"\n",
Copy link
Collaborator

Choose a reason for hiding this comment

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

[Non blocking] For placeholder values, is it better to use ${xxx} format? Because in ml-commons this is the standard of placeholder format, maybe it's easier for user to recognize this.

Copy link
Member Author

Choose a reason for hiding this comment

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

Python syntax doesn't support ${xxx} format. To use f-string like f"xx {bucket_name}", we need to define it as a string var here

zane-neo
zane-neo previously approved these changes Jul 7, 2025
@zhichao-aws zhichao-aws had a problem deploying to ml-commons-cicd-env-require-approval July 8, 2025 02:56 — with GitHub Actions Failure
@zhichao-aws zhichao-aws had a problem deploying to ml-commons-cicd-env-require-approval July 8, 2025 02:56 — with GitHub Actions Failure
@zhichao-aws zhichao-aws had a problem deploying to ml-commons-cicd-env-require-approval July 8, 2025 02:56 — with GitHub Actions Failure
@zhichao-aws zhichao-aws had a problem deploying to ml-commons-cicd-env-require-approval July 8, 2025 02:56 — with GitHub Actions Failure
@zane-neo zane-neo merged commit f458d01 into opensearch-project:main Jul 8, 2025
5 of 9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[DOC]Add Documentation for creating Neural Sparse Remote Model
3 participants