Upload README.md with huggingface_hub

README.md

@@ -1,19 +1,34 @@
 ---
-dataset_info:
-  features:
-  - name: name
-    dtype: string
-  - name: id
-    dtype: int64
-  splits:
-  - name: train
-    num_bytes: 110
-    num_examples: 5
-  download_size: 1170
-  dataset_size: 110
-configs:
-- config_name: default
-  data_files:
-  - split: train
-    path: data/train-*
+tags:
+- vicinity
+- vector-store
 ---
+
+# Dataset Card for minishlab/my-vicinity-repo
+
+This dataset was created using the [vicinity](https://github.com/MinishLab/vicinity) library, a lightweight nearest neighbors library with flexible backends.
+
+It contains a vector space with 5 items.
+
+## Usage
+
+You can load this dataset using the following code:
+
+```python
+from vicinity import Vicinity
+vicinity = Vicinity.load_from_hub("minishlab/my-vicinity-repo")
+```
+
+After loading the dataset, you can use the `vicinity.query` method to find the nearest neighbors to a vector.
+
+## Configuration
+
+The configuration of the dataset is stored in the `config.json` file. The vector backend is stored in the `backend` folder.
+
+```bash
+{
+    "metadata": {},
+    "backend_type": "basic",
+    "model_name_or_path": "local/my-vicinity-repo"
+}
+```