Commit Graph

56 Commits

Author SHA1 Message Date
Rishav Dash
bcf3cee8b8 Updated the hyperlink for "Retrieval with FastEmbed"
prev -: https://qdrant.github.io/fastembed/examples/Retrieval%20with%20FastEmbed/

now -: https://qdrant.github.io/fastembed/examples/Retrieval_with_FastEmbed/
2023-09-03 13:37:14 +05:30
NirantK
728ac49a91 * docs(experimental): update headings in Binary Quantization.ipyn, add emoji everywhere 2023-08-25 14:11:03 +05:30
NirantK
3d1b80e9de * docs(experimental): fix typo in Binary Quantization.ipynb
* chore(experimental): update description of binary transformation step
2023-08-25 14:06:16 +05:30
NirantK
86e3b12e84 Improved readability 2023-08-25 14:05:21 +05:30
NirantK
e62ed5edb2 * chore(docs): rename "Binary Quantisation.ipynb" to "Binary Quantization.ipynb"
* docs(experimental/Binary Quantization.ipynb): update markdown headings
* docs(experimental/Binary Quantization.ipynb): update markdown heading for loading data
2023-08-25 13:58:45 +05:30
NirantK
ee87685fa5 * docs(experimental): add table with sampling rate, limit, and accuracy for binary quantisation 2023-08-25 13:54:36 +05:30
NirantK
750c9b340e * chore(Binary Quantisation.ipynb): update execution counts to null
* refactor(Binary Quantisation.ipynb): remove unnecessary outputs
2023-08-25 13:54:31 +05:30
NirantK
5a16ce8c63 * chore(docs): rename notebook files
* - Rename '03_HF_vs_FastEmbed.ipynb' to 'HF_vs_FastEmbed.ipynb'
* - Rename '01_Retrieval_with_FastEmbed.ipynb' to 'Retrieval_with_FastEmbed
2023-08-25 13:41:32 +05:30
NirantK
5f229b2bc3 Binary Quantisation 2023-08-25 13:40:23 +05:30
NirantK
743a095a93 * chore(docs): update HF_vs_FastEmbed.ipynb and 04_1M_Embedding_Creation.ipynb
*
* HF_vs_FastEmbed.ipynb:
* - Add code to calculate embeddings using mean pooling with attention weighting
* - Fix variable name error in line 4
*
*
2023-08-25 12:59:22 +05:30
NirantK
1bd639b817 * chore(docs): rename 02_Usage_with_Qdrant.ipynb to FastEmbed_Usage_with_Qdrant.ipynb in the experimental folder 2023-08-25 12:56:38 +05:30
NirantK
ac0f3315ed Cleaner notebook 2023-08-25 01:06:24 +05:30
NirantK
135a4524ac * refactor(docs/examples): rename files for better organization and numbering
* rename(docs/examples): Rename 'Retrieval with FastEmbed.ipynb' to '01_Retrieval_with_FastEmbed.ipynb'
* rename(docs/examples): Rename 'Usage with Qdrant.ipynb
2023-08-25 00:57:39 +05:30
NirantK
2f0e9a8507 * feat(examples): add 1M Embedding Creation notebook 2023-08-25 00:54:23 +05:30
NirantK
7479640a7b * (feat) HFvsFastEmbed.ipynb: Add new nb example 2023-08-25 00:54:18 +05:30
NirantK
38d449ba71 * chore(docs): fix formatting and remove extra newlines in Retrieval with FastEmbed.ipynb and Usage with Qdrant.ipynb examples 2023-08-25 00:38:54 +05:30
NirantK
64bd1d2ff8 * chore(docs): fix formatting in Getting Started.ipynb
* refactor(docs): improve code readability in Getting Started.ipynb
2023-08-25 00:38:36 +05:30
NirantK
2427fa1d69 * docs(index.md): add link to advanced user guide for retrieval with FastEmbed 2023-08-24 23:45:35 +05:30
NirantK
53ce38c736 * docs(index.md): update documentation to remove outdated information and provide accurate description of FastEmbed library and installation process 2023-08-24 23:37:25 +05:30
NirantK
a9c7378b67 * docs: update README.md and index.md with example link for Retrieval Embedding Generation 2023-08-24 20:29:55 +05:30
NirantK
42b50200c3 * docs(index.md): remove duplicate sentence about default embedding support 2023-08-24 20:28:45 +05:30
NirantK
bd0fd1f7e9 * chore(docs): update Getting Started.ipynb
* - Change section title from "What is happening under the hood?" to "Let's think step by step"
* - Add a new subsection titled "Setup"
* - Update the description in the code block from "FlagEmbedding" to
2023-08-24 17:05:46 +05:30
NirantK
32f204cc7b Remove outputs 2023-08-24 16:50:17 +05:30
NirantK
2a56e17f1e * chore(docs): update Getting Started.ipynb
* - Update execution count for code cells
* - Add output for code cells
* - Update package installation command
* - Update import statement for embedding class
* - Update model name in embedding initialization
* - Remove unnecessary tip section
2023-08-24 16:49:57 +05:30
NirantK
88b595f3ec * chore: update project description in pyproject.toml
* docs: update project description in README.md and docs/index.md
2023-08-24 13:16:46 +05:30
NirantK
4a25dd4240 * chore(Usage with Qdrant.ipynb): update notebook title and add note about experimental status
* chore(Usage with Qdrant.ipynb): update installation instructions for fastembed and qdrant-client
2023-08-23 18:31:48 +05:30
NirantK
bb87a61f92 * feat(Usage with Qdrant.ipynb): add output of document ids after adding documents to collection
* docs(Usage with Qdrant.ipynb): add explanation for document ids
2023-08-23 13:12:50 +05:30
NirantK
52747aa64e * feat(Usage with Qdrant.ipynb): add Usage with Qdrant notebook example 2023-08-23 12:52:38 +05:30
NirantK
43e8f9678f * docs(examples/Retrieval with FastEmbed.ipynb): update tip message to include headings for query and passage embeddings 2023-08-23 12:52:22 +05:30
NirantK
cf0e2023f5 * docs(examples): rename 01_Retrieval.ipynb to Retrieval with FastEmbed.ipynb 2023-08-23 11:21:44 +05:30
NirantK
9fc1f1447d * fix(docs): update example notebook for retrieval with FastEmbed 2023-08-23 11:19:19 +05:30
NirantK
ba5ada631a * feat(docs): add example notebook for retrieval with FastEmbed and Qdrant 2023-08-23 11:18:05 +05:30
NirantK
eb2317f425 * chore(docs): update comments in Getting Started.ipynb
* fix(embedding.py): update method names in FlagEmbedding and OpenAIEmbedding
2023-08-23 09:51:38 +05:30
NirantK
2017fdc22a * fix(docs): change method name from encode to embed in DefaultEmbedding class
* fix(README.md): change method name from encode to embed in Embedding class
* fix(docs/Getting Started.ipynb): change method name from encode to embed in Embedding class
2023-08-23 09:49:48 +05:30
NirantK
3d76875c5d * fix(index.md): fix typo in embedding_model variable name from DeafultEmbedding to DefaultEmbedding 2023-08-22 21:29:56 +05:30
NirantK
13f5ae8b56 * docs(Getting Started.ipynb): update code comments and add a tip for initializing the DefaultEmbedding class
* docs(Getting Started.ipynb): update code comments to initialize the FlagEmbedding class
2023-08-22 21:14:33 +05:30
NirantK
b0f8a33a4f * docs(Getting Started.ipynb): add instructions for initializing DefaultEmbedding class without parameters 2023-08-22 21:02:25 +05:30
NirantK
38fc2940b8 * docs(Getting Started.ipynb): fix formatting and punctuation in the document list section 2023-08-22 21:02:17 +05:30
NirantK
22a8260c1a * docs(Getting Started.ipynb): update installation instructions and quick start guide
* docs(Getting Started.ipynb): update section headings and explanations
* docs(Getting Started.ipynb): update section heading and explanation
2023-08-22 20:53:22 +05:30
NirantK
0e039e503c * chore(docs): update example list of documents to encode in Getting Started.ipynb
* - Change the first document from "query: Hello, World!" to "passage: Hello, World!"
* - Add a new document "query: Hello, World!" as a separate embedding
2023-08-22 15:26:22 +05:30
NirantK
5b48fce67e * chore(docs/index.md): fix typo in DefaultEmbedding import statement
* feat(docs/index.md): update example passage in documents list
* docs(docs/index.md): add comment about leaving out prefix in documents list
2023-08-22 15:26:04 +05:30
NirantK
b1449eddaa * docs(Getting Started.ipynb): update title to include emoji and change "Getting Started" to " Getting Started"
* docs(index.md): update title to include emoji and update description to include "retrieval augmented generation" and mention support for
2023-08-22 15:02:46 +05:30
NirantK
9aebfb8913 * chore(favicon.png): rename favicon.png to assets/favicon.png 2023-08-22 15:00:57 +05:30
NirantK
17ccc3a8aa * feat(docs): add favicon.png image to the docs/img directory 2023-08-22 14:56:12 +05:30
NirantK
c3023112a8 * chore(docs/index.md): update example documents and comments in code
* feat(docs/index.md): add support for passage and query prefixes in example documents
2023-08-22 14:52:43 +05:30
NirantK
9a944e4d70 * docs(index.md): remove unnecessary heading and update installation instructions
* fix(docs/index.md): remove unnecessary heading
* docs(index.md): update installation instructions
2023-08-22 14:52:35 +05:30
NirantK
e9efa037f3 * docs(Getting Started.ipynb): remove unnecessary code execution outputs 2023-08-22 11:15:33 +05:30
NirantK
479aee5f32 * docs(Getting Started.ipynb): update documentation for preparing documents
* - Add information about the format of the list of documents
* - Specify that documents must be strings
* - Provide instructions for working with queries and passages in retrieval tasks
2023-08-22 11:12:14 +05:30
NirantK
7a23b15c0b * feat(Getting Started.ipynb): add guide 2023-08-22 11:10:53 +05:30
NirantK
88d92ff596 * docs(index.md): update documentation to reflect changes in FastEmbed library 2023-08-21 19:49:08 +05:30