Skip to content

Commit

Permalink
* docs(Getting Started.ipynb): update code comments and add a tip for…
Browse files Browse the repository at this point in the history
… initializing the DefaultEmbedding class

* docs(Getting Started.ipynb): update code comments to initialize the FlagEmbedding class
  • Loading branch information
NirantK committed Aug 22, 2023
1 parent 9d51514 commit 13f5ae8
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions docs/Getting Started.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -126,14 +126,15 @@
"### Load the Embedding Model Weights\n",
"Next, initialize the Embedding class with the desired parameters. Here, \"BAAI/bge-small-en\" is the pre-trained model name, and max_length=512 is the maximum token length for each document.\n",
"\n",
"#### 💡 Tip\n",
"A model from the same family is also our Default Model, so you can also initialize the DefaultEmbedding class without any parameters:\n",
"\n",
"```python\n",
"from fastembed import DefaultEmbedding\n",
"embedding_model = DefaultEmbedding()\n",
"```\n",
"This will download the model weights, decompress to directory `local_cache` and load them into the Embedding class.\n",
"\n",
"This will download the model weights, decompress to directory `local_cache` and load them into the Embedding class."
"#### Initialize FlagEmbedding"
]
},
{
Expand All @@ -143,7 +144,7 @@
"metadata": {},
"outputs": [],
"source": [
"# Initialize the DefaultEmbedding class with the desired parameters\n",
"# Initialize the FlagEmbedding class with the desired parameters\n",
"embedding_model = Embedding(model_name=\"BAAI/bge-small-en\", max_length=512)"
]
},
Expand Down

0 comments on commit 13f5ae8

Please sign in to comment.