tidy3d.web.start

Contents

tidy3d.web.start#

class start[source]#

Bases:

Start running an uploaded task.

Parameters:

  • task_id (str) – Unique task ID returned by upload().

  • solver_version (Optional[str] = None) – Solver version override. If omitted, the configured default is used.

  • worker_group (Optional[str] = None) – Worker group override. If omitted, the configured default is used.

  • pay_type (Optional[Union[PayType, str]] = None) – Payment method override. If omitted, the configured default is used.

  • priority (Optional[int] = None) – vGPU queue priority, where 1 is lowest and 10 is highest.

  • vgpu_allocation (Optional[int] = None) – Number of virtual GPUs to allocate for vGPU-license runs.

  • ignore_memory_limit (Optional[bool] = None) – Whether to allow runs above the estimated vGPU allocation limit.

Note

For server-side batch task IDs, priority and vgpu_allocation are forwarded only when explicitly supplied. Configured vGPU defaults are not applied implicitly, and ignore_memory_limit is not supported.