Skip to content

Commit

Permalink
Update Getting Started.ipynb with model information and document format
Browse files Browse the repository at this point in the history
  • Loading branch information
NirantK committed Mar 7, 2024
1 parent 49cbe9c commit e05b3c4
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion docs/Getting Started.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -150,9 +150,11 @@
"metadata": {},
"source": [
"We're using [BAAI/bge-small-en-v1.5](https://huggingface.co/BAAI/bge-small-en-v1.5) a state of the art Flag Embedding model. The model does better than OpenAI text-embedding-ada-002. We've made it even faster by converting it to ONNX format and quantizing the model for you.\n",
"\n",
"#### Format of the Document List\n",
"\n",
"1. List of Strings: Your documents must be in a list, and each document must be a string\n",
"2. For Retrieval Tasks: If you're working with queries and passages, you can add special labels to them:\n",
"2. For Retrieval Tasks with our default: If you're working with queries and passages, you can add special labels to them:\n",
"- **Queries**: Add \"query:\" at the beginning of each query string\n",
"- **Passages**: Add \"passage:\" at the beginning of each passage string\n",
"\n",
Expand Down

0 comments on commit e05b3c4

Please sign in to comment.