123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129 |
- #
- # txtai Material for MkDocs configuration
- #
- site_name: txtai
- site_description: "txtai is an all-in-one open-source embeddings database for semantic search, LLM orchestration and language model workflows"
- repo_name: neuml/txtai
- repo_url: https://github.com/neuml/txtai
- copyright: © NeuML LLC, Apache-2.0 License
- theme:
- name: material
- logo: images/logo.png
- favicon: images/logo.png
- custom_dir: docs/overrides
- icon:
- repo: fontawesome/brands/github
- palette:
- - media: "(prefers-color-scheme: light)"
- scheme: default
- primary: blue
- accent: blue
- toggle:
- icon: material/toggle-switch-off-outline
- name: Switch to dark mode
- - media: "(prefers-color-scheme: dark)"
- scheme: slate
- primary: light blue
- accent: light blue
- toggle:
- icon: material/toggle-switch
- name: Switch to light mode
- features:
- - navigation.indexes
- - navigation.instant
- plugins:
- - search
- - mkdocstrings:
- handlers:
- python:
- options:
- show_root_full_path: false
- show_root_heading: true
- show_root_toc_entry: false
- - redirects:
- redirect_maps:
- "pipeline/text/extractor.md": "pipeline/text/rag.md"
- "pipeline/text/generator.md": "pipeline/text/llm.md"
- "pipeline/text/sequences.md": "pipeline/text/llm.md"
- markdown_extensions:
- - pymdownx.highlight
- - pymdownx.superfences
- nav:
- - Home: index.md
- - Why txtai?: why.md
- - Use Cases: usecases.md
- - Installation: install.md
- - Model Guide: models.md
- - Embeddings:
- - embeddings/index.md
- - Configuration:
- - embeddings/configuration/index.md
- - ANN: embeddings/configuration/ann.md
- - Cloud: embeddings/configuration/cloud.md
- - Database: embeddings/configuration/database.md
- - General: embeddings/configuration/general.md
- - Graph: embeddings/configuration/graph.md
- - Scoring: embeddings/configuration/scoring.md
- - Vectors: embeddings/configuration/vectors.md
- - Index Format: embeddings/format.md
- - Index Guide: embeddings/indexing.md
- - Methods: embeddings/methods.md
- - Query Guide: embeddings/query.md
- - Pipeline:
- - pipeline/index.md
- - Audio:
- - Audio Mixer: pipeline/audio/audiomixer.md
- - Audio Stream: pipeline/audio/audiostream.md
- - Microphone: pipeline/audio/microphone.md
- - Text To Audio: pipeline/audio/texttoaudio.md
- - Text To Speech: pipeline/audio/texttospeech.md
- - Transcription: pipeline/audio/transcription.md
- - Data:
- - Segmentation: pipeline/data/segmentation.md
- - Tabular: pipeline/data/tabular.md
- - Textractor: pipeline/data/textractor.md
- - Image:
- - Caption: pipeline/image/caption.md
- - Image Hash: pipeline/image/imagehash.md
- - Objects: pipeline/image/objects.md
- - Text:
- - Entity: pipeline/text/entity.md
- - Labels: pipeline/text/labels.md
- - LLM: pipeline/text/llm.md
- - RAG: pipeline/text/rag.md
- - Similarity: pipeline/text/similarity.md
- - Summary: pipeline/text/summary.md
- - Translation: pipeline/text/translation.md
- - Train:
- - HF ONNX: pipeline/train/hfonnx.md
- - ML ONNX: pipeline/train/mlonnx.md
- - Trainer: pipeline/train/trainer.md
- - Workflow:
- - workflow/index.md
- - Schedule: workflow/schedule.md
- - Tasks:
- - workflow/task/index.md
- - Console: workflow/task/console.md
- - Export: workflow/task/export.md
- - File: workflow/task/file.md
- - Image: workflow/task/image.md
- - Retrieve: workflow/task/retrieve.md
- - Service: workflow/task/service.md
- - Storage: workflow/task/storage.md
- - Template: workflow/task/template.md
- - Url: workflow/task/url.md
- - Workflow: workflow/task/workflow.md
- - API:
- - api/index.md
- - Cluster: api/cluster.md
- - Configuration: api/configuration.md
- - Customization: api/customization.md
- - Methods: api/methods.md
- - Security: api/security.md
- - Cloud: cloud.md
- - Examples: examples.md
- - FAQ: faq.md
- - Powered by txtai: poweredby.md
- - Further Reading: further.md
|