# Yanex Documentation

Complete documentation for Yanex - Yet Another Experiment Tracker

## Getting Started

- [**Installation & Quick Start**](../README.md#quick-start) - Get up and running in minutes
- [**Configuration**](configuration.md) - Parameter management and config files
- [**Best Practices**](best-practices.md) - Tips for effective experiment tracking

## CLI Commands

Yanex provides a comprehensive command-line interface for managing experiments:

### Core Commands
- [**`yanex run`**](commands/run.md) - Execute experiments with parameter tracking
- [**`yanex list`**](commands/list.md) - List and filter experiments  
- [**`yanex show`**](commands/show.md) - Display detailed experiment information
- [**`yanex compare`**](commands/compare.md) - Interactive experiment comparison

### Management Commands
- [**`yanex archive`**](commands/archive.md) - Archive old experiments
- [**`yanex unarchive`**](commands/unarchive.md) - Restore archived experiments
- [**`yanex delete`**](commands/delete.md) - Permanently delete experiments
- [**`yanex update`**](commands/update.md) - Modify experiment metadata

### All Commands Reference
See [**CLI Commands Reference**](cli-commands.md) for a complete overview of all commands with examples.

## Python API

- [**Python API Reference**](python-api.md) - Complete API documentation
- [**CLI-First Pattern**](python-api.md#cli-driven-pattern-primary) - Recommended approach
- [**Explicit Creation**](python-api.md#explicit-creation-pattern-advanced) - Advanced control
- [**Parameter Management**](python-api.md#parameter-access) - Working with configs and overrides
- [**Result Logging**](python-api.md#result-logging) - Tracking metrics and artifacts

## Advanced Topics

- [**Interactive Comparison**](compare.md) - Deep dive into the comparison tool
- [**Filtering & Search**](filtering.md) - Advanced experiment filtering
- [**Git Integration**](git-integration.md) - How Yanex works with Git
- [**Storage Format**](storage.md) - Understanding Yanex's data format

## Examples

- [**Basic Usage Examples**](../examples/) - Simple experiment scripts
- [**Workflows**](workflows.md) - Common research workflows with Yanex
- [**Parameter Sweeps**](parameter-sweeps.md) - Hyperparameter optimization patterns

## Troubleshooting

- [**Common Issues**](troubleshooting.md) - Solutions to common problems
- [**FAQ**](faq.md) - Frequently asked questions

## Contributing

- [**Development Guide**](development.md) - Setting up development environment
- [**Architecture**](architecture.md) - Understanding Yanex's design
- [**Testing**](testing.md) - Running and writing tests

---

**Need help?** 
- Check the [FAQ](faq.md)
- Browse [examples](../examples/)
- Open an issue on [GitHub](https://github.com/your-org/yanex)