Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
AutoRAG documentation
AutoRAG documentation

Getting Started

  • Installation and Setup
  • Tutorial
  • Structure
  • TroubleShooting
  • Configure LLM & Embedding models
  • Migration Guide
  • Evaluate your RAG

Data Creation

  • Evaluation data creation tutorial
  • Dataset Format
  • Data Creation
    • QA creation
      • Query Generation
      • Answer Generation
      • Filtering
      • Query Evolving
    • Chunk
      • Langchain Chunk
      • Llama Index Chunk
    • Parse
      • Langchain Parse
      • Llama Parse
      • Clova
      • Table Hybrid Parse
    • Legacy
      • RAGAS evaluation data generation
      • Start creating your own evaluation data

Optimization

  • How optimization works
  • Folder Structure
  • Make a custom config YAML file
  • Strategy
  • Sample YAML file guide

Integration

  • Configure LLM
    • AWS Bedrock x AutoRAG
    • HuggingFace LLM x AutoRAG
    • Nvidia Nim x AutoRAG
    • OLLAMA x AutoRAG
  • Configure Vector DB
    • Chroma
    • Milvus
    • Weaviate
    • Pinecone
    • Couchbase
    • Qdrant

Evaluation Metrics

  • Retrieval Metrics
  • Retrieval Token Metrics
  • Generation Metrics

Nodes & Modules

  • Available List
  • 1. Query Expansion
    • Query Decompose
    • HyDE
    • Multi Query Expansion
  • 2. Retrieval
    • BM25
    • Vectordb
    • Hybrid - rrf
    • Hybrid - cc
  • 3. Passage Augmenter
    • Prev Next Augmenter
  • 4. Passage_Reranker
    • UPR
    • TART
    • MonoT5
    • Ko-reranker
    • cohere_reranker
    • RankGPT
    • jina_reranker
    • Colbert Reranker
    • Sentence Transformer Reranker
    • Flag Embedding Reranker
    • Flag Embedding LLM Reranker
    • Time Reranker
    • OpenVINO Reranker
    • voyageai_reranker
    • Mixedbread AI Reranker
    • FlashRank Reranker
  • 5. Passage Filter
    • Similarity Threshold Cutoff
    • Similarity Percentile Cutoff
    • Recency Filter
    • Threshold Cutoff
    • Percentile Cutoff
  • 6. Passage_Compressor
    • Tree Summarize
    • Refine
    • Long LLM Lingua
  • 7. Prompt Maker
    • F-String
    • Long Context Reorder
    • Window Replacement
  • 8. Generator
    • llama_index LLM
    • vllm
    • OpenAI LLM

Deploy

  • API endpoint
  • Web Interface

Roadmap

  • Road to Modular RAG

API Reference

  • autorag
    • autorag package
      • autorag.data package
        • autorag.data.chunk package
        • autorag.data.legacy package
          • autorag.data.legacy.corpus package
          • autorag.data.legacy.qacreation package
        • autorag.data.parse package
        • autorag.data.qa package
          • autorag.data.qa.evolve package
          • autorag.data.qa.filter package
          • autorag.data.qa.generation_gt package
          • autorag.data.qa.query package
        • autorag.data.utils package
      • autorag.deploy package
      • autorag.evaluation package
        • autorag.evaluation.metric package
      • autorag.nodes package
        • autorag.nodes.generator package
        • autorag.nodes.passageaugmenter package
        • autorag.nodes.passagecompressor package
        • autorag.nodes.passagefilter package
        • autorag.nodes.passagereranker package
          • autorag.nodes.passagereranker.tart package
        • autorag.nodes.promptmaker package
        • autorag.nodes.queryexpansion package
        • autorag.nodes.retrieval package
      • autorag.schema package
      • autorag.utils package
      • autorag.vectordb package
Back to top
View this page

LegacyΒΆ

This is the legacy docs. Deprecated since v0.3.0 release.

  • RAGAS evaluation data generation
  • Start creating your own evaluation data
Next
RAGAS evaluation data generation
Previous
Table Hybrid Parse
Copyright © 2024, Marker-Inc
Made with Sphinx and @pradyunsg's Furo