QuickStart

🚀 Quick Start

Here’s how you can get started with XRAG:

1. Prepare Configuration:

Modify the config.toml file to set up your desired configurations.

2. Using xrag-cli

After installing XRAG, the xrag-cli command becomes available in your environment. This command provides a convenient way to interact with XRAG without needing to call Python scripts directly.

Command Structure

xrag-cli [command] [options]

Commands and Options

• run: Runs the benchmarking process.

  xrag-cli run [--override key=value ...]
  

• webui: Launches the web-based user interface.

  xrag-cli webui
  

• ver: Displays the current version of XRAG.

  xrag-cli version
  

• help: Displays help information.

  xrag-cli help
  

• generate: Generate QA pairs from a folder.

  xrag-cli generate -i <input_file> -o <output_file> -n <num_questions> -s <sentence_length>
  

Overriding Configuration Parameters

Use the --override flag followed by key-value pairs to override configuration settings:

xrag-cli run --override embeddings="new-embedding-model"

Generate QA pairs from a folder

xrag-cli generate -i <input_file> -o <output_file> -n <num_questions> -s <sentence_length>

Automatically generate QA pairs from a folder.

---