Upload folder using huggingface_hub

.gitattributes

@@ -58,3 +58,8 @@ saved_model/**/* filter=lfs diff=lfs merge=lfs -text
 # Video files - compressed
 *.mp4 filter=lfs diff=lfs merge=lfs -text
 *.webm filter=lfs diff=lfs merge=lfs -text
+data/index.sqlite filter=lfs diff=lfs merge=lfs -text
+data/vectors/index.faiss filter=lfs diff=lfs merge=lfs -text
+data/vectors/vectors.f32 filter=lfs diff=lfs merge=lfs -text
+extra/extra.sqlite filter=lfs diff=lfs merge=lfs -text
+extra/vectors/vectors.f32 filter=lfs diff=lfs merge=lfs -text

README.md

@@ -1,3 +1,113 @@
 ---
-license: mit
+language:
+  - en
+tags:
+  - 3d
+  - text-retrieval
+  - asset-metadata
+  - sqlite
+  - faiss
 ---
+
+# ObjectAtlas Data
+
+A prebuilt asset index and vector library for searching individual 3D objects with natural language. Descriptions from Cap3D, MARVEL-40M+, and TRELLIS-500K are grouped by asset, preserving their annotation sources and original fields.
+
+This bundle contains metadata and description embeddings. Model files can be obtained through the download locations stored in the asset records.
+
+## Contents
+
+| File | Purpose | Size |
+|---|---|---:|
+| `data/index.sqlite` | Asset metadata, captions, and vector ID mappings | 13.17 GiB |
+| `data/vectors/index.faiss` | FAISS index for description retrieval | 1.43 GiB |
+| `data/vectors/vectors.f32` | Full precision description vectors for reranking | 39.46 GiB |
+| `extra/extra.sqlite` | Extra asset metadata, archive manifest, and vector ID mappings | 0.14 GiB |
+| `extra/vectors/vectors.f32` | Precomputed description vectors for extra assets | 0.29 GiB |
+
+The five files total approximately **54.49 GiB**. Keep each collection's metadata and vector files together to preserve their ID mappings.
+
+| Collection | Assets | Description vectors |
+|---|---:|---:|
+| Main database | 1,842,649 | 13,792,908 |
+| Extra database | 10,840 | 102,896 |
+
+```text
+artifacts/
+  README.md
+  data/
+    index.sqlite
+    vectors/
+      index.faiss
+      vectors.f32
+  extra/
+    extra.sqlite
+    vectors/
+      vectors.f32
+```
+
+## Use with ObjectAtlas
+
+Place this bundle under the ObjectAtlas code directory as `artifacts/`, keeping the layout above. Install the dependencies listed in the code project's `requirements.txt`, then run from that project directory:
+
+```bash
+python scripts/search.py --text "a wooden dining chair" --top-k 10
+```
+
+If the data is stored elsewhere, use `--data` to specify the directory containing `data/`. Search results contain the asset record, similarity score, and best matching caption. The code project's README describes all search parameters.
+
+The first text query may download the encoder. After it is cached, `--local-files-only` enables offline queries.
+
+## Asset metadata
+
+The `assets` table in `data/index.sqlite` contains five fields:
+
+| Field | Description |
+|---|---|
+| `uuid` | Stable local asset identifier |
+| `source_dataset` | Original asset dataset, such as `objaverse`, `objaverse_xl`, or `abo` |
+| `original_id` | Original model ID, stored as a string with leading zeros and case preserved |
+| `captions` | Descriptions grouped under `cap3d`, `marvel_40m_plus`, and `trellis_500k`; each item contains `text` and the original `field` |
+| `download_urls` | Individual asset file locations |
+
+`captions` and `download_urls` are stored as JSON text in SQLite. Missing caption sources use empty lists. The search script decodes these fields into objects and arrays.
+
+Assets are matched by their confirmed original dataset and model identity. Similar captions, names, or categories do not establish asset identity. A single asset can have multiple description vectors, and search returns each asset once using its highest matching score.
+
+## Vector format
+
+| Setting | Value |
+|---|---|
+| Encoder | `sentence-transformers/all-mpnet-base-v2` |
+| Model revision | `e8c3b32edf5434bc2275fc9bab85f82640a19130` |
+| Dimensions | `768` |
+| Maximum sequence length | `384` tokens |
+| Normalization | Unit length |
+| Raw format | Headerless, row-major, little-endian float32 (`<f4`) |
+| Similarity | Cosine similarity |
+
+The SQLite caption table and vector segment metadata link vector IDs to assets and their descriptions. Use the supplied search script to retrieve candidates from FAISS and rerank them with the full precision vectors.
+
+## Optional extra data
+
+The main database can be searched independently. The included extra collection supports Toys4k, OmniObject3D, and selected ShapeNet categories whose models are distributed in archives.
+
+To install extra assets, use the code project's `extra/run_extra.py` to download official archives, extract them, verify local assets, and merge passing records and their vectors into the main database. Original extra records are retained. Merged file locations use `file://` URLs computed for the user's machine.
+
+## Sources and licenses
+
+Descriptions come from [Cap3D](https://huggingface.co/datasets/tiange/Cap3D), [MARVEL-40M+](https://huggingface.co/datasets/sankalpsinha77/MARVEL-40M), and [TRELLIS-500K](https://huggingface.co/datasets/JeffreyXiang/TRELLIS-500K).
+
+| Original asset source | Official resource |
+|---|---|
+| Objaverse / Objaverse-XL | [Objaverse](https://objaverse.allenai.org/), [Objaverse-XL metadata](https://huggingface.co/datasets/allenai/objaverse-xl) |
+| ABO | [Amazon Berkeley Objects](https://amazon-berkeley-objects.s3.amazonaws.com/index.html) |
+| GSO | [Google Scanned Objects](https://research.google/blog/scanned-objects-by-google-research-a-dataset-of-3d-scanned-common-household-items/) |
+| HSSD | [HSSD models](https://huggingface.co/datasets/hssd/hssd-models) |
+| ShapeNet | [ShapeNetCore v2](https://huggingface.co/datasets/ShapeNet/ShapeNetCore), [ShapeNetCore GLB](https://huggingface.co/datasets/ShapeNet/shapenetcore-glb) |
+| Toys4k (extra) | [Official project](https://github.com/rehg-lab/lowshot-shapebias/tree/main/toys4k) |
+| OmniObject3D (extra) | [Official project](https://github.com/omniobject3d/OmniObject3D), [OpenXLab](https://openxlab.org.cn/datasets/omniobject3d/OmniObject3D-New) |
+
+The MIT license for ObjectAtlas runtime code does not replace the licenses of the underlying data. Metadata, descriptions, models, and vectors remain subject to the applicable source licenses and attribution requirements. Cap3D annotations are listed under ODC-By, MARVEL under CC BY-NC-SA 4.0, and TRELLIS metadata under MIT; original models remain subject to their publishers' and authors' terms.
+
+Review source licenses before using or redistributing this bundle, including any noncommercial restrictions and attribution requirements. Users are responsible for obtaining access to restricted sources such as ShapeNet and the official Toys4k downloads.

data/index.sqlite

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:c86534dbfa75889f822fcea7bd7e1ccdadafbfbb85188d883b37e74459b80b99
+size 14140379136

data/vectors/index.faiss

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:6e297212ac44a70d989d7fb6c7b2453826034fb2dada6d3589d0732545b6d0e8
+size 1536174484

data/vectors/vectors.f32

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:563f9802ee82893c4b665d80081ca108241197d7617d10319812736cc8a89070
+size 42371813376

extra/extra.sqlite

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:b66e02f4a65a8575041e1aa5b06f32c7cd8fb1671f90bf8d6945d4440f8e9baf
+size 146235392

extra/vectors/vectors.f32

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:64866ba981c4c3f2ae90afc8b15640e58d61f3c48cdeb91ba055d3683e279702
+size 316096512