Ash Vardanian commited on
Commit
f550ce9
·
1 Parent(s): 9c9f4cb

Improve: Document multi-mirror fetch paths and add HF metadata

Browse files
Files changed (1) hide show
  1. README.md +52 -8
README.md CHANGED
@@ -1,3 +1,7 @@
 
 
 
 
1
  # WikiVerse
2
 
3
  Multi-model embedding dataset built on [HuggingFace FineWiki](https://huggingface.co/datasets/HuggingFaceFW/finewiki), designed for approximate nearest neighbor (ANN) search benchmarking with [USearch](https://github.com/unum-cloud/usearch) and other vector search engines.
@@ -128,29 +132,69 @@ unum-cloud/WikiVerse/
128
  ├── e5-mistral-7b-instruct/ # 4096-dim, decoder, float16 (planned)
129
  │ └── <wiki>/<group>_<shard>.{body,title}.f16bin
130
 
131
- └── gte-moderncolbert-v1/ # 128-dim per token, ColBERT (planned)
132
  └── <wiki>/<group>_<shard>.{body,title}.f16bin
133
  ```
134
 
135
- Binary embedding files are tracked via [Git LFS](https://git-lfs.com).
136
- To clone the repo without downloading the binaries (~600 GB):
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
137
 
138
  ```sh
139
- GIT_LFS_SKIP_SMUDGE=1 git clone https://huggingface.co/datasets/unum-cloud/WikiVerse
 
 
140
  ```
141
 
142
- Load embeddings for a single language (Python):
143
 
144
  ```python
145
  from wikiverse import read_bin
146
- mat = read_bin("qwen3-embedding-0.6b/enwiki/000_00000.body.f16bin", dtype="f16")
147
- # mat.shape == (n_articles_in_shard, 1024)
148
  ```
149
 
150
  Or pull just one model's embeddings for a single language:
151
 
152
  ```sh
153
- huggingface-cli download unum-cloud/WikiVerse \
154
  --repo-type dataset \
155
  --include "qwen3-embedding-0.6b/enwiki/*"
156
  ```
 
1
+ ---
2
+ license: apache-2.0
3
+ ---
4
+
5
  # WikiVerse
6
 
7
  Multi-model embedding dataset built on [HuggingFace FineWiki](https://huggingface.co/datasets/HuggingFaceFW/finewiki), designed for approximate nearest neighbor (ANN) search benchmarking with [USearch](https://github.com/unum-cloud/usearch) and other vector search engines.
 
132
  ├── e5-mistral-7b-instruct/ # 4096-dim, decoder, float16 (planned)
133
  │ └── <wiki>/<group>_<shard>.{body,title}.f16bin
134
 
135
+ └── gte-moderncolbert-v1/ # 128-dim per token, ColBERT (planned)
136
  └── <wiki>/<group>_<shard>.{body,title}.f16bin
137
  ```
138
 
139
+ ## Downloading
140
+
141
+ WikiVerse lives on three coordinated mirrors, all sharing the same single-branch Git history:
142
+
143
+ | Mirror | Holds | Best for |
144
+ | :------------------ | :----------------------------- | :------------------------------- |
145
+ | HuggingFace Hub | code + LFS bytes (canonical) | `git clone`, `hf` CLI, streaming |
146
+ | GitHub | code + LFS pointers (no bytes) | reading the code, contributing |
147
+ | Nebius S3 | flat byte mirror of LFS blobs | bulk downloads, batch jobs |
148
+
149
+ `.f16bin` files are tracked via [Git LFS](https://git-lfs.com); on GitHub, the LFS server is rerouted to HuggingFace, so GitHub clones receive only ~200-byte pointer files.
150
+
151
+ ### From HuggingFace
152
+
153
+ The default and the simplest path — full code, full data, single command:
154
+
155
+ ```sh
156
+ git clone https://huggingface.co/datasets/ashvardanian/WikiVerse
157
+ ```
158
+
159
+ To skip the ~600 GB of binaries and get only code + pointers:
160
+
161
+ ```sh
162
+ GIT_LFS_SKIP_SMUDGE=1 git clone https://huggingface.co/datasets/ashvardanian/WikiVerse
163
+ ```
164
+
165
+ ### From GitHub
166
+
167
+ The GitHub repo holds only code and LFS pointers; the actual binaries live on HuggingFace. After cloning, point Git LFS at HuggingFace and pull:
168
+
169
+ ```sh
170
+ git clone https://github.com/ashvardanian/WikiVerse
171
+ cd WikiVerse
172
+ git config lfs.url https://huggingface.co/datasets/ashvardanian/WikiVerse.git/info/lfs
173
+ git lfs pull
174
+ ```
175
+
176
+ ### From Nebius S3
177
+
178
+ The fastest path for bulk downloads — pulls byte-identical LFS objects directly from object storage, then materializes the `.f16bin` files into the working tree:
179
 
180
  ```sh
181
+ aws s3 sync s3://wikiverse/lfs/ ./.git/lfs/objects/ \
182
+ --endpoint-url https://storage.us-central1.nebius.cloud
183
+ git lfs checkout
184
  ```
185
 
186
+ ### Loading embeddings in Python
187
 
188
  ```python
189
  from wikiverse import read_bin
190
+ matrix = read_bin("qwen3-embedding-0.6b/enwiki/000_00000.body.f16bin", dtype="f16")
191
+ # matrix.shape == (rows_in_shard, 1024)
192
  ```
193
 
194
  Or pull just one model's embeddings for a single language:
195
 
196
  ```sh
197
+ hf download ashvardanian/WikiVerse \
198
  --repo-type dataset \
199
  --include "qwen3-embedding-0.6b/enwiki/*"
200
  ```