Doc: Update README examples to prevent double-wrapping of embedding functions#2432
Merged
danielaskdd merged 3 commits intoHKUDS:mainfrom Nov 28, 2025
Merged
Doc: Update README examples to prevent double-wrapping of embedding functions#2432danielaskdd merged 3 commits intoHKUDS:mainfrom
danielaskdd merged 3 commits intoHKUDS:mainfrom
Conversation
Collaborator
Author
|
@codex review |
|
Codex Review: Didn't find any major issues. Can't wait for the next one! ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fix: Update README examples to prevent double-wrapping of embedding functions
Problem:
The
EmbeddingFunc.__call__method now contains processing logic that prevents functions from being wrapped twice. This causes issues when embedding functions already decorated with@wrap_embedding_func_with_attrsare wrapped again usingEmbeddingFunc().Root Cause:
Since
openai_embed,ollama_embed, and similar functions are already decorated with@wrap_embedding_func_with_attrs, wrapping them again withEmbeddingFunc()results in double decoration, which breaks the expected behavior.Solution:
Update all README examples that incorrectly use
EmbeddingFunc()to wrap pre-decorated embedding functions. The correct approach is to either:@wrap_embedding_func_with_attrsdecorator to create a custom embedding function that callsxxx_embed.func(the unwrapped function)LightRAGwithout additional wrappingBefore (Incorrect - Double Wrapping):
After (Correct):
Key Points:
xxx_embed.funcinstead ofxxx_embedto avoid triggering double decoration.funcattribute accesses the underlying function while preserving the built-in retry logicembedding_funcparameter without additionalEmbeddingFunc()wrapper