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

feat(embeddings): Add text embedding feature #376

Merged
merged 12 commits into from
Nov 23, 2023
Merged

feat(embeddings): Add text embedding feature #376

merged 12 commits into from
Nov 23, 2023

Conversation

dandansamax
Copy link
Collaborator

Description

This PR add text embedding support, including a base embedding abstract class and OpenAI embedding APIs.

Motivation and Context

Why is this change required? What problem does it solve?
If it fixes an open issue, please link to the issue here.
You can use the syntax close #15213 if this solves the issue #15213

  • I have raised an issue to propose this change (required for new features and bug fixes)

Types of changes

What types of changes does your code introduce? Put an x in all the boxes that apply:

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds core functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation (update in the documentation)
  • Example (update in the folder of example)

Implemented Tasks

  • Subtask 1
  • Subtask 2
  • Subtask 3

Checklist

Go over all the following points, and put an x in all the boxes that apply.
If you are unsure about any of these, don't hesitate to ask. We are here to help!

  • I have read the CONTRIBUTION guide. (required)
  • My change requires a change to the documentation.
  • I have updated the tests accordingly. (required for a bug fix or a new feature)
  • I have updated the documentation accordingly.

@dandansamax dandansamax added the enhancement New feature or request label Nov 18, 2023
@dandansamax dandansamax self-assigned this Nov 18, 2023
camel/embeddings/openai_embedding.py Outdated Show resolved Hide resolved
camel/embeddings/openai_embedding.py Outdated Show resolved Hide resolved
camel/embeddings/openai_embedding.py Outdated Show resolved Hide resolved
dandansamax and others added 3 commits November 19, 2023 14:59
Co-authored-by: Zecheng Zhang <zecheng@alumni.stanford.edu>
@dandansamax dandansamax requested a review from zechengz November 19, 2023 12:42
Copy link
Member

@Wendong-Fan Wendong-Fan left a comment

Choose a reason for hiding this comment

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

Thanks for the great work~

@lightaime
Copy link
Member

Thanks! I am reviewing this PR. Please wait a bit.

Copy link
Member

@lightaime lightaime left a comment

Choose a reason for hiding this comment

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

Thanks @dandansamax. It looks great. Left a few comments.

camel/embeddings/base.py Outdated Show resolved Hide resolved
camel/embeddings/openai_embedding.py Outdated Show resolved Hide resolved
camel/embeddings/openai_embedding.py Outdated Show resolved Hide resolved
r"""Abstract base class for text embedding functionalities. """

@abstractmethod
def embed_texts(self, texts: List[str]) -> List[List[float]]:
Copy link
Member

Choose a reason for hiding this comment

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

Some embedding models are for images. We may need to consider this. Should we call it embed_queries?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

This base class is designed only for text embedding. For image embedding, we have two options: either create a separate base class specifically for image embedding or make the embed function's parameter dynamic. This would allow the program to dynamically select the appropriate overridden function during runtime.

camel/embeddings/openai_embedding.py Outdated Show resolved Hide resolved
camel/embeddings/openai_embedding.py Outdated Show resolved Hide resolved
camel/embeddings/openai_embedding.py Outdated Show resolved Hide resolved
camel/embeddings/openai_embedding.py Show resolved Hide resolved
camel/embeddings/openai_embedding.py Outdated Show resolved Hide resolved
Copy link
Member

@lightaime lightaime left a comment

Choose a reason for hiding this comment

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

Thanks for the fix! Left last comments

camel/embeddings/openai_embedding.py Outdated Show resolved Hide resolved
camel/embeddings/openai_embedding.py Outdated Show resolved Hide resolved
camel/embeddings/openai_embedding.py Outdated Show resolved Hide resolved
Copy link
Member

@lightaime lightaime left a comment

Choose a reason for hiding this comment

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

Some last minor comments. Please feel free to merge it.

camel/types/enums.py Outdated Show resolved Hide resolved
camel/utils/commons.py Show resolved Hide resolved
dandansamax and others added 2 commits November 22, 2023 17:33
Co-authored-by: Guohao Li <lightaime@gmail.com>
@lightaime lightaime merged commit e826fc3 into master Nov 23, 2023
@lightaime lightaime deleted the embeddings branch November 23, 2023 08:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: Merged or Closed
Development

Successfully merging this pull request may close these issues.

4 participants