File size: 2,281 Bytes
94831b3 471a8a8 94831b3 2b0d1fd e6530b0 2b0d1fd 4798166 f8c265c 4798166 f8c265c 4798166 f8c265c 4798166 f8c265c 4798166 f8c265c 4798166 f8c265c 2b0d1fd e6530b0 2b0d1fd 7954e60 2b0d1fd 92ebc27 2b0d1fd |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 |
---
license: mit
library_name: sentence-transformers
pipeline_tag: text-retrieval
tags:
- faiss
- touchdesigner
- wiki
- rag
---
# 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.
---
## Files
- `td_index_mini_flat_l2.faiss`
- FAISS index generated using **all-MiniLM-L6-v2** embeddings (Flat L2).
- `td_metadata_mini_flat_l2.json`
- Metadata corresponding to `td_index_mini_flat_l2.faiss`.
- `td_index_mini_hnsw_l2.faiss`
- FAISS index generated using **all-MiniLM-L6-v2** embeddings (HNSW L2).
- `td_metadata_mini_hnsw_l2.json`
- Metadata corresponding to `td_index_mini_hnsw.faiss`.
- `td_index_mpnet_flat_l2.faiss`
- FAISS index generated using **all-mpnet-base-v2** embeddings (Flat L2).
- `td_metadata_mpnet_flat_l2.json`
- Metadata corresponding to `td_index_mpnet_flat_l2.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/)).
You can also try the online semantic search demo (FAISS retrieval only) here:
[TouchDesigner Wiki Search (Hugging Face Space)](https://huggingface.co/spaces/imjj/td-rag-sapce)
---
## 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.
|