# GlassAlpha Example Configurations

This directory contains example configurations for GlassAlpha ML audits. Configurations are organized into two categories:

## Runnable Examples

These configurations work out-of-the-box with built-in datasets. Perfect for getting started quickly:

### Core Examples

- **`german_credit.yaml`** - Complete audit with fairness analysis (recommended for first audit)
- **`german_credit_simple.yaml`** - Basic metrics only, faster execution
- **`adult_income.yaml`** - Income prediction with comprehensive fairness analysis
- **`minimal.yaml`** - Minimal 8-line configuration (quickest start)

### Specialized Examples

- **`quickstart.yaml`** - Generated by `glassalpha quickstart` command
- **`production.yaml`** - Production-ready configuration with strict mode
- **`healthcare_outcomes.yaml`** - Healthcare domain example

**Usage:**

```bash
glassalpha audit --config german_credit.yaml --output german_credit_audit.html
```

## Templates

These are customizable templates that require your own data. They demonstrate specific domains or use cases:

- **`credit_card_fraud_template.yaml`** - Fraud detection domain
- **`folktables_income_template.yaml`** - Census data analysis
- **`custom_template.yaml`** - Comprehensive template for any custom dataset

**Usage:**

```bash
# 1. Copy the template
cp credit_card_fraud_template.yaml my_fraud_config.yaml

# 2. Edit the file to use your data
# Replace /path/to/creditcard.csv with your actual data file

# 3. Validate and run
glassalpha validate --config my_fraud_config.yaml
glassalpha audit --config my_fraud_config.yaml
```

## Tips

- **Start with runnable examples** to understand GlassAlpha
- **Use templates** when you have your own datasets
- **Always validate configs** before running audits: `glassalpha validate --config <file>`
- **Check logs** for warnings about missing features or incompatible settings

## Need Help?

- [Quickstart Guide](https://glassalpha.com/getting-started/quickstart/)
- [Custom Data Guide](https://glassalpha.com/getting-started/custom-data/)
- [Configuration Reference](https://glassalpha.com/getting-started/configuration/)
