Configuration Files¶
ExpOps projects use YAML configuration files to define project settings, pipeline structure, and execution parameters.
Configuration Files Overview¶
ExpOps projects use two main configuration files:
configs/project_config.yaml(required) - Main project configurationconfigs/cluster_config.yaml(optional) - Cluster execution settings
Project Configuration (project_config.yaml)¶
The main configuration file contains these top-level sections:
metadata: # Project name, description, version
environment: # Virtual environment and dependencies
reproducibility: # Random seed configuration
model: # Model framework, paths, hyperparameters, pipeline, cache
reporting: # Chart entrypoints and probe paths
Key Sections¶
metadata: Project identification (name, description, version)environment: Virtual environment settings with separate requirements for training and reportingreproducibility: Random seed configurationmodel.parameters.pipeline: Pipeline DAG structure and process definitions- See Pipeline Execution for details
model.parameters.cache: Cache backend and KV backend configuration- See Caching & Reproducibility and Backends for details
reporting: Chart entrypoints and chart definitions- See Reporting Features for details
Cluster Configuration (cluster_config.yaml)¶
Optional configuration for distributed execution:
provider: slurm
num_workers: 4
options:
worker_cores: 2
worker_memory: 4GB
queue: normal
walltime: "02:00:00"
See Cluster Configuration for detailed setup instructions.
Quick Reference¶
For detailed information on each configuration section:
- Pipeline Definition: Pipeline Execution
- Process & Step Code: Model Code
- Caching: Caching & Reproducibility
- Backends: Backends
- Reporting/Charts: Reporting Features and Chart Generation
- Cluster Execution: Cluster Configuration and Distributed Computing
Example Configurations¶
See template projects for complete examples:
sklearn-basic: Basic local execution setuppremier-league: Comprehensive setup with cluster configuration and dynamic charts