davidberenstein1957 HF staff commited on
Commit
f74cc7c
·
verified ·
1 Parent(s): e5c72b9

Upload README.md with huggingface_hub

Browse files
Files changed (1) hide show
  1. README.md +10 -17
README.md CHANGED
@@ -2,36 +2,29 @@
2
  tags:
3
  - vicinity
4
  - vector-store
5
- configs:
6
- - config_name: default
7
- data_files:
8
- - split: train
9
- path: data/train-*
10
- dataset_info:
11
- features:
12
- - name: name
13
- dtype: string
14
- - name: id
15
- dtype: int64
16
- splits:
17
- - name: train
18
- num_bytes: 110
19
- num_examples: 5
20
- download_size: 1170
21
- dataset_size: 110
22
  ---
23
 
24
  # Dataset Card for davidberenstein1957/my-vicinity-repo
25
 
 
 
 
 
26
  ## Usage
27
 
 
 
28
  ```python
29
  from vicinity import Vicinity
30
  vicinity = Vicinity.load_from_hub("davidberenstein1957/my-vicinity-repo")
31
  ```
32
 
 
 
33
  ## Configuration
34
 
 
 
35
  ```bash
36
  {
37
  "metadata": {},
 
2
  tags:
3
  - vicinity
4
  - vector-store
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
5
  ---
6
 
7
  # Dataset Card for davidberenstein1957/my-vicinity-repo
8
 
9
+ This dataset was created using the [vicinity](https://github.com/MinishLab/vicinity) library, a lightweight nearest neighbors library with flexible backends.
10
+
11
+ It contains a vector space with 5 items.
12
+
13
  ## Usage
14
 
15
+ You can load this dataset using the following code:
16
+
17
  ```python
18
  from vicinity import Vicinity
19
  vicinity = Vicinity.load_from_hub("davidberenstein1957/my-vicinity-repo")
20
  ```
21
 
22
+ After loading the dataset, you can use the `vicinity.query` method to find the nearest neighbors to a vector.
23
+
24
  ## Configuration
25
 
26
+ The configuration of the dataset is stored in the `config.json` file. The vector backend is stored in the `backend` folder.
27
+
28
  ```bash
29
  {
30
  "metadata": {},