Skip to content

Commit 07f0b8f

Browse files
authored
feat: Fixed mypy issues, updated test vicinity hub repo (#61)
* Changed test vicinity hub repo and docstring * Refactored hub logic * Refactored hub logic * Removed test since it was dependent on internet connection * Updated readme * Updated readme * Updated readme * Resolved comments * Update
1 parent e15511d commit 07f0b8f

5 files changed

Lines changed: 1141 additions & 169 deletions

File tree

README.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -92,11 +92,11 @@ vicinity.save('my_vector_store')
9292
vicinity = Vicinity.load('my_vector_store')
9393
```
9494

95-
Pushing and loading a vector store from the Hugging Face Hub:
95+
Pushing and loading a vector store from the Hugging Face Hub (note that you can optionally add the model used for generating embeddings to the metadata, e.g. `vicinity.metadata["model"] = "minishlab/potion-base-8M"`):
9696

9797
```python
98-
vicinity.push_to_hub(model_name_or_path='my_vector_store', repo_id='my_vector_store')
99-
vicinity = Vicinity.load_from_hub(repo_id='my_vector_store')
98+
vicinity.push_to_hub(repo_id='minishlab/my-vicinity-repo')
99+
vicinity = Vicinity.load_from_hub(repo_id='minishlab/my-vicinity-repo')
100100
```
101101

102102
Evaluating a backend:
@@ -118,6 +118,7 @@ Vicinity provides the following features:
118118
- Lightweight: Minimal dependencies and fast performance.
119119
- Flexible Backend Support: Use different backends for vector storage and search.
120120
- Serialization: Save and load vector stores for persistence.
121+
- HuggingFace Hub Integration: Push and load vector stores directly to and from the HuggingFace Hub.
121122
- Evaluation: Easily evaluate the performance of different backends.
122123
- Easy to Use: Simple and intuitive API.
123124

tests/integrations/test_huggingface.py

Lines changed: 0 additions & 33 deletions
This file was deleted.

0 commit comments

Comments
 (0)