SynthesizerModel#

class sdgx.models.base.SynthesizerModel(*args, **kwargs)[source]#

Bases: object

_check_access_type()[source]#
fit(metadata: Metadata, dataloader: DataLoader, *args, **kwargs)[source]#

Fit the model using the given metadata and dataloader.

Parameters:

  • metadata (Metadata) – The metadata to use.

  • dataloader (DataLoader) – The dataloader to use.

classmethod load(save_dir: str | Path, **kwargs) → SynthesizerModel[source]#

Load model from file.

Parameters:

save_dir (str | Path) – The directory to load the model from.

sample(count: int, *args, **kwargs) → DataFrame[source]#

Sample data from the model.

Parameters:

count (int) – The number of samples to generate.

Returns:

The generated data.

Return type:

pd.DataFrame

save(save_dir: str | Path)[source]#

Dump model to file.

Parameters:

save_dir (str | Path) – The directory to save the model.

use_dataloader: bool = False#
use_raw_data: bool = False#