Commit Graph

408 Commits

Author SHA1 Message Date
NirantK
6e72ec02f7 * chore(embedding.py): reformat import statements and fix typing import order
* feat(embedding.py): add docstring to Embedding class
* feat(embedding.py): add docstring to FlagEmbedding class
2023-08-22 21:04:58 +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
72d1a1d0d7 * chore(pyproject.toml): update version from 0.0.2 to 0.0.3a0 2023-08-22 15:25:58 +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
f9ba985678 * chore(mkdocs.yml): add header.autohide and announce.dismiss to the list of enabled theme plugins 2023-08-22 14:59:26 +05:30
NirantK
11f7dd8d7e * feat(mkdocs.yml): add logo to material theme configuration 2023-08-22 14:57:38 +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
bd06e3d932 * chore(.gitignore): add docs/local_cache/*/* to ignore list 2023-08-22 11:10:11 +05:30
NirantK
88d92ff596 * docs(index.md): update documentation to reflect changes in FastEmbed library 2023-08-21 19:49:08 +05:30
NirantK
c8c4d212cb * chore(mkdocs.yml): add support for mermaid code blocks in markdown using pymdownx.superfences plugin 2023-08-21 19:48:28 +05:30
NirantK
a9542a8d8c * docs(Usage.ipynb): rename file to Getting Started.ipynb
* feat(Getting Started.ipynb): add introductory markdown cell with instructions for using the fastembed package
2023-08-21 19:23:21 +05:30
NirantK
86c93be5fc * docs(Usage.ipynb): rename file from nbs/02_Usage.ipynb to docs/Usage.ipynb 2023-08-21 19:19:19 +05:30
NirantK
40a7c7c21a * chore(mkdocs.yml): add mknotebooks plugin configuration
* - Set execute to false
* - Set timeout to 100
* - Set allow_errors to false
* - Add tag_remove_configs:
* - Set remove_cell_tags to ["Remove_cell"]
* - Set remove_all
2023-08-21 19:18:47 +05:30
NirantK
472057abf3 * chore(ci.yml): add mknotebooks package to pip install command 2023-08-21 19:17:14 +05:30
NirantK
5dbefc6a7c * chore(pyproject.toml): add mknotebooks dependency 2023-08-21 19:16:58 +05:30
NirantK
1eb7afa6ac * feat(mkdocs.yml): add additional features to the theme configuration
* - search.suggest
* - search.highlight
* - navigation.instant
* - navigation.tracking
* - navigation.expand
* - navigation.sections
* - content.code.annotate
* - toc.follow
2023-08-21 19:02:34 +05:30
NirantK
df37667689 * chore(main.html): fix formatting and indentation in the main.html file 2023-08-21 18:56:11 +05:30
NirantK
97fa834c5b * chore(ci.yml): add additional dependencies for mkdocs deployment
* chore(dev-requirements.txt): remove unused dependencies
2023-08-21 18:53:51 +05:30
NirantK
c9f3853519 hash locks 2023-08-21 18:51:46 +05:30
NirantK
bcc2769bdb * chore(main.html): remove unnecessary span tag and class attribute from Discord server link 2023-08-21 18:49:15 +05:30
NirantK
7126f096e4 * chore(pyproject.toml): add pillow and cairosvg dependencies 2023-08-21 18:49:07 +05:30
NirantK
226a94a75a * feat(mkdocs.yml): add accent color and text color for primary color in the material theme 2023-08-21 18:48:13 +05:30
NirantK
98da066bc9 * chore(pyproject.toml): add mkdocstrings as a dependency
* chore(pyproject.toml): update mkdocs-material version to ^9.1.21
2023-08-21 18:37:47 +05:30
NirantK
88a70bfa9d * chore(mkdocs.yml): add site_url, site_author, repo_url, repo_name, remote_branch, remote_name, and copyright information
* docs(mkdocs.yml): update theme custom_dir to docs/overrides
2023-08-21 18:34:42 +05:30
NirantK
f894f4ad1e * chore(mkdocs.yml): add custom_dir option to material theme configuration 2023-08-21 18:34:31 +05:30
NirantK
f6722a0326 * chore(main.html): remove commented out code block 2023-08-21 18:31:34 +05:30
NirantK
6f94b3f748 * chore(static.yml): remove static.yml workflow file 2023-08-21 18:10:27 +05:30
Nirant
913f0fc350 Create static.yml 2023-08-21 18:06:54 +05:30
Nirant
6275f17298 Merge pull request #2 from qdrant/docs-init
* feat(docs): add initial documentation files
2023-08-21 18:04:49 +05:30
NirantK
51b6b5082c add mkdocs 2023-08-21 18:01:31 +05:30
NirantK
e2d7bd3902 Merge branch 'main' into docs-init 2023-08-21 17:58:11 +05:30
NirantK
0d6f313f30 * feat(docs): add initial documentation files
* feat(docs): add override for main.html template
2023-08-21 17:51:29 +05:30
NirantK
49aa267d05 * feat(ci.yml): add CI workflow for continuous integration
*
* This commit adds a new file `.github/workflows/ci.yml` which contains the configuration for the CI workflow. The workflow is triggered on push events to the `master` and `main` branches. It runs on an Ubuntu environment and consists
2023-08-21 17:51:19 +05:30
NirantK
ee0e6a0011 * feat(mkdocs.yml): add mkdocs.yml configuration file with site name, theme, and markdown extensions 2023-08-21 17:51:13 +05:30
NirantK
7c13395c96 * chore(pyproject.toml): add mkdocs-material as a dev dependency 2023-08-21 17:29:49 +05:30
Nirant
4a381e03b9 Merge pull request #1 from qdrant/refactoring
refactoring
2023-08-18 14:35:25 +05:30
generall
770beb1023 refactoring 2023-08-18 01:36:36 +02:00
NirantK
29834997ad * feat(02_Usage.ipynb): update examples
* feat(02_Usage.ipynb): add comment to clarify casting generator to a list
2023-08-17 16:36:55 +05:30
NirantK
52d03a3db3 * chore(02_Usage.ipynb): update notebook with installation of fastembed package 2023-08-17 16:35:34 +05:30
NirantK
bc9416aad1 Refactor for readability 2023-08-17 12:48:19 +05:30