in yourbench/main.py [0:0]
def help() -> None:
"""Show detailed help information for all YourBench commands."""
console.print("[bold green]YourBench CLI Help[/bold green]\n")
console.print("YourBench is a dynamic evaluation set generation tool using Large Language Models.")
console.print("It converts documents into comprehensive evaluation datasets with questions and answers.\n")
# Commands table
table = Table(title="Available Commands", show_header=True, header_style="bold magenta")
table.add_column("Command", style="cyan", width=12)
table.add_column("Description", style="white", width=50)
table.add_column("Usage", style="green", width=30)
commands = [
(
"run",
"Execute the YourBench pipeline with a configuration file. Processes documents through ingestion, summarization, chunking, and question generation stages.",
"yourbench run config.yaml",
),
(
"create",
"Interactive configuration file creator. Guides you through setting up models, pipeline stages, and Hugging Face integration.",
"yourbench create [--simple]",
),
(
"analyze",
"Run specific analysis scripts on generated datasets. Includes various evaluation and visualization tools.",
"yourbench analyze ANALYSIS_NAME",
),
("gui", "Launch the Gradio web interface for YourBench (not yet implemented).", "yourbench gui"),
("help", "Show this detailed help information about all commands.", "yourbench help"),
]
for cmd, desc, usage in commands:
table.add_row(cmd, desc, usage)
console.print(table)
# Quick start section
console.print("\n[bold cyan]Quick Start:[/bold cyan]")
console.print("1. [green]yourbench create[/green] - Create a configuration file")
console.print("2. Place documents in [yellow]data/raw/[/yellow] directory")
console.print("3. [green]yourbench run config.yaml[/green] - Process documents")
# Examples section
console.print("\n[bold cyan]Examples:[/bold cyan]")
console.print("• Create simple config: [green]yourbench create --simple[/green]")
console.print("• Run with debug: [green]yourbench run config.yaml --debug[/green]")
console.print("• Show stage timing: [green]yourbench run config.yaml --plot-stage-timing[/green]")
console.print("• Run citation analysis: [green]yourbench analyze citation_score[/green]")
console.print("\n[bold cyan]For More Help:[/bold cyan]")
console.print("• Use [green]yourbench COMMAND --help[/green] for command-specific options")
console.print("• Visit the documentation for detailed guides and examples")