bloqade.core.device.task.ParameterScanTask

← Module overview

classParameterScanTask¶source

bloqade.core.device.task.ParameterScanTask

Bases: TaskABC[FutureType]

Task that runs one kernel against multiple argument sets.

Signature

class ParameterScanTask(*, context_name: str, qpu_mode: str | None = None, program_language: str, language_version: str = '0.1.0', kernel_serializer: KernelSerializer = JSONSerializer(), group: str | None = None, profile_id: str | UUID | None = None, future_cls: type[FutureType] = Future, kernel: ir.Method, arguments: list[dict], num_shots: int | list[int], metadata: list[dict] | None = None)

Public import paths

• from bloqade.core.device.device import ParameterScanTask

Each entry in arguments becomes a subtask. The same program is reused for every subtask.

Parameters

Name	Type	Default	Description
context_name	str	required
qpu_mode	str | None	None
program_language	str	required
language_version	str	'0.1.0'
kernel_serializer	KernelSerializer	JSONSerializer()
group	str | None	None
profile_id	str | UUID | None	None
future_cls	type[FutureType]	Future
kernel	ir.Method	required
arguments	list[dict]	required
num_shots	int | list[int]	required
metadata	list[dict] | None	None

Attributes

Name	Type	Description
kernel	ir.Method	Kernel executed for each parameter set.
arguments	list[dict]	Argument dictionaries, one per subtask.
num_shots	int | list[int]	Shot count per subtask, or one value broadcast to every subtask.
metadata	list[dict] | None	Per-subtask metadata. Defaults to None.

propertynum_subtasks¶source

bloqade.core.device.task.ParameterScanTask.num_subtasks

num_subtasks: int

source

methodget_kernels¶source

bloqade.core.device.task.ParameterScanTask.get_kernels

def get_kernels() -> list[ir.Method]

Returns

list[ir.Method]

source

methodget_arguments¶source

bloqade.core.device.task.ParameterScanTask.get_arguments

def get_arguments() -> list[dict]

Returns

list[dict]

source

methodget_num_shots¶source

bloqade.core.device.task.ParameterScanTask.get_num_shots

def get_num_shots() -> list[int]

Returns

list[int]

source

methodget_metadata¶source

bloqade.core.device.task.ParameterScanTask.get_metadata

def get_metadata() -> list[dict] | None

Returns

list[dict] | None

source

methodprogram_index_for_subtask¶source

bloqade.core.device.task.ParameterScanTask.program_index_for_subtask

def program_index_for_subtask(i: int) -> int

Parameters

Name	Type	Description
i	int

Returns

int

source

methodsummary¶source

bloqade.core.device.task.ParameterScanTask.summary

def summary() -> str

Returns

str

source