Skip to main content
Ctrl+K

XRAG 1.0 documentation

Documentation:

  • Getting Started
    • Installation
    • QuickStart
  • Data
    • XRAG_Data_Schema
    • Load XRAG Data
    • Prepare Your Data
  • Index
    • EmbeddingModule
    • VectorIndex
  • Config
    • API_KEYS
    • Parameters_Setting
    • XRAG_Prompts
    • XRAG_Lanucher
  • Advanced modules
    • Pre-retrieval
    • Retrieval
    • Post-retrieval
    • Generator
  • Evaluation
    • ConR_Evaluation
    • ConG_Evaluation
    • CogL_Evaluation
  • Serving
    • Interactive Web UI
    • Ollama
    • XRAG APIs
    • XRAG Cli
  • API reference
    • xrag.data package
    • xrag.embs package
    • xrag.eval package
    • xrag.index package
    • xrag.launcher package
    • xrag.llms package
    • xrag.process package
    • xrag.retrievers package
    • xrag.webui package
    • xrag.cli module
    • xrag.config module
  • .rst

Getting Started

Contents

  • Subpackages

Getting Started#

This section provides a quick overview of XRAG and how to get started with it.

Subpackages#

Getting Started

  • Installation
    • 🛠️ Installation
      • Create a Virtual Environment via conda(Recommended)
      • Install via pip
  • QuickStart
    • 🚀 Quick Start
      • 1. Prepare Configuration:
      • 2. Using xrag-cli
      • Command Structure
      • Commands and Options
      • Overriding Configuration Parameters
      • Generate QA pairs from a folder

previous

Welcome to XRAG’s documentation!

next

Installation

Contents
  • Subpackages

By XRAG

© Copyright 2024, xrag.