openworld_radio_twin.dataset#

High-level Python interface for reproducible dataset generation.

Functions

generate_dataset(source, *[, output_root, ...])

Generate a dataset without starting the web service.

generate_dataset_sync(source, *[, ...])

Generate, resume, or deterministically extend a dataset from a normal script.

load_dataset_request(source)

Validate a model, mapping, or JSON file as a batch dataset request.

plan_dataset(source)

Expand a dataset request without provider access or solver execution.

Classes

DatasetGenerationResult(output_directory, plan)

Completed dataset location together with its deterministic expanded plan.

class openworld_radio_twin.dataset.DatasetGenerationResult(output_directory, plan)[source]#

Bases: object

Completed dataset location together with its deterministic expanded plan.

output_directory: Path#
plan: BatchPlan#
property manifest_path: Path#
read_manifest()[source]#

Read the completed dataset manifest.

Return type:

dict[str, Any]

openworld_radio_twin.dataset.load_dataset_request(source)[source]#

Validate a model, mapping, or JSON file as a batch dataset request.

Return type:

BatchDatasetRequest

openworld_radio_twin.dataset.plan_dataset(source)[source]#

Expand a dataset request without provider access or solver execution.

Return type:

BatchPlan

async openworld_radio_twin.dataset.generate_dataset(source, *, output_root=None, settings=None, progress=None, resume=False)[source]#

Generate a dataset without starting the web service.

The function owns and closes its HTTP client and worker thread. Use this asynchronous entry point from notebooks, services, or existing event loops. For ordinary scripts, use generate_dataset_sync(). Set resume=True to skip complete cases and regenerate missing cases in a compatible existing dataset.

Return type:

DatasetGenerationResult

openworld_radio_twin.dataset.generate_dataset_sync(source, *, output_root=None, settings=None, progress=None, resume=False)[source]#

Generate, resume, or deterministically extend a dataset from a normal script.

Return type:

DatasetGenerationResult