fraudtwin.generate#

fraudtwin.generate(config=None, *, write=False, output_dir='runs', profile=None, seed=None, workers=None, checkpoint_dir=None)[source][source]#

Generate a deterministic FraudTwin run.

If config is omitted, the built-in minimal configuration is used. By default, generated data is returned in memory without writing files. Set write=True to preserve the CLI’s Parquet and manifest output layout.

Return type:

GeneratedData | GeneratedRun

Parameters:

  • config (str | Path | SimulationRunConfig | None)

  • write (bool)

  • output_dir (str | Path)

  • profile (str | Path | CalibrationProfile | None)

  • seed (int | None)

  • workers (int | None)

  • checkpoint_dir (str | Path | None)