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.

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

[DOC] Update Cohere Connector documentation (v3 and PQ guidance) #6648

Open
3 tasks
dylan-tong-aws opened this issue Mar 11, 2024 · 6 comments
Open
3 tasks

[DOC] Update Cohere Connector documentation (v3 and PQ guidance) #6648

dylan-tong-aws opened this issue Mar 11, 2024 · 6 comments
Assignees
@hdhalter
Labels
2 - In progress Issue/PR: The issue or PR is in progress.

Comments

@dylan-tong-aws
Copy link

What do you want to do?

  • [ x] Request a change to existing documentation
  • Add new documentation
  • Report a technical problem with the documentation
  • Other

Tell us about your request. Provide a summary of the request and all versions that are affected.

Update the Cohere connector documentation:
https://opensearch.org/docs/latest/ml-commons-plugin/remote-models/connectors/#cohere-connector

  1. Update the blueprint to use the latest version for cohere embed v3. Please work with @ylwu-amzn to obtain the latest blueprint. I can't find it in Github, and there are no examples in the documentation.

  2. Add a section for PQ support guidance:

Cohere embed v3 has been tuned for IVF PQ index support (https://opensearch.org/docs/latest/search-plugins/knn/knn-index/#supported-faiss-encoders). The following default parameters should work well:

code_size=8
Cohere recommend m=256 (for a 16x compression) or m=128 (for a 32x compression).

As similarity_metric, cohere has tested and tuned the model inner product

What other resources are available? Provide links to related issues, POCs, steps for testing, etc.
@ylwu-amzn
Copy link
Contributor

Cohere embed blueprint (v2 and v3):
https://github.com/opensearch-project/ml-commons/blob/2.x/docs/remote_inference_blueprints/cohere_connector_embedding_blueprint.md

@hdhalter
Copy link
Contributor

Thanks, @dylan-tong-aws and @ylwu-amzn ! Is this connected to a release?

@ylwu-amzn
Copy link
Contributor

Cohere Connector documentation

This part is not for 2.13 release. It's just a doc for released feature.

@hdhalter hdhalter added 1 - Backlog - DEV Developer assigned to issue is responsible for creating PR. and removed untriaged labels Mar 13, 2024
hdhalter added a commit that referenced this issue Mar 13, 2024
@hdhalter
Updates Cohere connector info in connectors.md
e98b8e1 
Addresses #1 in #6648

Signed-off-by: Heather Halter <[email protected]>
@hdhalter hdhalter mentioned this issue Mar 13, 2024
Merged
1 task
@hdhalter
Copy link
Contributor

hdhalter commented Mar 13, 2024 •
edited
Loading

This PR addresses the first item above: #6671

@hdhalter hdhalter added 2 - In progress Issue/PR: The issue or PR is in progress. and removed 1 - Backlog - DEV Developer assigned to issue is responsible for creating PR. labels Mar 13, 2024
@hdhalter hdhalter self-assigned this Mar 13, 2024
hdhalter added a commit that referenced this issue Mar 14, 2024
@hdhalter @ylwu-amzn @kolchfa-aws
Updates Cohere connector info in connectors.md (#6671)
a772802 
* Updates Cohere connector info in connectors.md

Addresses #1 in #6648

Signed-off-by: Heather Halter <[email protected]>

* Added link to github

Signed-off-by: Heather Halter <[email protected]>

* Update _ml-commons-plugin/remote-models/connectors.md

Co-authored-by: Yaliang Wu <[email protected]>
Signed-off-by: Heather Halter <[email protected]>

* Fixed link formatting

Signed-off-by: Heather Halter <[email protected]>

* Update _ml-commons-plugin/remote-models/connectors.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Heather Halter <[email protected]>

---------

Signed-off-by: Heather Halter <[email protected]>
Co-authored-by: Yaliang Wu <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
opensearch-trigger-bot bot pushed a commit that referenced this issue Mar 14, 2024
@github-actions @ylwu-amzn @kolchfa-aws
Updates Cohere connector info in connectors.md (#6671)
eaf4d2f 
* Updates Cohere connector info in connectors.md

Addresses #1 in #6648

Signed-off-by: Heather Halter <[email protected]>

* Added link to github

Signed-off-by: Heather Halter <[email protected]>

* Update _ml-commons-plugin/remote-models/connectors.md

Co-authored-by: Yaliang Wu <[email protected]>
Signed-off-by: Heather Halter <[email protected]>

* Fixed link formatting

Signed-off-by: Heather Halter <[email protected]>

* Update _ml-commons-plugin/remote-models/connectors.md

Co-authored-by: kolchfa-aws <[email protected]>
Signed-off-by: Heather Halter <[email protected]>

---------

Signed-off-by: Heather Halter <[email protected]>
Co-authored-by: Yaliang Wu <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
(cherry picked from commit a772802)
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
hdhalter pushed a commit that referenced this issue Mar 14, 2024
@opensearch-trigger-bot @github-actions
@ylwu-amzn @kolchfa-aws
Updates Cohere connector info in connectors.md (#6671) (#6676)
ef09c02 
* Updates Cohere connector info in connectors.md

Addresses #1 in #6648



* Added link to github



* Update _ml-commons-plugin/remote-models/connectors.md




* Fixed link formatting



* Update _ml-commons-plugin/remote-models/connectors.md




---------




(cherry picked from commit a772802)

Signed-off-by: Heather Halter <[email protected]>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Co-authored-by: Yaliang Wu <[email protected]>
Co-authored-by: kolchfa-aws <[email protected]>
@hdhalter
Copy link
Contributor

The first item is merged. I'm working with jmazane on the second item.

@hdhalter
Copy link
Contributor

@jmazanec15 - Did we address #2 above?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@hdhalter hdhalter

Labels
2 - In progress Issue/PR: The issue or PR is in progress.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@dylan-tong-aws @ylwu-amzn @hdhalter