Executor

Executor(
    config=None
)

Execute pipeline according to configuration with enhanced logging and configuration management.

Parameters

• config (str): Configuration filename (YAML format)

Configuration Options

The executor supports additional configuration options in the YAML file under the Executor section:

Executor:
  log_output_type: "both"    # "stdout", "file", "both"
  log_level: "INFO"          # "DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"
  log_dir: "./logs"          # Directory for log files
  log_filename: "PETsARD_{timestamp}.log"  # Log filename template

# Your experiment configuration
Loader:
  load_data:
    method: "csv"
    path: "data.csv"

Examples

Basic Usage

exec = Executor(config="config.yaml")
exec.run()
results = exec.get_result()

With Timing Analysis

exec = Executor(config="config.yaml")
exec.run()

# Get execution results
results = exec.get_result()

# Get timing information
timing_data = exec.get_timing()
print(timing_data)
# Shows execution time for each module and step

With Custom Logging

# config.yaml with executor settings
exec = Executor(config="config_with_logging.yaml")
exec.run()

Methods

run()

Execute pipeline according to configuration.

Parameters

None

Returns

None. Results are stored in result attribute

get_result()

Retrieve experiment results.

Parameters

None

Returns

• dict: Dictionary containing all experiment results
  • Format: {full_expt_name: result}

get_timing()

Retrieve execution timing records for all modules.

Parameters

None

Returns

• pandas.DataFrame: DataFrame containing timing information with columns:
  • record_id: Unique timing record identifier
  • module_name: Name of the executed module
  • experiment_name: Name of the experiment configuration
  • step_name: Name of the execution step (e.g., ‘run’, ‘fit’, ‘sample’)
  • start_time: Execution start time (ISO format)
  • end_time: Execution end time (ISO format)
  • duration_seconds: Execution duration in seconds (rounded to 2 decimal places by default)
  • duration_precision: Number of decimal places for duration_seconds (default: 2)
  • Additional context fields from the execution

Attributes

• executor_config: Executor-specific configuration (ExecutorConfig object)
• config: Experiment configuration contents (Config object)
• sequence: Module execution order list
• status: Execution status tracking (Status object)
• result: Final results dictionary

Configuration Classes

ExecutorConfig

@dataclass
class ExecutorConfig:
    log_output_type: str = "file"
    log_level: str = "INFO"
    log_dir: str = "."
    log_filename: str = "PETsARD_{timestamp}.log"

Parameters:

• log_output_type: Where to output logs (“stdout”, “file”, “both”)
• log_level: Logging level (“DEBUG”, “INFO”, “WARNING”, “ERROR”, “CRITICAL”)
• log_dir: Directory for storing log files
• log_filename: Log file name template (supports {timestamp} placeholder)