Reference Documentation¶
Complete reference for configuration, data formats, and constraints.
-
Configuration Options
All configuration parameters explained.
-
Data Formats
Input and output data schemas.
-
Constraints
Operational constraint definitions.
-
Changelog
Version history and changes.
Quick Links¶
Configuration Files¶
| File | Description |
|---|---|
config/config.yaml |
Main configuration |
config/constraints/fleet_constraints.json |
Fleet constraints |
.env |
Environment variables |
pyproject.toml |
Package configuration |
Data Directories¶
| Directory | Contents |
|---|---|
data/raw/ |
Downloaded raw data |
data/processed/ |
Cleaned/transformed data |
data/models/ |
Trained model artifacts |
data/outputs/ |
Generated outputs |
API Endpoints¶
| Endpoint | Method | Description |
|---|---|---|
/health |
GET | Health check |
/api/v1/optimize |
POST | Run optimization |
/api/v1/forecast |
POST | Generate forecasts |
/api/v1/risk/score |
POST | Calculate risk scores |
Environment Variables¶
| Variable | Required | Description |
|---|---|---|
KAGGLE_USERNAME |
Yes* | Kaggle API username |
KAGGLE_KEY |
Yes* | Kaggle API key |
POSTGRES_HOST |
No | Database host |
POSTGRES_PASSWORD |
No | Database password |
REDIS_HOST |
No | Cache host |
LOG_LEVEL |
No | Logging level |
*Required for data download