API Documentation

API Documentation

API Reference Overview

ModuleObject NameCreation MethodMain Methods
ExecutorExecutorExecutor(config)run(), get_result(), get_timing()
LoaderLoaderLoader(filepath, **kwargs)load()
MetadaterMetadaterMetadater.create_schema()create_schema(), validate_schema()
SplitterSplitterSplitter(**kwargs)split()
ProcessorProcessorProcessor(metadata, config)fit(), transform(), inverse_transform()
SynthesizerSynthesizerSynthesizer(**kwargs)create(), fit_sample()
ConstrainerConstrainerConstrainer(config)apply(), resample_until_satisfy()
EvaluatorEvaluatorEvaluator(**kwargs)create(), eval()
DescriberDescriberDescriber(**kwargs)create(), eval()
ReporterReporterReporter(method, **kwargs)create(), report()
Adapter*Adapter*Adapter(config)run(), set_input(), get_result()
ConfigConfigConfig(config_dict)Auto-processing during init
StatusStatusStatus(config)put(), get_result(), create_snapshot()
UtilsFunctionsDirect importload_external_module()

Configuration & Execution

  • Executor - The main interface for experiment pipeline

Data Management

  • Metadater - Dataset schema and metadata management

Pipeline Components

System Components

  • Adapter - Standardized execution wrappers for all modules
  • Config - Experiment configuration management
  • Status - Pipeline state and progress tracking
  • Utils - Core utility functions and external module loading