Skip to content
voiage

voiage.cli.create_distributed_large_scale

create_distributed_large_scale

Section titled “create_distributed_large_scale”
create_distributed_large_scale([positional or keyword] net_benefit_file: Path = typer.Argument(..., exists=True, file_okay=True, dir_okay=False, readable=True, help='Path to CSV containing net benefits (samples x strategies)'), [positional or keyword] parameter_file: Path | None = typer.Option(None, '--parameters', help='Optional CSV containing parameter samples'), [positional or keyword] chunk_size: int = typer.Option(10000, '--chunk-size', help='Chunk size for distributed execution'), [positional or keyword] n_nodes: int = typer.Option(1, '--n-nodes', help='Number of CPU nodes to target'), [positional or keyword] workers_per_node: int | None = typer.Option(None, '--workers-per-node', help='Workers to use on each node'), [positional or keyword] scheduler: str = typer.Option('process', '--scheduler', help='Execution scheduler adapter (process, thread, dask, ray, fpga, or asic)'), [positional or keyword] scheduler_address: str | None = typer.Option(None, '--scheduler-address', help='Optional remote scheduler address'), [positional or keyword] use_processes: bool = typer.Option(True, '--use-processes/--use-threads', help='Prefer process-based workers'), [positional or keyword] memory_limit_mb: float | None = typer.Option(None, '--memory-limit-mb', help='Optional memory limit per worker'), [positional or keyword] output_file: Path | None = typer.Option(None, '--output', '-o', help='File to save the distributed config payload')) -> None

Prepare a distributed large-scale analysis and emit the cluster plan.

Parameters:

  • net_benefit_file Path (default: typer.Argument(..., exists=True, file_okay=True, dir_okay=False, readable=True, help='Path to CSV containing net benefits (samples x strategies)'))
  • parameter_file Path | None (default: typer.Option(None, '--parameters', help='Optional CSV containing parameter samples'))
  • chunk_size int (default: typer.Option(10000, '--chunk-size', help='Chunk size for distributed execution'))
  • n_nodes int (default: typer.Option(1, '--n-nodes', help='Number of CPU nodes to target'))
  • workers_per_node int | None (default: typer.Option(None, '--workers-per-node', help='Workers to use on each node'))
  • scheduler str (default: typer.Option('process', '--scheduler', help='Execution scheduler adapter (process, thread, dask, ray, fpga, or asic)'))
  • scheduler_address str | None (default: typer.Option(None, '--scheduler-address', help='Optional remote scheduler address'))
  • use_processes bool (default: typer.Option(True, '--use-processes/--use-threads', help='Prefer process-based workers'))
  • memory_limit_mb float | None (default: typer.Option(None, '--memory-limit-mb', help='Optional memory limit per worker'))
  • output_file Path | None (default: typer.Option(None, '--output', '-o', help='File to save the distributed config payload'))

Returns: None