Guides¶

Welcome to the BoxLab Guides! This section provides comprehensive tutorials and guides for using BoxLab effectively, from basic operations to advanced workflows.

Getting Started¶

Installation Guide¶

Learn how to install BoxLab and set up your development environment.

• Installing from PyPI
• Building from source
• Development setup
• Optional dependencies

Quick Start¶

Get up and running with BoxLab in minutes.

• Basic dataset operations
• Format conversion
• Using the annotator
• Common workflows

Command Line Interface¶

CLI Overview¶

Master the BoxLab command-line interface.

• Command structure
• Global options
• Common patterns
• Tips and tricks

Dataset Commands¶

Complete guide to dataset CLI commands.

• dataset convert - Format conversion
• dataset info - View statistics
• dataset merge - Combine datasets
• dataset visualize - Generate visualizations

Annotator Command¶

Using the GUI annotator from command line.

• Launching the annotator
• Workflow integration
• Keyboard shortcuts

Advanced Topics¶

Advanced Usage¶

Master advanced features and workflows.

• PyTorch training integration
• Custom plugin development
• Batch processing automation
• Advanced dataset manipulation
• Performance optimization

Quick Links¶

For Beginners:

1. Installation Guide
2. Quick Start
3. CLI Overview

For CLI Users:

1. CLI Overview
2. Dataset Commands
3. Annotator Command

For Developers:

1. Advanced Usage - PyTorch integration and custom plugins

Need Help?¶

• API Reference: Complete API documentation
• GitHub Issues: Report bugs or request features
• Discussions: Ask questions and share ideas

Next Steps: Start with the Installation Guide or jump to Quick Start if you're already set up.