Upload folder using huggingface_hub

.gitattributes

@@ -1,35 +1,39 @@
-*.7z filter=lfs diff=lfs merge=lfs -text
-*.arrow filter=lfs diff=lfs merge=lfs -text
-*.bin filter=lfs diff=lfs merge=lfs -text
-*.bz2 filter=lfs diff=lfs merge=lfs -text
-*.ckpt filter=lfs diff=lfs merge=lfs -text
-*.ftz filter=lfs diff=lfs merge=lfs -text
-*.gz filter=lfs diff=lfs merge=lfs -text
-*.h5 filter=lfs diff=lfs merge=lfs -text
-*.joblib filter=lfs diff=lfs merge=lfs -text
-*.lfs.* filter=lfs diff=lfs merge=lfs -text
-*.mlmodel filter=lfs diff=lfs merge=lfs -text
-*.model filter=lfs diff=lfs merge=lfs -text
-*.msgpack filter=lfs diff=lfs merge=lfs -text
-*.npy filter=lfs diff=lfs merge=lfs -text
-*.npz filter=lfs diff=lfs merge=lfs -text
-*.onnx filter=lfs diff=lfs merge=lfs -text
-*.ot filter=lfs diff=lfs merge=lfs -text
-*.parquet filter=lfs diff=lfs merge=lfs -text
-*.pb filter=lfs diff=lfs merge=lfs -text
-*.pickle filter=lfs diff=lfs merge=lfs -text
-*.pkl filter=lfs diff=lfs merge=lfs -text
-*.pt filter=lfs diff=lfs merge=lfs -text
-*.pth filter=lfs diff=lfs merge=lfs -text
-*.rar filter=lfs diff=lfs merge=lfs -text
-*.safetensors filter=lfs diff=lfs merge=lfs -text
-saved_model/**/* filter=lfs diff=lfs merge=lfs -text
-*.tar.* filter=lfs diff=lfs merge=lfs -text
-*.tar filter=lfs diff=lfs merge=lfs -text
-*.tflite filter=lfs diff=lfs merge=lfs -text
-*.tgz filter=lfs diff=lfs merge=lfs -text
-*.wasm filter=lfs diff=lfs merge=lfs -text
-*.xz filter=lfs diff=lfs merge=lfs -text
-*.zip filter=lfs diff=lfs merge=lfs -text
-*.zst filter=lfs diff=lfs merge=lfs -text
-*tfevents* filter=lfs diff=lfs merge=lfs -text
+*.7z filter=lfs diff=lfs merge=lfs -text
+*.arrow filter=lfs diff=lfs merge=lfs -text
+*.bin filter=lfs diff=lfs merge=lfs -text
+*.bz2 filter=lfs diff=lfs merge=lfs -text
+*.ckpt filter=lfs diff=lfs merge=lfs -text
+*.ftz filter=lfs diff=lfs merge=lfs -text
+*.gz filter=lfs diff=lfs merge=lfs -text
+*.h5 filter=lfs diff=lfs merge=lfs -text
+*.joblib filter=lfs diff=lfs merge=lfs -text
+*.lfs.* filter=lfs diff=lfs merge=lfs -text
+*.mlmodel filter=lfs diff=lfs merge=lfs -text
+*.model filter=lfs diff=lfs merge=lfs -text
+*.msgpack filter=lfs diff=lfs merge=lfs -text
+*.npy filter=lfs diff=lfs merge=lfs -text
+*.npz filter=lfs diff=lfs merge=lfs -text
+*.onnx filter=lfs diff=lfs merge=lfs -text
+*.ot filter=lfs diff=lfs merge=lfs -text
+*.parquet filter=lfs diff=lfs merge=lfs -text
+*.pb filter=lfs diff=lfs merge=lfs -text
+*.pickle filter=lfs diff=lfs merge=lfs -text
+*.pkl filter=lfs diff=lfs merge=lfs -text
+*.pt filter=lfs diff=lfs merge=lfs -text
+*.pth filter=lfs diff=lfs merge=lfs -text
+*.rar filter=lfs diff=lfs merge=lfs -text
+*.safetensors filter=lfs diff=lfs merge=lfs -text
+saved_model/**/* filter=lfs diff=lfs merge=lfs -text
+*.tar.* filter=lfs diff=lfs merge=lfs -text
+*.tar filter=lfs diff=lfs merge=lfs -text
+*.tflite filter=lfs diff=lfs merge=lfs -text
+*.tgz filter=lfs diff=lfs merge=lfs -text
+*.wasm filter=lfs diff=lfs merge=lfs -text
+*.xz filter=lfs diff=lfs merge=lfs -text
+*.zip filter=lfs diff=lfs merge=lfs -text
+*.zst filter=lfs diff=lfs merge=lfs -text
+*tfevents* filter=lfs diff=lfs merge=lfs -text
+model/td_index.faiss filter=lfs diff=lfs merge=lfs -text
+model/td_index_mini.faiss filter=lfs diff=lfs merge=lfs -text
+model/td_metadata.json filter=lfs diff=lfs merge=lfs -text
+model/td_metadata_mini.json filter=lfs diff=lfs merge=lfs -text

README.md

@@ -1,3 +1,48 @@
+# TouchDesigner RAG Wiki Index
+
+This repository contains precompiled FAISS vector indexes and metadata files built from the offline TouchDesigner wiki (`Samples/Learn/OfflineHelp`).
+
+It is intended for use in local Retrieval-Augmented Generation (RAG) systems to assist in answering TouchDesigner-related questions.
+
 ---
-license: mit
+
+## Files
+
+- `model/td_index.faiss`  
+  - FAISS index generated using **all-mpnet-base-v2** embeddings.
+- `model/td_metadata.json`  
+  - Metadata (text chunks, titles, categories) matching `td_index.faiss`.
+
+- `model/td_index_mini.faiss`  
+  - FAISS index generated using **all-MiniLM-L6-v2** embeddings.
+- `model/td_metadata_mini.json`  
+  - Metadata matching `td_index_mini.faiss`.
+
 ---
+
+## Usage
+
+You can load the FAISS indexes with `faiss.read_index` and match queries using your own embedding model or retrieval pipeline.
+
+The preprocessing, embedding, and search scripts are available at:  
+[GitHub - TouchDesigner RAG](https://github.com/cnbjjj/td-rag)
+
+> The retrieval system is typically used alongside a local LLM (e.g., via [Ollama](https://ollama.com/)).
+
+---
+
+## Notes
+
+- The offline wiki documentation was automatically chunked without extensive manual cleaning.  
+  Some redundant, outdated, or imperfect text segments may exist.
+- You are encouraged to refine the data, add external sources, or re-train indexes as needed.
+- A more curated version may be published in future updates.
+
+---
+
+## License
+
+This project is licensed under the MIT License.
+
+**Disclaimer**:  
+The offline TouchDesigner documentation remains the property of Derivative Inc. and is used here purely for educational and research purposes.

model/td_index.faiss

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

model/td_index_mini.faiss

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

model/td_metadata.json

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

model/td_metadata_mini.json

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