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

Update Prompt Usage #63

Merged
merged 2 commits into from
Mar 14, 2024
Merged

Update Prompt Usage #63

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
77bf544
Update README.md
SeanLee97 Mar 14, 2024
d307698
update prompt usage
SeanLee97 Mar 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ python -m pip install -U angle-emb

1) For Retrieval Purposes

For retrieval purposes, please use the prompt `Prompts.C`.
For retrieval purposes, please use the prompt `Prompts.C` for the query (⚠️：no need to apply prompt for documents).

```python
from angle_emb import AnglE, Prompts
Expand Down Expand Up @@ -139,7 +139,7 @@ For example, a sentence semantically similar to "How about ChatGPT?" could be "W

To distinguish between these two types of tasks, we use different prompts.

For retrieval tasks, we use the prompt "Represent this sentence for searching relevant passages: {text}" (Prompts.C in angle_emb).
For retrieval tasks, we use the prompt "Represent this sentence for searching relevant passages: {text}" (Prompts.C in angle_emb) for the query (**no need to apply it for the documents**).

For non-retrieval tasks, we set the prompt to empty, i.e., just input your text without specifying a prompt.

Expand Down
Loading