> ## Documentation Index
> Fetch the complete documentation index at: https://docs.wearer.xyz/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart Guide

> Get started with Transfer Learning in minutes

# Quickstart Guide

This guide will help you get started with the Transfer Learning Video Processing Pipeline.

## Installation

### Quick Installation (Recommended)

Use our automated installation scripts:

On macOS/Linux:

```bash theme={null}
chmod +x scripts/install.sh
./scripts/install.sh
```

On Windows:

```cmd theme={null}
scripts\install.bat
```

### Manual Installation

1. Clone the repository:

```bash theme={null}
git clone https://github.com/Wearer-Lab/transfer-learning.git
cd transfer-learning
```

2. Create a virtual environment and install dependencies using UV:

```bash theme={null}
python -m venv .venv
source .venv/bin/activate  # On Windows, use `.venv\Scripts\activate`
pip install uv
uv pip install -e .
```

3. Set up your OpenAI API key:

```bash theme={null}
echo "OPENAI_API_KEY=your-api-key-here" > .env
```

## Basic Usage

### Process a Local Video

Extract frames and analyze content from a local video file:

```bash theme={null}
transfer-learning process-video path/to/video.mp4
```

### Process a YouTube Video

Download and process a YouTube video:

```bash theme={null}
transfer-learning process-youtube "https://youtube.com/watch?v=VIDEO_ID"
```

### Generate a Guide

Generate a step-by-step guide from processed video content:

```bash theme={null}
transfer-learning generate-guide output/processed_data
```

### Complete YouTube Pipeline

Download a YouTube video and generate a guide in one command:

```bash theme={null}
transfer-learning youtube-guide "https://youtube.com/watch?v=VIDEO_ID"
```

## Real-time Monitoring

Monitor processing progress and system performance in real-time:

```bash theme={null}
# Monitor current processing
transfer-learning monitor

# Monitor specific video
transfer-learning monitor --video-id=your_video_id

# View historical metrics
transfer-learning monitor --video-id=your_video_id --show-history
```

The monitoring dashboard provides:

* Processing progress and status
* System resource usage (CPU, Memory, Disk, Network)
* Performance metrics (latency, throughput)
* API statistics
* Custom metrics

## Configuration

Configure the pipeline using environment variables or the config command:

```bash theme={null}
# Show current configuration
transfer-learning config --show

# Reset configuration to defaults
transfer-learning config --reset

# Interactive configuration
transfer-learning config
```

## Next Steps

* [Complete Documentation](https://transfer-learning.wearer.xyz)
* [Advanced Topics](/advanced/monitoring)
* [API Reference](/api-reference/overview)
* [CLI Reference](/cli/overview)

## Support

For help and support:

* Join our [Discord Community](https://wearer.xyz/discord)
* Email us at [contact@wearer.xyz](mailto:contact@wearer.xyz)
* Open an issue on [GitHub](https://github.com/Wearer-Lab/transfer-learning/issues)