DataDesigner Config

0.5.9 verified Fri May 01 auth: no python

Configuration layer for DataDesigner synthetic data generation. Version 0.5.9, requires Python >=3.10. Provides declarative YAML/JSON-based configuration management for defining synthetic data schemas, constraints, and generation pipelines.

pip install data-designer-config

Common errors

error ModuleNotFoundError: No module named 'data_designer_config' ↓

cause Using hyphens instead of underscores in import statement.

fix

Use from data_designer_config import ... (underscores, not hyphens).

error ConfigSchema.from_yaml() error: 'str' object has no attribute 'read' ↓

cause Passing a file path string directly to from_yaml without opening the file.

fix

Use ConfigSchema.from_yaml('path.yaml') which handles opening internally, or use with open(...) as f: ConfigSchema.from_yaml(f).

Warnings

breaking In version 0.6.0, the YAML schema format changed: fields `distribution` and `nullable` are now nested under `constraints`. Old configs will fail to parse. ↓

fix Update config YAML: wrap distribution and nullable under a 'constraints' key.

deprecated The function `load_json_config` is deprecated as of 0.5.8. Use `load_config` with file extension detection instead. ↓

fix Replace `load_json_config(path)` with `load_config(path)`. The new function auto-detects format.

Imports

ConfigSchema
wrong
```
from data_designer.config import ConfigSchema
```
correct
```
from data_designer_config import ConfigSchema
```
Module uses hyphens but import path uses underscores; older docs may reference wrong package.
load_config
```
from data_designer_config import load_config
```
No common mistake known, but ensure correct underscore usage.

Quickstart

Load a configuration from a YAML file.

from data_designer_config import ConfigSchema, load_config

schema = ConfigSchema.from_yaml('config.yaml')
config = load_config('config.yaml')
print(config)