API Documentation
API Documentation
API Reference Overview
Module | Object Name | Creation Method | Main Methods |
---|---|---|---|
Executor | Executor | Executor(config) | run() , get_result() , get_timing() |
Loader | Loader | Loader(filepath, **kwargs) | load() |
Metadater | Metadater | Metadater.create_schema() | create_schema() , validate_schema() |
Splitter | Splitter | Splitter(**kwargs) | split() |
Processor | Processor | Processor(metadata, config) | fit() , transform() , inverse_transform() |
Synthesizer | Synthesizer | Synthesizer(**kwargs) | create() , fit_sample() |
Constrainer | Constrainer | Constrainer(config) | apply() , resample_until_satisfy() |
Evaluator | Evaluator | Evaluator(**kwargs) | create() , eval() |
Describer | Describer | Describer(**kwargs) | create() , eval() |
Reporter | Reporter | Reporter(method, **kwargs) | create() , report() |
Adapter | *Adapter | *Adapter(config) | run() , set_input() , get_result() |
Config | Config | Config(config_dict) | Auto-processing during init |
Status | Status | Status(config) | put() , get_result() , create_snapshot() |
Utils | Functions | Direct import | load_external_module() |
Configuration & Execution
- Executor - The main interface for experiment pipeline
Data Management
- Metadater - Dataset schema and metadata management
Pipeline Components
- Loader - Data loading and handling
- Splitter - Data splitting for experiments
- Processor - Data preprocessing and postprocessing
- Synthesizer - Synthetic data generation
- Constrainer - Data constraint handler for synthetic data
- Evaluator - Privacy, fidelity, and utility assessment
- Describer - Descriptive data summary
- Reporter - Results export and reporting