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 embedding integration with Intel Gaudi in llama-index-embeddings-gaudi #16521

Merged
merged 7 commits into from
Oct 18, 2024

Conversation

jeanyu-habana
Copy link
Contributor

Description

This PR adds Intel Gaudi support to the list of llama_index embeddings integration. This enables users to run embedding models locally on Intel Gaudi using llama_index modules.

Fixes # (issue)
N/A

New Package?

Did I fill in the tool.llamahub section in the pyproject.toml and provide a detailed README.md for my new integration or package?

  • Yes
  • No

Version Bump?

Did I bump the version in the pyproject.toml file of the package I am updating? (Except for the llama-index-core package)

  • Yes
  • No

Type of Change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

Your pull-request will likely not be merged unless it is covered by some form of impactful unit testing.

  • I added new unit tests to cover this change
  • I believe this change is already covered by existing unit tests

Suggested Checklist:

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added Google Colab support for the newly added notebooks.
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I ran make format; make lint to appease the lint gods

@dosubot dosubot bot added the size:XL This PR changes 500-999 lines, ignoring generated files. label Oct 13, 2024
)


class GaudiHuggingFaceEmbeddings(HuggingFaceEmbeddings):
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is kind of un-intuitive -- can we implement the actual embedding class from llama-index right? No need to involve langhcain (You could subclass BaseEmbedding or the HuggingFaceEmbedding class from llama-index_

Copy link
Contributor Author

@jeanyu-habana jeanyu-habana Oct 17, 2024

Choose a reason for hiding this comment

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

Okay, I have just re-written the implementation to be based on BaseEmbedding of llama-index. @logan-markewich
Also removed the Instruct class from the original implementation since we are focusing on embeddings in this PR.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Thank you!

@jeanyu-habana
Copy link
Contributor Author

@logan-markewich Could you please review my updates when you have a chance? I'd appreciate it if the PR can be merged after issues are resolved. Thanks so much!

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label Oct 18, 2024
@logan-markewich logan-markewich enabled auto-merge (squash) October 18, 2024 19:06
@logan-markewich logan-markewich merged commit 4e3c37d into run-llama:main Oct 18, 2024
11 checks passed
@jeanyu-habana jeanyu-habana deleted the gaudi-embed branch October 18, 2024 20:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
lgtm This PR has been approved by a maintainer size:XL This PR changes 500-999 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants