@r1z4x/tezgah 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +738 -0
- package/LICENSE +21 -0
- package/MANIFEST +753 -0
- package/README.de.md +169 -0
- package/README.es.md +168 -0
- package/README.fr.md +166 -0
- package/README.md +161 -0
- package/README.tr.md +163 -0
- package/agents/tezgah-reviewer.md +70 -0
- package/bin/codegen +337 -0
- package/bin/consult +797 -0
- package/bin/tezgah-adhd +50 -0
- package/bin/tezgah-agents +45 -0
- package/bin/tezgah-capture +66 -0
- package/bin/tezgah-context +96 -0
- package/bin/tezgah-decisions +213 -0
- package/bin/tezgah-design +953 -0
- package/bin/tezgah-docs +1199 -0
- package/bin/tezgah-doctor +497 -0
- package/bin/tezgah-dsh +37 -0
- package/bin/tezgah-dsh.cmd +70 -0
- package/bin/tezgah-gate +75 -0
- package/bin/tezgah-import-ai-research +439 -0
- package/bin/tezgah-index +32 -0
- package/bin/tezgah-lessons +148 -0
- package/bin/tezgah-mcp +322 -0
- package/bin/tezgah-migrate +324 -0
- package/bin/tezgah-pony +50 -0
- package/bin/tezgah-research +772 -0
- package/bin/tezgah-rollback +93 -0
- package/bin/tezgah-route +124 -0
- package/bin/tezgah-setup +5798 -0
- package/bin/tezgah-status +383 -0
- package/bin/tezgah-task +607 -0
- package/bin/tezgah-taste +423 -0
- package/bin/tezgah-triage +485 -0
- package/bin/tezgah.js +36 -0
- package/commands/adhd.md +21 -0
- package/commands/ponytail.md +21 -0
- package/docs/README.md +112 -0
- package/docs/architecture.md +226 -0
- package/docs/citations-baseline.json +59 -0
- package/docs/clarity-baseline.json +116 -0
- package/docs/contract.md +416 -0
- package/docs/environment.md +141 -0
- package/docs/evidence.md +831 -0
- package/docs/feature-audit.md +139 -0
- package/docs/gate.md +407 -0
- package/docs/glossary.md +201 -0
- package/docs/hosts.md +400 -0
- package/docs/index.json +471 -0
- package/docs/judge.md +193 -0
- package/docs/layers.md +189 -0
- package/docs/models.md +160 -0
- package/docs/operations.md +666 -0
- package/docs/research.md +809 -0
- package/docs/results/paired-outcome-2026-10.jsonl +254 -0
- package/docs/results/paired-outcome-2026-10.md +204 -0
- package/docs/skills.md +236 -0
- package/docs/status-line.md +315 -0
- package/docs/testing.md +287 -0
- package/docs/vision.md +117 -0
- package/hooks/hooks.json +33 -0
- package/hooks/projects-auto-init.py +98 -0
- package/hooks/projects-posttooluse.py +149 -0
- package/hooks/projects-pretooluse.py +40 -0
- package/hooks/projects-stop.py +60 -0
- package/hooks/tezgah_agents.py +817 -0
- package/hooks/tezgah_apps.py +266 -0
- package/hooks/tezgah_attest.py +255 -0
- package/hooks/tezgah_clarity.py +171 -0
- package/hooks/tezgah_components.py +140 -0
- package/hooks/tezgah_context.py +2953 -0
- package/hooks/tezgah_embed.py +765 -0
- package/hooks/tezgah_gate.py +2736 -0
- package/hooks/tezgah_guard.py +177 -0
- package/hooks/tezgah_index.py +124 -0
- package/hooks/tezgah_integrity.py +5141 -0
- package/hooks/tezgah_judge.py +487 -0
- package/hooks/tezgah_lang.py +230 -0
- package/hooks/tezgah_lessons.py +210 -0
- package/hooks/tezgah_models.py +855 -0
- package/hooks/tezgah_paths.py +1132 -0
- package/hooks/tezgah_policy.py +1039 -0
- package/hooks/tezgah_rank.py +77 -0
- package/hooks/tezgah_replay.py +1109 -0
- package/hooks/tezgah_research.py +5176 -0
- package/hooks/tezgah_shapes.py +305 -0
- package/hooks/tezgah_skill_pick.py +227 -0
- package/hooks/tezgah_snapshot.py +490 -0
- package/hooks/tezgah_stopspec.py +320 -0
- package/hooks/tezgah_task.py +458 -0
- package/hooks/tezgah_taste.py +201 -0
- package/hooks/tezgah_untrusted.py +112 -0
- package/hooks/tezgah_update.py +430 -0
- package/hosts/codex/hook.py +268 -0
- package/hosts/codex/hooks.json +26 -0
- package/hosts/cursor/hook.py +461 -0
- package/hosts/cursor/hooks.json +44 -0
- package/hosts/dsh/hooks.json +21 -0
- package/hosts/dsh/statusline/lib/client.js +138 -0
- package/hosts/dsh/statusline/lib/index.js +104 -0
- package/hosts/dsh/statusline/package.json +28 -0
- package/hosts/omp/hook.py +277 -0
- package/hosts/omp/tezgah-hook.ts.in +701 -0
- package/hosts/opencode/plugins/tezgah.js +2742 -0
- package/hosts/opencode/tui/tezgah-tui.tsx +151 -0
- package/output-styles/tezgah.md +142 -0
- package/package.json +32 -0
- package/packaging/build.sh +342 -0
- package/packaging/install.ps1 +166 -0
- package/packaging/install.sh +56 -0
- package/packaging/upgrade.sh +142 -0
- package/skills/ai-research/0-autoresearch-skill/SKILL.md +411 -0
- package/skills/ai-research/0-autoresearch-skill/references/agent-continuity.md +95 -0
- package/skills/ai-research/0-autoresearch-skill/references/progress-reporting.md +166 -0
- package/skills/ai-research/0-autoresearch-skill/references/skill-routing.md +219 -0
- package/skills/ai-research/0-autoresearch-skill/templates/findings.md +44 -0
- package/skills/ai-research/0-autoresearch-skill/templates/research-log.md +41 -0
- package/skills/ai-research/01-model-architecture/litgpt/SKILL.md +469 -0
- package/skills/ai-research/01-model-architecture/litgpt/references/custom-models.md +569 -0
- package/skills/ai-research/01-model-architecture/litgpt/references/distributed-training.md +452 -0
- package/skills/ai-research/01-model-architecture/litgpt/references/supported-models.md +337 -0
- package/skills/ai-research/01-model-architecture/litgpt/references/training-recipes.md +620 -0
- package/skills/ai-research/01-model-architecture/mamba/SKILL.md +260 -0
- package/skills/ai-research/01-model-architecture/mamba/references/architecture-details.md +207 -0
- package/skills/ai-research/01-model-architecture/mamba/references/benchmarks.md +256 -0
- package/skills/ai-research/01-model-architecture/mamba/references/training-guide.md +389 -0
- package/skills/ai-research/01-model-architecture/nanogpt/SKILL.md +290 -0
- package/skills/ai-research/01-model-architecture/nanogpt/references/architecture.md +383 -0
- package/skills/ai-research/01-model-architecture/nanogpt/references/data.md +477 -0
- package/skills/ai-research/01-model-architecture/nanogpt/references/training.md +565 -0
- package/skills/ai-research/01-model-architecture/rwkv/SKILL.md +260 -0
- package/skills/ai-research/01-model-architecture/rwkv/references/architecture-details.md +345 -0
- package/skills/ai-research/01-model-architecture/rwkv/references/rwkv7.md +387 -0
- package/skills/ai-research/01-model-architecture/rwkv/references/state-management.md +370 -0
- package/skills/ai-research/01-model-architecture/torchtitan/SKILL.md +358 -0
- package/skills/ai-research/01-model-architecture/torchtitan/references/checkpoint.md +182 -0
- package/skills/ai-research/01-model-architecture/torchtitan/references/custom-models.md +259 -0
- package/skills/ai-research/01-model-architecture/torchtitan/references/float8.md +134 -0
- package/skills/ai-research/01-model-architecture/torchtitan/references/fsdp.md +127 -0
- package/skills/ai-research/02-tokenization/huggingface-tokenizers/SKILL.md +516 -0
- package/skills/ai-research/02-tokenization/huggingface-tokenizers/references/algorithms.md +654 -0
- package/skills/ai-research/02-tokenization/huggingface-tokenizers/references/integration.md +638 -0
- package/skills/ai-research/02-tokenization/huggingface-tokenizers/references/pipeline.md +724 -0
- package/skills/ai-research/02-tokenization/huggingface-tokenizers/references/training.md +566 -0
- package/skills/ai-research/02-tokenization/sentencepiece/SKILL.md +235 -0
- package/skills/ai-research/02-tokenization/sentencepiece/references/algorithms.md +201 -0
- package/skills/ai-research/02-tokenization/sentencepiece/references/training.md +305 -0
- package/skills/ai-research/03-fine-tuning/axolotl/SKILL.md +158 -0
- package/skills/ai-research/03-fine-tuning/axolotl/references/api.md +5549 -0
- package/skills/ai-research/03-fine-tuning/axolotl/references/dataset-formats.md +1030 -0
- package/skills/ai-research/03-fine-tuning/axolotl/references/index.md +16 -0
- package/skills/ai-research/03-fine-tuning/axolotl/references/other.md +3564 -0
- package/skills/ai-research/03-fine-tuning/llama-factory/SKILL.md +80 -0
- package/skills/ai-research/03-fine-tuning/llama-factory/references/_images.md +24 -0
- package/skills/ai-research/03-fine-tuning/llama-factory/references/advanced.md +1056 -0
- package/skills/ai-research/03-fine-tuning/llama-factory/references/getting_started.md +350 -0
- package/skills/ai-research/03-fine-tuning/llama-factory/references/index.md +20 -0
- package/skills/ai-research/03-fine-tuning/llama-factory/references/other.md +32 -0
- package/skills/ai-research/03-fine-tuning/peft/SKILL.md +431 -0
- package/skills/ai-research/03-fine-tuning/peft/references/advanced-usage.md +515 -0
- package/skills/ai-research/03-fine-tuning/peft/references/troubleshooting.md +481 -0
- package/skills/ai-research/03-fine-tuning/unsloth/SKILL.md +80 -0
- package/skills/ai-research/03-fine-tuning/unsloth/references/index.md +8 -0
- package/skills/ai-research/03-fine-tuning/unsloth/references/llms.md +83 -0
- package/skills/ai-research/04-mechanistic-interpretability/nnsight/SKILL.md +436 -0
- package/skills/ai-research/04-mechanistic-interpretability/nnsight/references/README.md +79 -0
- package/skills/ai-research/04-mechanistic-interpretability/nnsight/references/api.md +345 -0
- package/skills/ai-research/04-mechanistic-interpretability/nnsight/references/tutorials.md +301 -0
- package/skills/ai-research/04-mechanistic-interpretability/pyvene/SKILL.md +473 -0
- package/skills/ai-research/04-mechanistic-interpretability/pyvene/references/README.md +74 -0
- package/skills/ai-research/04-mechanistic-interpretability/pyvene/references/api.md +384 -0
- package/skills/ai-research/04-mechanistic-interpretability/pyvene/references/tutorials.md +377 -0
- package/skills/ai-research/04-mechanistic-interpretability/saelens/SKILL.md +386 -0
- package/skills/ai-research/04-mechanistic-interpretability/saelens/references/README.md +71 -0
- package/skills/ai-research/04-mechanistic-interpretability/saelens/references/api.md +334 -0
- package/skills/ai-research/04-mechanistic-interpretability/saelens/references/tutorials.md +319 -0
- package/skills/ai-research/04-mechanistic-interpretability/transformer-lens/SKILL.md +346 -0
- package/skills/ai-research/04-mechanistic-interpretability/transformer-lens/references/README.md +55 -0
- package/skills/ai-research/04-mechanistic-interpretability/transformer-lens/references/api.md +363 -0
- package/skills/ai-research/04-mechanistic-interpretability/transformer-lens/references/tutorials.md +340 -0
- package/skills/ai-research/05-data-processing/nemo-curator/SKILL.md +383 -0
- package/skills/ai-research/05-data-processing/nemo-curator/references/deduplication.md +88 -0
- package/skills/ai-research/05-data-processing/nemo-curator/references/filtering.md +103 -0
- package/skills/ai-research/05-data-processing/ray-data/SKILL.md +326 -0
- package/skills/ai-research/05-data-processing/ray-data/references/integration.md +83 -0
- package/skills/ai-research/05-data-processing/ray-data/references/transformations.md +84 -0
- package/skills/ai-research/06-post-training/grpo-rl-training/README.md +98 -0
- package/skills/ai-research/06-post-training/grpo-rl-training/SKILL.md +572 -0
- package/skills/ai-research/06-post-training/miles/SKILL.md +315 -0
- package/skills/ai-research/06-post-training/miles/references/api-reference.md +142 -0
- package/skills/ai-research/06-post-training/miles/references/troubleshooting.md +353 -0
- package/skills/ai-research/06-post-training/openrlhf/SKILL.md +249 -0
- package/skills/ai-research/06-post-training/openrlhf/references/algorithm-comparison.md +405 -0
- package/skills/ai-research/06-post-training/openrlhf/references/custom-rewards.md +531 -0
- package/skills/ai-research/06-post-training/openrlhf/references/hybrid-engine.md +288 -0
- package/skills/ai-research/06-post-training/openrlhf/references/multi-node-training.md +455 -0
- package/skills/ai-research/06-post-training/simpo/SKILL.md +219 -0
- package/skills/ai-research/06-post-training/simpo/references/datasets.md +479 -0
- package/skills/ai-research/06-post-training/simpo/references/hyperparameters.md +453 -0
- package/skills/ai-research/06-post-training/simpo/references/loss-functions.md +351 -0
- package/skills/ai-research/06-post-training/slime/SKILL.md +464 -0
- package/skills/ai-research/06-post-training/slime/references/api-reference.md +393 -0
- package/skills/ai-research/06-post-training/slime/references/troubleshooting.md +387 -0
- package/skills/ai-research/06-post-training/torchforge/SKILL.md +433 -0
- package/skills/ai-research/06-post-training/torchforge/references/api-reference.md +328 -0
- package/skills/ai-research/06-post-training/torchforge/references/troubleshooting.md +410 -0
- package/skills/ai-research/06-post-training/trl-fine-tuning/SKILL.md +455 -0
- package/skills/ai-research/06-post-training/trl-fine-tuning/references/dpo-variants.md +228 -0
- package/skills/ai-research/06-post-training/trl-fine-tuning/references/online-rl.md +83 -0
- package/skills/ai-research/06-post-training/trl-fine-tuning/references/reward-modeling.md +123 -0
- package/skills/ai-research/06-post-training/trl-fine-tuning/references/sft-training.md +169 -0
- package/skills/ai-research/06-post-training/verl/SKILL.md +391 -0
- package/skills/ai-research/06-post-training/verl/references/api-reference.md +302 -0
- package/skills/ai-research/06-post-training/verl/references/troubleshooting.md +392 -0
- package/skills/ai-research/07-safety-alignment/constitutional-ai/SKILL.md +290 -0
- package/skills/ai-research/07-safety-alignment/llamaguard/SKILL.md +337 -0
- package/skills/ai-research/07-safety-alignment/nemo-guardrails/SKILL.md +297 -0
- package/skills/ai-research/07-safety-alignment/prompt-guard/SKILL.md +312 -0
- package/skills/ai-research/08-distributed-training/accelerate/SKILL.md +332 -0
- package/skills/ai-research/08-distributed-training/accelerate/references/custom-plugins.md +454 -0
- package/skills/ai-research/08-distributed-training/accelerate/references/megatron-integration.md +490 -0
- package/skills/ai-research/08-distributed-training/accelerate/references/performance.md +526 -0
- package/skills/ai-research/08-distributed-training/deepspeed/SKILL.md +141 -0
- package/skills/ai-research/08-distributed-training/deepspeed/references/08.md +18 -0
- package/skills/ai-research/08-distributed-training/deepspeed/references/09.md +174 -0
- package/skills/ai-research/08-distributed-training/deepspeed/references/2020.md +379 -0
- package/skills/ai-research/08-distributed-training/deepspeed/references/2023.md +280 -0
- package/skills/ai-research/08-distributed-training/deepspeed/references/assets.md +180 -0
- package/skills/ai-research/08-distributed-training/deepspeed/references/index.md +36 -0
- package/skills/ai-research/08-distributed-training/deepspeed/references/mii.md +119 -0
- package/skills/ai-research/08-distributed-training/deepspeed/references/other.md +1192 -0
- package/skills/ai-research/08-distributed-training/megatron-core/SKILL.md +366 -0
- package/skills/ai-research/08-distributed-training/megatron-core/references/benchmarks.md +250 -0
- package/skills/ai-research/08-distributed-training/megatron-core/references/parallelism-guide.md +405 -0
- package/skills/ai-research/08-distributed-training/megatron-core/references/production-examples.md +474 -0
- package/skills/ai-research/08-distributed-training/megatron-core/references/training-recipes.md +548 -0
- package/skills/ai-research/08-distributed-training/pytorch-fsdp2/SKILL.md +231 -0
- package/skills/ai-research/08-distributed-training/pytorch-fsdp2/references/pytorch_dcp_async_recipe.md +14 -0
- package/skills/ai-research/08-distributed-training/pytorch-fsdp2/references/pytorch_dcp_overview.md +19 -0
- package/skills/ai-research/08-distributed-training/pytorch-fsdp2/references/pytorch_dcp_recipe.md +18 -0
- package/skills/ai-research/08-distributed-training/pytorch-fsdp2/references/pytorch_ddp_notes.md +10 -0
- package/skills/ai-research/08-distributed-training/pytorch-fsdp2/references/pytorch_device_mesh_tutorial.md +22 -0
- package/skills/ai-research/08-distributed-training/pytorch-fsdp2/references/pytorch_examples_fsdp2.md +15 -0
- package/skills/ai-research/08-distributed-training/pytorch-fsdp2/references/pytorch_fsdp1_api.md +9 -0
- package/skills/ai-research/08-distributed-training/pytorch-fsdp2/references/pytorch_fsdp2_tutorial.md +45 -0
- package/skills/ai-research/08-distributed-training/pytorch-fsdp2/references/pytorch_fully_shard_api.md +49 -0
- package/skills/ai-research/08-distributed-training/pytorch-fsdp2/references/pytorch_tp_tutorial.md +22 -0
- package/skills/ai-research/08-distributed-training/pytorch-fsdp2/references/ray_train_fsdp2_example.md +13 -0
- package/skills/ai-research/08-distributed-training/pytorch-fsdp2/references/torchtitan_fsdp_notes.md +14 -0
- package/skills/ai-research/08-distributed-training/pytorch-lightning/SKILL.md +346 -0
- package/skills/ai-research/08-distributed-training/pytorch-lightning/references/callbacks.md +437 -0
- package/skills/ai-research/08-distributed-training/pytorch-lightning/references/distributed.md +491 -0
- package/skills/ai-research/08-distributed-training/pytorch-lightning/references/hyperparameter-tuning.md +557 -0
- package/skills/ai-research/08-distributed-training/ray-train/SKILL.md +406 -0
- package/skills/ai-research/08-distributed-training/ray-train/references/multi-node.md +629 -0
- package/skills/ai-research/09-infrastructure/lambda-labs/SKILL.md +545 -0
- package/skills/ai-research/09-infrastructure/lambda-labs/references/advanced-usage.md +612 -0
- package/skills/ai-research/09-infrastructure/lambda-labs/references/troubleshooting.md +531 -0
- package/skills/ai-research/09-infrastructure/modal/SKILL.md +341 -0
- package/skills/ai-research/09-infrastructure/modal/references/advanced-usage.md +504 -0
- package/skills/ai-research/09-infrastructure/modal/references/troubleshooting.md +495 -0
- package/skills/ai-research/09-infrastructure/skypilot/SKILL.md +509 -0
- package/skills/ai-research/09-infrastructure/skypilot/references/advanced-usage.md +492 -0
- package/skills/ai-research/09-infrastructure/skypilot/references/troubleshooting.md +571 -0
- package/skills/ai-research/10-optimization/awq/SKILL.md +310 -0
- package/skills/ai-research/10-optimization/awq/references/advanced-usage.md +325 -0
- package/skills/ai-research/10-optimization/awq/references/troubleshooting.md +345 -0
- package/skills/ai-research/10-optimization/bitsandbytes/SKILL.md +411 -0
- package/skills/ai-research/10-optimization/bitsandbytes/references/memory-optimization.md +522 -0
- package/skills/ai-research/10-optimization/bitsandbytes/references/qlora-training.md +522 -0
- package/skills/ai-research/10-optimization/bitsandbytes/references/quantization-formats.md +448 -0
- package/skills/ai-research/10-optimization/flash-attention/SKILL.md +367 -0
- package/skills/ai-research/10-optimization/flash-attention/references/benchmarks.md +216 -0
- package/skills/ai-research/10-optimization/flash-attention/references/transformers-integration.md +294 -0
- package/skills/ai-research/10-optimization/gguf/SKILL.md +427 -0
- package/skills/ai-research/10-optimization/gguf/references/advanced-usage.md +505 -0
- package/skills/ai-research/10-optimization/gguf/references/troubleshooting.md +443 -0
- package/skills/ai-research/10-optimization/gptq/SKILL.md +450 -0
- package/skills/ai-research/10-optimization/gptq/references/calibration.md +338 -0
- package/skills/ai-research/10-optimization/gptq/references/integration.md +130 -0
- package/skills/ai-research/10-optimization/gptq/references/troubleshooting.md +96 -0
- package/skills/ai-research/10-optimization/hqq/SKILL.md +445 -0
- package/skills/ai-research/10-optimization/hqq/references/advanced-usage.md +529 -0
- package/skills/ai-research/10-optimization/hqq/references/troubleshooting.md +504 -0
- package/skills/ai-research/10-optimization/ml-training-recipes/SKILL.md +319 -0
- package/skills/ai-research/10-optimization/ml-training-recipes/references/architecture.md +320 -0
- package/skills/ai-research/10-optimization/ml-training-recipes/references/biomedical.md +498 -0
- package/skills/ai-research/10-optimization/ml-training-recipes/references/domain-specific.md +626 -0
- package/skills/ai-research/10-optimization/ml-training-recipes/references/experiment-loop.md +129 -0
- package/skills/ai-research/10-optimization/ml-training-recipes/references/optimizers.md +330 -0
- package/skills/ai-research/10-optimization/ml-training-recipes/references/scaling-and-selection.md +428 -0
- package/skills/ai-research/11-evaluation/bigcode-evaluation-harness/SKILL.md +405 -0
- package/skills/ai-research/11-evaluation/bigcode-evaluation-harness/references/benchmarks.md +394 -0
- package/skills/ai-research/11-evaluation/bigcode-evaluation-harness/references/custom-tasks.md +425 -0
- package/skills/ai-research/11-evaluation/bigcode-evaluation-harness/references/issues.md +395 -0
- package/skills/ai-research/11-evaluation/lm-evaluation-harness/SKILL.md +490 -0
- package/skills/ai-research/11-evaluation/lm-evaluation-harness/references/api-evaluation.md +491 -0
- package/skills/ai-research/11-evaluation/lm-evaluation-harness/references/benchmark-guide.md +489 -0
- package/skills/ai-research/11-evaluation/lm-evaluation-harness/references/custom-tasks.md +603 -0
- package/skills/ai-research/11-evaluation/lm-evaluation-harness/references/distributed-eval.md +520 -0
- package/skills/ai-research/11-evaluation/nemo-evaluator/SKILL.md +494 -0
- package/skills/ai-research/11-evaluation/nemo-evaluator/references/adapter-system.md +341 -0
- package/skills/ai-research/11-evaluation/nemo-evaluator/references/configuration.md +448 -0
- package/skills/ai-research/11-evaluation/nemo-evaluator/references/custom-benchmarks.md +316 -0
- package/skills/ai-research/11-evaluation/nemo-evaluator/references/execution-backends.md +362 -0
- package/skills/ai-research/12-inference-serving/llama-cpp/SKILL.md +258 -0
- package/skills/ai-research/12-inference-serving/llama-cpp/references/optimization.md +90 -0
- package/skills/ai-research/12-inference-serving/llama-cpp/references/quantization.md +214 -0
- package/skills/ai-research/12-inference-serving/llama-cpp/references/server.md +126 -0
- package/skills/ai-research/12-inference-serving/sglang/SKILL.md +442 -0
- package/skills/ai-research/12-inference-serving/sglang/references/deployment.md +491 -0
- package/skills/ai-research/12-inference-serving/sglang/references/radix-attention.md +414 -0
- package/skills/ai-research/12-inference-serving/sglang/references/structured-generation.md +542 -0
- package/skills/ai-research/12-inference-serving/tensorrt-llm/SKILL.md +187 -0
- package/skills/ai-research/12-inference-serving/tensorrt-llm/references/multi-gpu.md +299 -0
- package/skills/ai-research/12-inference-serving/tensorrt-llm/references/optimization.md +243 -0
- package/skills/ai-research/12-inference-serving/tensorrt-llm/references/serving.md +471 -0
- package/skills/ai-research/12-inference-serving/vllm/SKILL.md +364 -0
- package/skills/ai-research/12-inference-serving/vllm/references/optimization.md +227 -0
- package/skills/ai-research/12-inference-serving/vllm/references/quantization.md +285 -0
- package/skills/ai-research/12-inference-serving/vllm/references/server-deployment.md +256 -0
- package/skills/ai-research/12-inference-serving/vllm/references/troubleshooting.md +448 -0
- package/skills/ai-research/13-mlops/mlflow/SKILL.md +704 -0
- package/skills/ai-research/13-mlops/mlflow/references/deployment.md +745 -0
- package/skills/ai-research/13-mlops/mlflow/references/model-registry.md +771 -0
- package/skills/ai-research/13-mlops/mlflow/references/tracking.md +681 -0
- package/skills/ai-research/13-mlops/swanlab/SKILL.md +406 -0
- package/skills/ai-research/13-mlops/swanlab/references/integrations.md +305 -0
- package/skills/ai-research/13-mlops/swanlab/references/visualization.md +234 -0
- package/skills/ai-research/13-mlops/tensorboard/SKILL.md +629 -0
- package/skills/ai-research/13-mlops/tensorboard/references/integrations.md +639 -0
- package/skills/ai-research/13-mlops/tensorboard/references/profiling.md +546 -0
- package/skills/ai-research/13-mlops/tensorboard/references/visualization.md +621 -0
- package/skills/ai-research/13-mlops/weights-and-biases/SKILL.md +590 -0
- package/skills/ai-research/13-mlops/weights-and-biases/references/artifacts.md +585 -0
- package/skills/ai-research/13-mlops/weights-and-biases/references/integrations.md +701 -0
- package/skills/ai-research/13-mlops/weights-and-biases/references/sweeps.md +848 -0
- package/skills/ai-research/14-agents/a-evolve/SKILL.md +383 -0
- package/skills/ai-research/14-agents/a-evolve/references/README.md +831 -0
- package/skills/ai-research/14-agents/a-evolve/references/api.md +594 -0
- package/skills/ai-research/14-agents/a-evolve/references/architecture.md +417 -0
- package/skills/ai-research/14-agents/a-evolve/references/design-patterns.md +462 -0
- package/skills/ai-research/14-agents/a-evolve/references/examples.md +352 -0
- package/skills/ai-research/14-agents/a-evolve/references/issues.md +591 -0
- package/skills/ai-research/14-agents/a-evolve/references/releases.md +112 -0
- package/skills/ai-research/14-agents/a-evolve/references/tutorials.md +819 -0
- package/skills/ai-research/14-agents/autogpt/SKILL.md +403 -0
- package/skills/ai-research/14-agents/autogpt/references/advanced-usage.md +536 -0
- package/skills/ai-research/14-agents/autogpt/references/troubleshooting.md +421 -0
- package/skills/ai-research/14-agents/crewai/SKILL.md +498 -0
- package/skills/ai-research/14-agents/crewai/references/flows.md +439 -0
- package/skills/ai-research/14-agents/crewai/references/tools.md +430 -0
- package/skills/ai-research/14-agents/crewai/references/troubleshooting.md +481 -0
- package/skills/ai-research/14-agents/langchain/SKILL.md +480 -0
- package/skills/ai-research/14-agents/langchain/references/agents.md +500 -0
- package/skills/ai-research/14-agents/langchain/references/integration.md +563 -0
- package/skills/ai-research/14-agents/langchain/references/rag.md +601 -0
- package/skills/ai-research/14-agents/llamaindex/SKILL.md +569 -0
- package/skills/ai-research/14-agents/llamaindex/references/agents.md +84 -0
- package/skills/ai-research/14-agents/llamaindex/references/data_connectors.md +109 -0
- package/skills/ai-research/14-agents/llamaindex/references/query_engines.md +407 -0
- package/skills/ai-research/15-rag/chroma/SKILL.md +406 -0
- package/skills/ai-research/15-rag/chroma/references/integration.md +39 -0
- package/skills/ai-research/15-rag/faiss/SKILL.md +221 -0
- package/skills/ai-research/15-rag/faiss/references/index_types.md +281 -0
- package/skills/ai-research/15-rag/pinecone/SKILL.md +358 -0
- package/skills/ai-research/15-rag/pinecone/references/deployment.md +182 -0
- package/skills/ai-research/15-rag/qdrant/SKILL.md +493 -0
- package/skills/ai-research/15-rag/qdrant/references/advanced-usage.md +649 -0
- package/skills/ai-research/15-rag/qdrant/references/troubleshooting.md +632 -0
- package/skills/ai-research/15-rag/sentence-transformers/SKILL.md +255 -0
- package/skills/ai-research/15-rag/sentence-transformers/references/models.md +124 -0
- package/skills/ai-research/16-prompt-engineering/dspy/SKILL.md +590 -0
- package/skills/ai-research/16-prompt-engineering/dspy/references/examples.md +664 -0
- package/skills/ai-research/16-prompt-engineering/dspy/references/modules.md +476 -0
- package/skills/ai-research/16-prompt-engineering/dspy/references/optimizers.md +567 -0
- package/skills/ai-research/16-prompt-engineering/guidance/SKILL.md +572 -0
- package/skills/ai-research/16-prompt-engineering/guidance/references/backends.md +555 -0
- package/skills/ai-research/16-prompt-engineering/guidance/references/constraints.md +675 -0
- package/skills/ai-research/16-prompt-engineering/guidance/references/examples.md +768 -0
- package/skills/ai-research/16-prompt-engineering/instructor/SKILL.md +740 -0
- package/skills/ai-research/16-prompt-engineering/instructor/references/examples.md +108 -0
- package/skills/ai-research/16-prompt-engineering/instructor/references/providers.md +71 -0
- package/skills/ai-research/16-prompt-engineering/instructor/references/validation.md +607 -0
- package/skills/ai-research/16-prompt-engineering/outlines/SKILL.md +652 -0
- package/skills/ai-research/16-prompt-engineering/outlines/references/backends.md +616 -0
- package/skills/ai-research/16-prompt-engineering/outlines/references/examples.md +774 -0
- package/skills/ai-research/16-prompt-engineering/outlines/references/json_generation.md +653 -0
- package/skills/ai-research/17-observability/langsmith/SKILL.md +422 -0
- package/skills/ai-research/17-observability/langsmith/references/advanced-usage.md +549 -0
- package/skills/ai-research/17-observability/langsmith/references/troubleshooting.md +538 -0
- package/skills/ai-research/17-observability/phoenix/SKILL.md +475 -0
- package/skills/ai-research/17-observability/phoenix/references/advanced-usage.md +620 -0
- package/skills/ai-research/17-observability/phoenix/references/troubleshooting.md +539 -0
- package/skills/ai-research/18-multimodal/audiocraft/SKILL.md +564 -0
- package/skills/ai-research/18-multimodal/audiocraft/references/advanced-usage.md +667 -0
- package/skills/ai-research/18-multimodal/audiocraft/references/troubleshooting.md +505 -0
- package/skills/ai-research/18-multimodal/blip-2/SKILL.md +564 -0
- package/skills/ai-research/18-multimodal/blip-2/references/advanced-usage.md +681 -0
- package/skills/ai-research/18-multimodal/blip-2/references/troubleshooting.md +527 -0
- package/skills/ai-research/18-multimodal/clip/SKILL.md +253 -0
- package/skills/ai-research/18-multimodal/clip/references/applications.md +208 -0
- package/skills/ai-research/18-multimodal/cosmos-policy/SKILL.md +402 -0
- package/skills/ai-research/18-multimodal/cosmos-policy/references/libero-commands.md +175 -0
- package/skills/ai-research/18-multimodal/cosmos-policy/references/robocasa-commands.md +147 -0
- package/skills/ai-research/18-multimodal/llava/SKILL.md +304 -0
- package/skills/ai-research/18-multimodal/llava/references/training.md +198 -0
- package/skills/ai-research/18-multimodal/openpi/SKILL.md +480 -0
- package/skills/ai-research/18-multimodal/openpi/references/checkpoints-and-env-map.md +86 -0
- package/skills/ai-research/18-multimodal/openpi/references/config-recipes.md +50 -0
- package/skills/ai-research/18-multimodal/openpi/references/pytorch-gotchas.md +49 -0
- package/skills/ai-research/18-multimodal/openpi/references/remote-client-pattern.md +48 -0
- package/skills/ai-research/18-multimodal/openpi/references/training-debugging.md +46 -0
- package/skills/ai-research/18-multimodal/openvla-oft/SKILL.md +441 -0
- package/skills/ai-research/18-multimodal/openvla-oft/references/aloha-workflow.md +141 -0
- package/skills/ai-research/18-multimodal/openvla-oft/references/config-troubleshooting.md +97 -0
- package/skills/ai-research/18-multimodal/openvla-oft/references/libero-workflow.md +115 -0
- package/skills/ai-research/18-multimodal/openvla-oft/references/paper-and-checkpoints.md +84 -0
- package/skills/ai-research/18-multimodal/segment-anything/SKILL.md +500 -0
- package/skills/ai-research/18-multimodal/segment-anything/references/advanced-usage.md +590 -0
- package/skills/ai-research/18-multimodal/segment-anything/references/troubleshooting.md +485 -0
- package/skills/ai-research/18-multimodal/stable-diffusion/SKILL.md +519 -0
- package/skills/ai-research/18-multimodal/stable-diffusion/references/advanced-usage.md +717 -0
- package/skills/ai-research/18-multimodal/stable-diffusion/references/troubleshooting.md +556 -0
- package/skills/ai-research/18-multimodal/whisper/SKILL.md +317 -0
- package/skills/ai-research/18-multimodal/whisper/references/languages.md +190 -0
- package/skills/ai-research/19-emerging-techniques/knowledge-distillation/SKILL.md +458 -0
- package/skills/ai-research/19-emerging-techniques/knowledge-distillation/references/minillm.md +335 -0
- package/skills/ai-research/19-emerging-techniques/long-context/SKILL.md +536 -0
- package/skills/ai-research/19-emerging-techniques/long-context/references/extension_methods.md +469 -0
- package/skills/ai-research/19-emerging-techniques/long-context/references/fine_tuning.md +612 -0
- package/skills/ai-research/19-emerging-techniques/long-context/references/rope.md +403 -0
- package/skills/ai-research/19-emerging-techniques/model-merging/SKILL.md +497 -0
- package/skills/ai-research/19-emerging-techniques/model-merging/references/coefficient-tuning.md +415 -0
- package/skills/ai-research/19-emerging-techniques/model-merging/references/evaluation.md +463 -0
- package/skills/ai-research/19-emerging-techniques/model-merging/references/examples.md +429 -0
- package/skills/ai-research/19-emerging-techniques/model-merging/references/methods.md +353 -0
- package/skills/ai-research/19-emerging-techniques/model-pruning/SKILL.md +495 -0
- package/skills/ai-research/19-emerging-techniques/model-pruning/references/wanda.md +348 -0
- package/skills/ai-research/19-emerging-techniques/moe-training/SKILL.md +526 -0
- package/skills/ai-research/19-emerging-techniques/moe-training/references/architectures.md +433 -0
- package/skills/ai-research/19-emerging-techniques/moe-training/references/inference.md +349 -0
- package/skills/ai-research/19-emerging-techniques/moe-training/references/training.md +426 -0
- package/skills/ai-research/19-emerging-techniques/speculative-decoding/SKILL.md +467 -0
- package/skills/ai-research/19-emerging-techniques/speculative-decoding/references/lookahead.md +310 -0
- package/skills/ai-research/19-emerging-techniques/speculative-decoding/references/medusa.md +351 -0
- package/skills/ai-research/20-ml-paper-writing/academic-plotting/SKILL.md +479 -0
- package/skills/ai-research/20-ml-paper-writing/academic-plotting/references/data-visualization.md +509 -0
- package/skills/ai-research/20-ml-paper-writing/academic-plotting/references/diagram-generation.md +395 -0
- package/skills/ai-research/20-ml-paper-writing/academic-plotting/references/style-guide.md +305 -0
- package/skills/ai-research/20-ml-paper-writing/ml-paper-writing/SKILL.md +982 -0
- package/skills/ai-research/20-ml-paper-writing/ml-paper-writing/references/checklists.md +348 -0
- package/skills/ai-research/20-ml-paper-writing/ml-paper-writing/references/citation-workflow.md +563 -0
- package/skills/ai-research/20-ml-paper-writing/ml-paper-writing/references/reviewer-guidelines.md +349 -0
- package/skills/ai-research/20-ml-paper-writing/ml-paper-writing/references/sources.md +165 -0
- package/skills/ai-research/20-ml-paper-writing/ml-paper-writing/references/writing-guide.md +477 -0
- package/skills/ai-research/20-ml-paper-writing/presenting-conference-talks/SKILL.md +298 -0
- package/skills/ai-research/20-ml-paper-writing/presenting-conference-talks/references/slide-templates.md +505 -0
- package/skills/ai-research/20-ml-paper-writing/systems-paper-writing/SKILL.md +270 -0
- package/skills/ai-research/20-ml-paper-writing/systems-paper-writing/references/checklist.md +279 -0
- package/skills/ai-research/20-ml-paper-writing/systems-paper-writing/references/reviewer-guidelines.md +116 -0
- package/skills/ai-research/20-ml-paper-writing/systems-paper-writing/references/section-blueprints.md +400 -0
- package/skills/ai-research/20-ml-paper-writing/systems-paper-writing/references/systems-conferences.md +261 -0
- package/skills/ai-research/20-ml-paper-writing/systems-paper-writing/references/writing-patterns.md +231 -0
- package/skills/ai-research/21-research-ideation/brainstorming-research-ideas/SKILL.md +384 -0
- package/skills/ai-research/21-research-ideation/creative-thinking-for-research/SKILL.md +366 -0
- package/skills/ai-research/22-agent-native-research-artifact/compiler/SKILL.md +245 -0
- package/skills/ai-research/22-agent-native-research-artifact/compiler/references/ara-schema.md +439 -0
- package/skills/ai-research/22-agent-native-research-artifact/compiler/references/exploration-tree-spec.md +125 -0
- package/skills/ai-research/22-agent-native-research-artifact/compiler/references/validation-checklist.md +149 -0
- package/skills/ai-research/22-agent-native-research-artifact/research-manager/SKILL.md +324 -0
- package/skills/ai-research/22-agent-native-research-artifact/research-manager/references/event-taxonomy.md +124 -0
- package/skills/ai-research/22-agent-native-research-artifact/research-manager/references/provenance-tags.md +190 -0
- package/skills/ai-research/22-agent-native-research-artifact/research-manager/references/session-protocol.md +162 -0
- package/skills/ai-research/22-agent-native-research-artifact/rigor-reviewer/SKILL.md +322 -0
- package/skills/ai-research/22-agent-native-research-artifact/rigor-reviewer/references/review-dimensions.md +182 -0
- package/skills/ai-research/SKILL.md +101 -0
- package/skills/ai-research/SOURCE +38 -0
- package/skills/ai-research/index/1-frame.md +18 -0
- package/skills/ai-research/index/2-data.md +21 -0
- package/skills/ai-research/index/3-train.md +48 -0
- package/skills/ai-research/index/4-measure.md +25 -0
- package/skills/ai-research/index/5-run.md +23 -0
- package/skills/ai-research/index/6-write.md +35 -0
- package/skills/ai-research/library.json +3456 -0
- package/skills/analyze-app/EVALS.md +82 -0
- package/skills/analyze-app/SKILL.md +188 -0
- package/skills/design-contract/EVALS.md +80 -0
- package/skills/design-contract/SKILL.md +171 -0
- package/skills/design-library/EVALS.md +85 -0
- package/skills/design-library/INDEX.md +59 -0
- package/skills/design-library/SKILL.md +58 -0
- package/skills/design-library/SOURCE +131 -0
- package/skills/design-library/adaptive-interfaces/skills/colour-independence/SKILL.md +90 -0
- package/skills/design-library/adaptive-interfaces/skills/flexible-typography/SKILL.md +83 -0
- package/skills/design-library/adaptive-interfaces/skills/information-density/SKILL.md +87 -0
- package/skills/design-library/adaptive-interfaces/skills/preference-audit/SKILL.md +70 -0
- package/skills/design-library/adaptive-interfaces/skills/responsive-accessibility/SKILL.md +86 -0
- package/skills/design-library/adaptive-interfaces/skills/responsive-review/SKILL.md +76 -0
- package/skills/design-library/adaptive-interfaces/skills/simplified-views/SKILL.md +97 -0
- package/skills/design-library/adaptive-interfaces/skills/specify/SKILL.md +63 -0
- package/skills/design-library/adaptive-interfaces/skills/user-preference-respect/SKILL.md +100 -0
- package/skills/design-library/cognitive-accessibility/skills/adaptive-personalisation/SKILL.md +61 -0
- package/skills/design-library/cognitive-accessibility/skills/assess-load/SKILL.md +48 -0
- package/skills/design-library/cognitive-accessibility/skills/cognitive-load-assessment/SKILL.md +60 -0
- package/skills/design-library/cognitive-accessibility/skills/contextual-help-design/SKILL.md +61 -0
- package/skills/design-library/cognitive-accessibility/skills/error-prevention-recovery/SKILL.md +71 -0
- package/skills/design-library/cognitive-accessibility/skills/focus-attention-design/SKILL.md +67 -0
- package/skills/design-library/cognitive-accessibility/skills/memory-load-reduction/SKILL.md +60 -0
- package/skills/design-library/cognitive-accessibility/skills/plain-language-design/SKILL.md +78 -0
- package/skills/design-library/cognitive-accessibility/skills/review/SKILL.md +56 -0
- package/skills/design-library/cognitive-accessibility/skills/simplify/SKILL.md +39 -0
- package/skills/design-library/cognitive-accessibility/skills/wayfinding-navigation/SKILL.md +64 -0
- package/skills/design-library/design-research/skills/behavioural-analytics/SKILL.md +33 -0
- package/skills/design-library/design-research/skills/qual-quant-triangulation/SKILL.md +33 -0
- package/skills/design-library/inclusive-interaction/skills/audit/SKILL.md +50 -0
- package/skills/design-library/inclusive-interaction/skills/design-flow/SKILL.md +58 -0
- package/skills/design-library/inclusive-interaction/skills/feedback-and-status/SKILL.md +76 -0
- package/skills/design-library/inclusive-interaction/skills/gesture-alternatives/SKILL.md +70 -0
- package/skills/design-library/inclusive-interaction/skills/keyboard-navigation/SKILL.md +99 -0
- package/skills/design-library/inclusive-interaction/skills/keyboard-review/SKILL.md +54 -0
- package/skills/design-library/inclusive-interaction/skills/motion-sensitivity/SKILL.md +79 -0
- package/skills/design-library/inclusive-interaction/skills/multi-modal-input/SKILL.md +70 -0
- package/skills/design-library/inclusive-interaction/skills/touch-target-design/SKILL.md +71 -0
- package/skills/design-library/inclusive-interaction/skills/voice-interaction/SKILL.md +68 -0
- package/skills/design-library/visual-critique/skills/critique-affordance/SKILL.md +45 -0
- package/skills/design-library/visual-critique/skills/critique-brand-consistency/SKILL.md +42 -0
- package/skills/design-library/visual-critique/skills/critique-color/SKILL.md +44 -0
- package/skills/design-library/visual-critique/skills/critique-composition/SKILL.md +46 -0
- package/skills/design-library/visual-critique/skills/critique-information-density/SKILL.md +45 -0
- package/skills/design-library/visual-critique/skills/critique-typography/SKILL.md +45 -0
- package/skills/design-library/visual-critique/skills/critique-visual-hierarchy/SKILL.md +40 -0
- package/skills/feature-audit/EVALS.md +83 -0
- package/skills/feature-audit/SKILL.md +326 -0
- package/skills/harness/EVALS.md +81 -0
- package/skills/harness/SKILL.md +88 -0
- package/skills/i-have-adhd/EVALS.md +80 -0
- package/skills/i-have-adhd/SKILL.md +183 -0
- package/skills/no-ai-slop/EVALS.md +89 -0
- package/skills/no-ai-slop/SKILL.md +209 -0
- package/skills/no-ai-slop/eval.md +52 -0
- package/skills/plan-add/EVALS.md +79 -0
- package/skills/plan-add/SKILL.md +179 -0
- package/skills/plan-add/render_table.py +72 -0
- package/skills/plan-status/EVALS.md +78 -0
- package/skills/plan-status/SKILL.md +52 -0
- package/skills/plan-sync/EVALS.md +80 -0
- package/skills/plan-sync/SKILL.md +69 -0
- package/skills/pm-frameworks/SKILL.md +33 -0
- package/skills/pm-frameworks/SOURCE +39 -0
- package/skills/pm-frameworks/intended-vs-implemented/SKILL.md +42 -0
- package/skills/pm-frameworks/opportunity-solution-tree/SKILL.md +64 -0
- package/skills/ponytail/EVALS.md +80 -0
- package/skills/ponytail/SKILL.md +124 -0
- package/skills/product-analysis/EVALS.md +103 -0
- package/skills/product-analysis/SKILL.md +361 -0
- package/skills/research/EVALS.md +104 -0
- package/skills/research/SKILL.md +570 -0
- package/skills/rl-env/SKILL.md +53 -0
- package/skills/rl-env/SOURCE +41 -0
- package/skills/rl-env/generate-nemo-gym-env/SKILL.md +169 -0
- package/skills/rl-env/generate-nemo-gym-env/references/architecture.md +114 -0
- package/skills/rl-env/generate-openenv-env/SKILL.md +183 -0
- package/skills/rl-env/generate-openenv-env/references/architecture.md +82 -0
- package/skills/rl-env/generate-ors-env/SKILL.md +209 -0
- package/skills/rl-env/generate-ors-env/references/architecture.md +113 -0
- package/skills/rl-env/generate-verifiers-env/SKILL.md +188 -0
- package/skills/rl-env/generate-verifiers-env/references/architecture.md +119 -0
- package/skills/rl-env/rl-env-from-description/SKILL.md +124 -0
- package/skills/rl-env/rl-env-from-description/references/interview.md +75 -0
- package/skills/rl-env/rl-env-from-description/references/nemo_gym.md +41 -0
- package/skills/rl-env/rl-env-from-description/references/openenv.md +35 -0
- package/skills/rl-env/rl-env-from-description/references/ors.md +50 -0
- package/skills/rl-env/rl-env-from-description/references/verifiers.md +39 -0
- package/skills/tezgah-contract/EVALS.md +78 -0
- package/skills/tezgah-contract/SKILL.md +792 -0
- package/statusline.py +129 -0
- package/workflows/graph-impact.js +153 -0
- package/workflows/graph-map.js +158 -0
- package/workflows/graph-review.js +170 -0
|
@@ -0,0 +1,406 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: chroma
|
|
3
|
+
description: Open-source embedding database for AI applications. Store embeddings and metadata, perform vector and full-text search, filter by metadata. Simple 4-function API. Scales from notebooks to production clusters. Use for semantic search, RAG applications, or document retrieval. Best for local development and open-source projects.
|
|
4
|
+
version: 1.0.0
|
|
5
|
+
author: Orchestra Research
|
|
6
|
+
license: MIT
|
|
7
|
+
tags: [RAG, Chroma, Vector Database, Embeddings, Semantic Search, Open Source, Self-Hosted, Document Retrieval, Metadata Filtering]
|
|
8
|
+
dependencies: [chromadb, sentence-transformers]
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# Chroma - Open-Source Embedding Database
|
|
12
|
+
|
|
13
|
+
The AI-native database for building LLM applications with memory.
|
|
14
|
+
|
|
15
|
+
## When to use Chroma
|
|
16
|
+
|
|
17
|
+
**Use Chroma when:**
|
|
18
|
+
- Building RAG (retrieval-augmented generation) applications
|
|
19
|
+
- Need local/self-hosted vector database
|
|
20
|
+
- Want open-source solution (Apache 2.0)
|
|
21
|
+
- Prototyping in notebooks
|
|
22
|
+
- Semantic search over documents
|
|
23
|
+
- Storing embeddings with metadata
|
|
24
|
+
|
|
25
|
+
**Metrics**:
|
|
26
|
+
- **24,300+ GitHub stars**
|
|
27
|
+
- **1,900+ forks**
|
|
28
|
+
- **v1.3.3** (stable, weekly releases)
|
|
29
|
+
- **Apache 2.0 license**
|
|
30
|
+
|
|
31
|
+
**Use alternatives instead**:
|
|
32
|
+
- **Pinecone**: Managed cloud, auto-scaling
|
|
33
|
+
- **FAISS**: Pure similarity search, no metadata
|
|
34
|
+
- **Weaviate**: Production ML-native database
|
|
35
|
+
- **Qdrant**: High performance, Rust-based
|
|
36
|
+
|
|
37
|
+
## Quick start
|
|
38
|
+
|
|
39
|
+
### Installation
|
|
40
|
+
|
|
41
|
+
```bash
|
|
42
|
+
# Python
|
|
43
|
+
pip install chromadb
|
|
44
|
+
|
|
45
|
+
# JavaScript/TypeScript
|
|
46
|
+
npm install chromadb @chroma-core/default-embed
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
### Basic usage (Python)
|
|
50
|
+
|
|
51
|
+
```python
|
|
52
|
+
import chromadb
|
|
53
|
+
|
|
54
|
+
# Create client
|
|
55
|
+
client = chromadb.Client()
|
|
56
|
+
|
|
57
|
+
# Create collection
|
|
58
|
+
collection = client.create_collection(name="my_collection")
|
|
59
|
+
|
|
60
|
+
# Add documents
|
|
61
|
+
collection.add(
|
|
62
|
+
documents=["This is document 1", "This is document 2"],
|
|
63
|
+
metadatas=[{"source": "doc1"}, {"source": "doc2"}],
|
|
64
|
+
ids=["id1", "id2"]
|
|
65
|
+
)
|
|
66
|
+
|
|
67
|
+
# Query
|
|
68
|
+
results = collection.query(
|
|
69
|
+
query_texts=["document about topic"],
|
|
70
|
+
n_results=2
|
|
71
|
+
)
|
|
72
|
+
|
|
73
|
+
print(results)
|
|
74
|
+
```
|
|
75
|
+
|
|
76
|
+
## Core operations
|
|
77
|
+
|
|
78
|
+
### 1. Create collection
|
|
79
|
+
|
|
80
|
+
```python
|
|
81
|
+
# Simple collection
|
|
82
|
+
collection = client.create_collection("my_docs")
|
|
83
|
+
|
|
84
|
+
# With custom embedding function
|
|
85
|
+
from chromadb.utils import embedding_functions
|
|
86
|
+
|
|
87
|
+
openai_ef = embedding_functions.OpenAIEmbeddingFunction(
|
|
88
|
+
api_key="your-key",
|
|
89
|
+
model_name="text-embedding-3-small"
|
|
90
|
+
)
|
|
91
|
+
|
|
92
|
+
collection = client.create_collection(
|
|
93
|
+
name="my_docs",
|
|
94
|
+
embedding_function=openai_ef
|
|
95
|
+
)
|
|
96
|
+
|
|
97
|
+
# Get existing collection
|
|
98
|
+
collection = client.get_collection("my_docs")
|
|
99
|
+
|
|
100
|
+
# Delete collection
|
|
101
|
+
client.delete_collection("my_docs")
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
### 2. Add documents
|
|
105
|
+
|
|
106
|
+
```python
|
|
107
|
+
# Add with auto-generated IDs
|
|
108
|
+
collection.add(
|
|
109
|
+
documents=["Doc 1", "Doc 2", "Doc 3"],
|
|
110
|
+
metadatas=[
|
|
111
|
+
{"source": "web", "category": "tutorial"},
|
|
112
|
+
{"source": "pdf", "page": 5},
|
|
113
|
+
{"source": "api", "timestamp": "2025-01-01"}
|
|
114
|
+
],
|
|
115
|
+
ids=["id1", "id2", "id3"]
|
|
116
|
+
)
|
|
117
|
+
|
|
118
|
+
# Add with custom embeddings
|
|
119
|
+
collection.add(
|
|
120
|
+
embeddings=[[0.1, 0.2, ...], [0.3, 0.4, ...]],
|
|
121
|
+
documents=["Doc 1", "Doc 2"],
|
|
122
|
+
ids=["id1", "id2"]
|
|
123
|
+
)
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
### 3. Query (similarity search)
|
|
127
|
+
|
|
128
|
+
```python
|
|
129
|
+
# Basic query
|
|
130
|
+
results = collection.query(
|
|
131
|
+
query_texts=["machine learning tutorial"],
|
|
132
|
+
n_results=5
|
|
133
|
+
)
|
|
134
|
+
|
|
135
|
+
# Query with filters
|
|
136
|
+
results = collection.query(
|
|
137
|
+
query_texts=["Python programming"],
|
|
138
|
+
n_results=3,
|
|
139
|
+
where={"source": "web"}
|
|
140
|
+
)
|
|
141
|
+
|
|
142
|
+
# Query with metadata filters
|
|
143
|
+
results = collection.query(
|
|
144
|
+
query_texts=["advanced topics"],
|
|
145
|
+
where={
|
|
146
|
+
"$and": [
|
|
147
|
+
{"category": "tutorial"},
|
|
148
|
+
{"difficulty": {"$gte": 3}}
|
|
149
|
+
]
|
|
150
|
+
}
|
|
151
|
+
)
|
|
152
|
+
|
|
153
|
+
# Access results
|
|
154
|
+
print(results["documents"]) # List of matching documents
|
|
155
|
+
print(results["metadatas"]) # Metadata for each doc
|
|
156
|
+
print(results["distances"]) # Similarity scores
|
|
157
|
+
print(results["ids"]) # Document IDs
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
### 4. Get documents
|
|
161
|
+
|
|
162
|
+
```python
|
|
163
|
+
# Get by IDs
|
|
164
|
+
docs = collection.get(
|
|
165
|
+
ids=["id1", "id2"]
|
|
166
|
+
)
|
|
167
|
+
|
|
168
|
+
# Get with filters
|
|
169
|
+
docs = collection.get(
|
|
170
|
+
where={"category": "tutorial"},
|
|
171
|
+
limit=10
|
|
172
|
+
)
|
|
173
|
+
|
|
174
|
+
# Get all documents
|
|
175
|
+
docs = collection.get()
|
|
176
|
+
```
|
|
177
|
+
|
|
178
|
+
### 5. Update documents
|
|
179
|
+
|
|
180
|
+
```python
|
|
181
|
+
# Update document content
|
|
182
|
+
collection.update(
|
|
183
|
+
ids=["id1"],
|
|
184
|
+
documents=["Updated content"],
|
|
185
|
+
metadatas=[{"source": "updated"}]
|
|
186
|
+
)
|
|
187
|
+
```
|
|
188
|
+
|
|
189
|
+
### 6. Delete documents
|
|
190
|
+
|
|
191
|
+
```python
|
|
192
|
+
# Delete by IDs
|
|
193
|
+
collection.delete(ids=["id1", "id2"])
|
|
194
|
+
|
|
195
|
+
# Delete with filter
|
|
196
|
+
collection.delete(
|
|
197
|
+
where={"source": "outdated"}
|
|
198
|
+
)
|
|
199
|
+
```
|
|
200
|
+
|
|
201
|
+
## Persistent storage
|
|
202
|
+
|
|
203
|
+
```python
|
|
204
|
+
# Persist to disk
|
|
205
|
+
client = chromadb.PersistentClient(path="./chroma_db")
|
|
206
|
+
|
|
207
|
+
collection = client.create_collection("my_docs")
|
|
208
|
+
collection.add(documents=["Doc 1"], ids=["id1"])
|
|
209
|
+
|
|
210
|
+
# Data persisted automatically
|
|
211
|
+
# Reload later with same path
|
|
212
|
+
client = chromadb.PersistentClient(path="./chroma_db")
|
|
213
|
+
collection = client.get_collection("my_docs")
|
|
214
|
+
```
|
|
215
|
+
|
|
216
|
+
## Embedding functions
|
|
217
|
+
|
|
218
|
+
### Default (Sentence Transformers)
|
|
219
|
+
|
|
220
|
+
```python
|
|
221
|
+
# Uses sentence-transformers by default
|
|
222
|
+
collection = client.create_collection("my_docs")
|
|
223
|
+
# Default model: all-MiniLM-L6-v2
|
|
224
|
+
```
|
|
225
|
+
|
|
226
|
+
### OpenAI
|
|
227
|
+
|
|
228
|
+
```python
|
|
229
|
+
from chromadb.utils import embedding_functions
|
|
230
|
+
|
|
231
|
+
openai_ef = embedding_functions.OpenAIEmbeddingFunction(
|
|
232
|
+
api_key="your-key",
|
|
233
|
+
model_name="text-embedding-3-small"
|
|
234
|
+
)
|
|
235
|
+
|
|
236
|
+
collection = client.create_collection(
|
|
237
|
+
name="openai_docs",
|
|
238
|
+
embedding_function=openai_ef
|
|
239
|
+
)
|
|
240
|
+
```
|
|
241
|
+
|
|
242
|
+
### HuggingFace
|
|
243
|
+
|
|
244
|
+
```python
|
|
245
|
+
huggingface_ef = embedding_functions.HuggingFaceEmbeddingFunction(
|
|
246
|
+
api_key="your-key",
|
|
247
|
+
model_name="sentence-transformers/all-mpnet-base-v2"
|
|
248
|
+
)
|
|
249
|
+
|
|
250
|
+
collection = client.create_collection(
|
|
251
|
+
name="hf_docs",
|
|
252
|
+
embedding_function=huggingface_ef
|
|
253
|
+
)
|
|
254
|
+
```
|
|
255
|
+
|
|
256
|
+
### Custom embedding function
|
|
257
|
+
|
|
258
|
+
```python
|
|
259
|
+
from chromadb import Documents, EmbeddingFunction, Embeddings
|
|
260
|
+
|
|
261
|
+
class MyEmbeddingFunction(EmbeddingFunction):
|
|
262
|
+
def __call__(self, input: Documents) -> Embeddings:
|
|
263
|
+
# Your embedding logic
|
|
264
|
+
return embeddings
|
|
265
|
+
|
|
266
|
+
my_ef = MyEmbeddingFunction()
|
|
267
|
+
collection = client.create_collection(
|
|
268
|
+
name="custom_docs",
|
|
269
|
+
embedding_function=my_ef
|
|
270
|
+
)
|
|
271
|
+
```
|
|
272
|
+
|
|
273
|
+
## Metadata filtering
|
|
274
|
+
|
|
275
|
+
```python
|
|
276
|
+
# Exact match
|
|
277
|
+
results = collection.query(
|
|
278
|
+
query_texts=["query"],
|
|
279
|
+
where={"category": "tutorial"}
|
|
280
|
+
)
|
|
281
|
+
|
|
282
|
+
# Comparison operators
|
|
283
|
+
results = collection.query(
|
|
284
|
+
query_texts=["query"],
|
|
285
|
+
where={"page": {"$gt": 10}} # $gt, $gte, $lt, $lte, $ne
|
|
286
|
+
)
|
|
287
|
+
|
|
288
|
+
# Logical operators
|
|
289
|
+
results = collection.query(
|
|
290
|
+
query_texts=["query"],
|
|
291
|
+
where={
|
|
292
|
+
"$and": [
|
|
293
|
+
{"category": "tutorial"},
|
|
294
|
+
{"difficulty": {"$lte": 3}}
|
|
295
|
+
]
|
|
296
|
+
} # Also: $or
|
|
297
|
+
)
|
|
298
|
+
|
|
299
|
+
# Contains
|
|
300
|
+
results = collection.query(
|
|
301
|
+
query_texts=["query"],
|
|
302
|
+
where={"tags": {"$in": ["python", "ml"]}}
|
|
303
|
+
)
|
|
304
|
+
```
|
|
305
|
+
|
|
306
|
+
## LangChain integration
|
|
307
|
+
|
|
308
|
+
```python
|
|
309
|
+
from langchain_chroma import Chroma
|
|
310
|
+
from langchain_openai import OpenAIEmbeddings
|
|
311
|
+
from langchain.text_splitter import RecursiveCharacterTextSplitter
|
|
312
|
+
|
|
313
|
+
# Split documents
|
|
314
|
+
text_splitter = RecursiveCharacterTextSplitter(chunk_size=1000)
|
|
315
|
+
docs = text_splitter.split_documents(documents)
|
|
316
|
+
|
|
317
|
+
# Create Chroma vector store
|
|
318
|
+
vectorstore = Chroma.from_documents(
|
|
319
|
+
documents=docs,
|
|
320
|
+
embedding=OpenAIEmbeddings(),
|
|
321
|
+
persist_directory="./chroma_db"
|
|
322
|
+
)
|
|
323
|
+
|
|
324
|
+
# Query
|
|
325
|
+
results = vectorstore.similarity_search("machine learning", k=3)
|
|
326
|
+
|
|
327
|
+
# As retriever
|
|
328
|
+
retriever = vectorstore.as_retriever(search_kwargs={"k": 5})
|
|
329
|
+
```
|
|
330
|
+
|
|
331
|
+
## LlamaIndex integration
|
|
332
|
+
|
|
333
|
+
```python
|
|
334
|
+
from llama_index.vector_stores.chroma import ChromaVectorStore
|
|
335
|
+
from llama_index.core import VectorStoreIndex, StorageContext
|
|
336
|
+
import chromadb
|
|
337
|
+
|
|
338
|
+
# Initialize Chroma
|
|
339
|
+
db = chromadb.PersistentClient(path="./chroma_db")
|
|
340
|
+
collection = db.get_or_create_collection("my_collection")
|
|
341
|
+
|
|
342
|
+
# Create vector store
|
|
343
|
+
vector_store = ChromaVectorStore(chroma_collection=collection)
|
|
344
|
+
storage_context = StorageContext.from_defaults(vector_store=vector_store)
|
|
345
|
+
|
|
346
|
+
# Create index
|
|
347
|
+
index = VectorStoreIndex.from_documents(
|
|
348
|
+
documents,
|
|
349
|
+
storage_context=storage_context
|
|
350
|
+
)
|
|
351
|
+
|
|
352
|
+
# Query
|
|
353
|
+
query_engine = index.as_query_engine()
|
|
354
|
+
response = query_engine.query("What is machine learning?")
|
|
355
|
+
```
|
|
356
|
+
|
|
357
|
+
## Server mode
|
|
358
|
+
|
|
359
|
+
```python
|
|
360
|
+
# Run Chroma server
|
|
361
|
+
# Terminal: chroma run --path ./chroma_db --port 8000
|
|
362
|
+
|
|
363
|
+
# Connect to server
|
|
364
|
+
import chromadb
|
|
365
|
+
from chromadb.config import Settings
|
|
366
|
+
|
|
367
|
+
client = chromadb.HttpClient(
|
|
368
|
+
host="localhost",
|
|
369
|
+
port=8000,
|
|
370
|
+
settings=Settings(anonymized_telemetry=False)
|
|
371
|
+
)
|
|
372
|
+
|
|
373
|
+
# Use as normal
|
|
374
|
+
collection = client.get_or_create_collection("my_docs")
|
|
375
|
+
```
|
|
376
|
+
|
|
377
|
+
## Best practices
|
|
378
|
+
|
|
379
|
+
1. **Use persistent client** - Don't lose data on restart
|
|
380
|
+
2. **Add metadata** - Enables filtering and tracking
|
|
381
|
+
3. **Batch operations** - Add multiple docs at once
|
|
382
|
+
4. **Choose right embedding model** - Balance speed/quality
|
|
383
|
+
5. **Use filters** - Narrow search space
|
|
384
|
+
6. **Unique IDs** - Avoid collisions
|
|
385
|
+
7. **Regular backups** - Copy chroma_db directory
|
|
386
|
+
8. **Monitor collection size** - Scale up if needed
|
|
387
|
+
9. **Test embedding functions** - Ensure quality
|
|
388
|
+
10. **Use server mode for production** - Better for multi-user
|
|
389
|
+
|
|
390
|
+
## Performance
|
|
391
|
+
|
|
392
|
+
| Operation | Latency | Notes |
|
|
393
|
+
|-----------|---------|-------|
|
|
394
|
+
| Add 100 docs | ~1-3s | With embedding |
|
|
395
|
+
| Query (top 10) | ~50-200ms | Depends on collection size |
|
|
396
|
+
| Metadata filter | ~10-50ms | Fast with proper indexing |
|
|
397
|
+
|
|
398
|
+
## Resources
|
|
399
|
+
|
|
400
|
+
- **GitHub**: https://github.com/chroma-core/chroma ⭐ 24,300+
|
|
401
|
+
- **Docs**: https://docs.trychroma.com
|
|
402
|
+
- **Discord**: https://discord.gg/MMeYNTmh3x
|
|
403
|
+
- **Version**: 1.3.3+
|
|
404
|
+
- **License**: Apache 2.0
|
|
405
|
+
|
|
406
|
+
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
<!-- vendored from orchestra-research/AI-research-SKILLs@773a52944ba4747a18bd4ae9ade53fff041adcbc 15-rag/chroma/references/integration.md; MIT (c) Orchestra Research -->
|
|
2
|
+
# Chroma Integration Guide
|
|
3
|
+
|
|
4
|
+
Integration with LangChain, LlamaIndex, and frameworks.
|
|
5
|
+
|
|
6
|
+
## LangChain
|
|
7
|
+
|
|
8
|
+
```python
|
|
9
|
+
from langchain_chroma import Chroma
|
|
10
|
+
from langchain_openai import OpenAIEmbeddings
|
|
11
|
+
|
|
12
|
+
vectorstore = Chroma.from_documents(
|
|
13
|
+
documents=docs,
|
|
14
|
+
embedding=OpenAIEmbeddings(),
|
|
15
|
+
persist_directory="./chroma_db"
|
|
16
|
+
)
|
|
17
|
+
|
|
18
|
+
# Query
|
|
19
|
+
results = vectorstore.similarity_search("query", k=3)
|
|
20
|
+
|
|
21
|
+
# As retriever
|
|
22
|
+
retriever = vectorstore.as_retriever()
|
|
23
|
+
```
|
|
24
|
+
|
|
25
|
+
## LlamaIndex
|
|
26
|
+
|
|
27
|
+
```python
|
|
28
|
+
from llama_index.vector_stores.chroma import ChromaVectorStore
|
|
29
|
+
import chromadb
|
|
30
|
+
|
|
31
|
+
db = chromadb.PersistentClient(path="./chroma_db")
|
|
32
|
+
collection = db.get_or_create_collection("docs")
|
|
33
|
+
|
|
34
|
+
vector_store = ChromaVectorStore(chroma_collection=collection)
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
## Resources
|
|
38
|
+
|
|
39
|
+
- **Docs**: https://docs.trychroma.com
|
|
@@ -0,0 +1,221 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: faiss
|
|
3
|
+
description: Facebook's library for efficient similarity search and clustering of dense vectors. Supports billions of vectors, GPU acceleration, and various index types (Flat, IVF, HNSW). Use for fast k-NN search, large-scale vector retrieval, or when you need pure similarity search without metadata. Best for high-performance applications.
|
|
4
|
+
version: 1.0.0
|
|
5
|
+
author: Orchestra Research
|
|
6
|
+
license: MIT
|
|
7
|
+
tags: [RAG, FAISS, Similarity Search, Vector Search, Facebook AI, GPU Acceleration, Billion-Scale, K-NN, HNSW, High Performance, Large Scale]
|
|
8
|
+
dependencies: [faiss-cpu, faiss-gpu, numpy]
|
|
9
|
+
---
|
|
10
|
+
|
|
11
|
+
# FAISS - Efficient Similarity Search
|
|
12
|
+
|
|
13
|
+
Facebook AI's library for billion-scale vector similarity search.
|
|
14
|
+
|
|
15
|
+
## When to use FAISS
|
|
16
|
+
|
|
17
|
+
**Use FAISS when:**
|
|
18
|
+
- Need fast similarity search on large vector datasets (millions/billions)
|
|
19
|
+
- GPU acceleration required
|
|
20
|
+
- Pure vector similarity (no metadata filtering needed)
|
|
21
|
+
- High throughput, low latency critical
|
|
22
|
+
- Offline/batch processing of embeddings
|
|
23
|
+
|
|
24
|
+
**Metrics**:
|
|
25
|
+
- **31,700+ GitHub stars**
|
|
26
|
+
- Meta/Facebook AI Research
|
|
27
|
+
- **Handles billions of vectors**
|
|
28
|
+
- **C++** with Python bindings
|
|
29
|
+
|
|
30
|
+
**Use alternatives instead**:
|
|
31
|
+
- **Chroma/Pinecone**: Need metadata filtering
|
|
32
|
+
- **Weaviate**: Need full database features
|
|
33
|
+
- **Annoy**: Simpler, fewer features
|
|
34
|
+
|
|
35
|
+
## Quick start
|
|
36
|
+
|
|
37
|
+
### Installation
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
# CPU only
|
|
41
|
+
pip install faiss-cpu
|
|
42
|
+
|
|
43
|
+
# GPU support
|
|
44
|
+
pip install faiss-gpu
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
### Basic usage
|
|
48
|
+
|
|
49
|
+
```python
|
|
50
|
+
import faiss
|
|
51
|
+
import numpy as np
|
|
52
|
+
|
|
53
|
+
# Create sample data (1000 vectors, 128 dimensions)
|
|
54
|
+
d = 128
|
|
55
|
+
nb = 1000
|
|
56
|
+
vectors = np.random.random((nb, d)).astype('float32')
|
|
57
|
+
|
|
58
|
+
# Create index
|
|
59
|
+
index = faiss.IndexFlatL2(d) # L2 distance
|
|
60
|
+
index.add(vectors) # Add vectors
|
|
61
|
+
|
|
62
|
+
# Search
|
|
63
|
+
k = 5 # Find 5 nearest neighbors
|
|
64
|
+
query = np.random.random((1, d)).astype('float32')
|
|
65
|
+
distances, indices = index.search(query, k)
|
|
66
|
+
|
|
67
|
+
print(f"Nearest neighbors: {indices}")
|
|
68
|
+
print(f"Distances: {distances}")
|
|
69
|
+
```
|
|
70
|
+
|
|
71
|
+
## Index types
|
|
72
|
+
|
|
73
|
+
### 1. Flat (exact search)
|
|
74
|
+
|
|
75
|
+
```python
|
|
76
|
+
# L2 (Euclidean) distance
|
|
77
|
+
index = faiss.IndexFlatL2(d)
|
|
78
|
+
|
|
79
|
+
# Inner product (cosine similarity if normalized)
|
|
80
|
+
index = faiss.IndexFlatIP(d)
|
|
81
|
+
|
|
82
|
+
# Slowest, most accurate
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
### 2. IVF (inverted file) - Fast approximate
|
|
86
|
+
|
|
87
|
+
```python
|
|
88
|
+
# Create quantizer
|
|
89
|
+
quantizer = faiss.IndexFlatL2(d)
|
|
90
|
+
|
|
91
|
+
# IVF index with 100 clusters
|
|
92
|
+
nlist = 100
|
|
93
|
+
index = faiss.IndexIVFFlat(quantizer, d, nlist)
|
|
94
|
+
|
|
95
|
+
# Train on data
|
|
96
|
+
index.train(vectors)
|
|
97
|
+
|
|
98
|
+
# Add vectors
|
|
99
|
+
index.add(vectors)
|
|
100
|
+
|
|
101
|
+
# Search (nprobe = clusters to search)
|
|
102
|
+
index.nprobe = 10
|
|
103
|
+
distances, indices = index.search(query, k)
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
### 3. HNSW (Hierarchical NSW) - Best quality/speed
|
|
107
|
+
|
|
108
|
+
```python
|
|
109
|
+
# HNSW index
|
|
110
|
+
M = 32 # Number of connections per layer
|
|
111
|
+
index = faiss.IndexHNSWFlat(d, M)
|
|
112
|
+
|
|
113
|
+
# No training needed
|
|
114
|
+
index.add(vectors)
|
|
115
|
+
|
|
116
|
+
# Search
|
|
117
|
+
distances, indices = index.search(query, k)
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
### 4. Product Quantization - Memory efficient
|
|
121
|
+
|
|
122
|
+
```python
|
|
123
|
+
# PQ reduces memory by 16-32×
|
|
124
|
+
m = 8 # Number of subquantizers
|
|
125
|
+
nbits = 8
|
|
126
|
+
index = faiss.IndexPQ(d, m, nbits)
|
|
127
|
+
|
|
128
|
+
# Train and add
|
|
129
|
+
index.train(vectors)
|
|
130
|
+
index.add(vectors)
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
## Save and load
|
|
134
|
+
|
|
135
|
+
```python
|
|
136
|
+
# Save index
|
|
137
|
+
faiss.write_index(index, "large.index")
|
|
138
|
+
|
|
139
|
+
# Load index
|
|
140
|
+
index = faiss.read_index("large.index")
|
|
141
|
+
|
|
142
|
+
# Continue using
|
|
143
|
+
distances, indices = index.search(query, k)
|
|
144
|
+
```
|
|
145
|
+
|
|
146
|
+
## GPU acceleration
|
|
147
|
+
|
|
148
|
+
```python
|
|
149
|
+
# Single GPU
|
|
150
|
+
res = faiss.StandardGpuResources()
|
|
151
|
+
index_cpu = faiss.IndexFlatL2(d)
|
|
152
|
+
index_gpu = faiss.index_cpu_to_gpu(res, 0, index_cpu) # GPU 0
|
|
153
|
+
|
|
154
|
+
# Multi-GPU
|
|
155
|
+
index_gpu = faiss.index_cpu_to_all_gpus(index_cpu)
|
|
156
|
+
|
|
157
|
+
# 10-100× faster than CPU
|
|
158
|
+
```
|
|
159
|
+
|
|
160
|
+
## LangChain integration
|
|
161
|
+
|
|
162
|
+
```python
|
|
163
|
+
from langchain_community.vectorstores import FAISS
|
|
164
|
+
from langchain_openai import OpenAIEmbeddings
|
|
165
|
+
|
|
166
|
+
# Create FAISS vector store
|
|
167
|
+
vectorstore = FAISS.from_documents(docs, OpenAIEmbeddings())
|
|
168
|
+
|
|
169
|
+
# Save
|
|
170
|
+
vectorstore.save_local("faiss_index")
|
|
171
|
+
|
|
172
|
+
# Load
|
|
173
|
+
vectorstore = FAISS.load_local(
|
|
174
|
+
"faiss_index",
|
|
175
|
+
OpenAIEmbeddings(),
|
|
176
|
+
allow_dangerous_deserialization=True
|
|
177
|
+
)
|
|
178
|
+
|
|
179
|
+
# Search
|
|
180
|
+
results = vectorstore.similarity_search("query", k=5)
|
|
181
|
+
```
|
|
182
|
+
|
|
183
|
+
## LlamaIndex integration
|
|
184
|
+
|
|
185
|
+
```python
|
|
186
|
+
from llama_index.vector_stores.faiss import FaissVectorStore
|
|
187
|
+
import faiss
|
|
188
|
+
|
|
189
|
+
# Create FAISS index
|
|
190
|
+
d = 1536
|
|
191
|
+
faiss_index = faiss.IndexFlatL2(d)
|
|
192
|
+
|
|
193
|
+
vector_store = FaissVectorStore(faiss_index=faiss_index)
|
|
194
|
+
```
|
|
195
|
+
|
|
196
|
+
## Best practices
|
|
197
|
+
|
|
198
|
+
1. **Choose right index type** - Flat for <10K, IVF for 10K-1M, HNSW for quality
|
|
199
|
+
2. **Normalize for cosine** - Use IndexFlatIP with normalized vectors
|
|
200
|
+
3. **Use GPU for large datasets** - 10-100× faster
|
|
201
|
+
4. **Save trained indices** - Training is expensive
|
|
202
|
+
5. **Tune nprobe/ef_search** - Balance speed/accuracy
|
|
203
|
+
6. **Monitor memory** - PQ for large datasets
|
|
204
|
+
7. **Batch queries** - Better GPU utilization
|
|
205
|
+
|
|
206
|
+
## Performance
|
|
207
|
+
|
|
208
|
+
| Index Type | Build Time | Search Time | Memory | Accuracy |
|
|
209
|
+
|------------|------------|-------------|--------|----------|
|
|
210
|
+
| Flat | Fast | Slow | High | 100% |
|
|
211
|
+
| IVF | Medium | Fast | Medium | 95-99% |
|
|
212
|
+
| HNSW | Slow | Fastest | High | 99% |
|
|
213
|
+
| PQ | Medium | Fast | Low | 90-95% |
|
|
214
|
+
|
|
215
|
+
## Resources
|
|
216
|
+
|
|
217
|
+
- **GitHub**: https://github.com/facebookresearch/faiss ⭐ 31,700+
|
|
218
|
+
- **Wiki**: https://github.com/facebookresearch/faiss/wiki
|
|
219
|
+
- **License**: MIT
|
|
220
|
+
|
|
221
|
+
|