RyanCodrai/turbovec:README 來源編輯指南
根據 README、倉庫資料與授權整理 RyanCodrai/turbovec 的安裝與核驗路徑。
專案定位
RyanCodrai/turbovec 的 README 將專案描述為「A vector index built on TurboQuant, written in Rust with Python bindings」。本文只整理倉庫可直接核對的內容,不把 star、Fork 或宣傳語當成品質證明。README 在「README」下寫到:A 10 million document corpus takes 31 GB of RAM as float32. turbovec fits it in 4 GB - and searches it faster than FAISS.。這說明的是專案邊界,不是已完成的生產驗證。
適用場景
從 README 的「README」與相關條目,可以先判斷它是否處理你的實際問題:Fast SIMD search. Hand-written NEON (ARM) and AVX-512BW (x86) kernels beat FAISS IndexPQFastScan by 19,31% on ARM; on x86 they win the 4-bit configs and trail by a few percent on 2-bit.。若需求不同,不應只因專案熱度就採用。本文保留原始專案名、命令與元件名,方便回到一手來源核對。 README 另外列出一項可核對的資訊:Online ingest. Add vectors, they're indexed , no train step, no parameter tuning, no rebuilds as the corpus grows.。這類原文條目可用來設計試跑步驟,但不能取代實際環境測試。
運作方式
README 將運作方式分散在「README」等段落。可確認的線索包括:Building RAG where privacy, memory, or latency matters? You're in the right place.。本文不把未寫出的架構、效能或安全邊界補成結論;真正的執行鏈仍要配合目錄、設定檔與版本標籤檢查。
安裝與第一次執行
第一次安裝應從 README 指出的入口開始。目前可核對的命令是: pip install turbovec 如果倉庫沒有命令,本文不會自行編造步驟,而是建議先閱讀「Hybrid retrieval (filtered search)」,確認系統依賴、預設埠與首次初始化。
設定與日常使用
日常使用取決於專案文件。README 的「Python」段落提到:vectors and query are 2-D float32 arrays of shape (n, dim) , other dtypes are rejected rather than silently converted, so cast with np.asarray(x, dtype=np.float32) first if needed.。設定檔、環境變數、權限與資料目錄只在來源明確時才會記錄;沒有寫出的預設值,應在測試環境驗證並保留回滾副本。 同一部分也提到:Filter at search time. Pass an id allowlist (or a slot bitmask) to search() and the kernel honours it directly. You always get up to k results from the allowed set , no over-fetching, no recall hit on selective filters.。