Synthesis

TargetLanguage

Enum specifying the output format for export. Attributes:

Name	Type	Description
`QASM2`	`'qasm2'`
`QASM3`	`'qasm3'`
`QIR`	`'qir'`
`CIRQ_JSON`	`'cirq_json'`
`QSHARP`	`'qsharp'`
`QASM2`	“	OpenQASM 2.0 (default).
`QASM3`	“	OpenQASM 3.0.
`QIR`	“	Quantum Intermediate Representation (QIR).
`CIRQ_JSON`	“	Cirq JSON format.
`QSHARP`	“	Q# (QSharp).

TranspilationConfig

Configuration for transpiling a quantum program to a target basis gate set and qubit connectivity. Pass a TranspilationConfig to the transpilation_config parameter of export to apply hardware-aware transpilation during export. Attributes:

Name	Type	Description
`kind`	`Literal['transpilation']`
`transpilation_level`	`TranspilationOption`	The transpilation strategy to apply. Defaults to `TranspilationOption.AUTO_OPTIMIZE`.
`basis_gates`	`list[str] \| None`	The target gate set to decompose the circuit into. If `None`, defaults to single-qubit gates + `cx`. When a `connectivity_map` is provided, defaults to single-qubit gates + `cx`.
`connectivity_map`	`ConnectivityMap \| None`	Qubit connectivity constraints of the target hardware - a list of allowed qubit-pair connections. If `None`, no routing is applied.
`is_symmetric_connectivity`	`bool`	Whether the connectivity map is symmetric (i.e., if `(i, j)` is allowed then `(j, i)` is also allowed). Defaults to `True`.

FaultTolerantTranspilationConfig

Configuration for fault-tolerant transpilation using Clifford+T gate approximation. Pass a FaultTolerantTranspilationConfig to the transpilation_config parameter of export to perform fault-tolerant transpilation in two stages:

The circuit is first decomposed into the Clifford+T+RZ gate set (h, t, s, tdg, cx, rz).
The remaining RZ gates are then approximated using the gridsynth algorithm, which finds an efficient Clifford+T sequence achieving the target rotation within the specified error bound.

Attributes:

Name	Type	Description
`kind`	`Literal['fault_tolerant']`
`transpilation_level`	`TranspilationOption`	The transpilation strategy to apply. Defaults to `TranspilationOption.AUTO_OPTIMIZE`.
`clifford_t_approximation_error`	`float`	The maximum total approximation error for the whole circuit. This budget is divided equally across all RZ gates, so each gate is approximated with a per-gate error of `clifford_t_approximation_error / num_rz_gates`. Smaller values yield more accurate circuits at the cost of greater depth.
`keep_hierarchy`	`bool`	When `True`, each unique RZ-angle decomposition is emitted as a named custom gate (`rz_approx_0`, `rz_approx_1`, …) in the target language, and every occurrence of that angle references the gate definition instead of inlining the Clifford+T sequence. When `False` (the default), the decomposition is inlined to produce a flat circuit.

QuantumProgram

Methods:

Name	Description
to_base_program
to_program
save_results	Saves quantum program results as json into a file.
get_debug_info
raise_warnings	Raises all warnings that were collected during synthesis.

Attributes:

Name	Type	Description
`hardware_data`	`SynthesisHardwareData`
`data`	`GeneratedCircuitData`
`model`	`ExecutionModel`
`transpiled_circuit`	`TranspiledCircuitData \| None`
`creation_time`	`str`
`compressed_debug_info`	`bytes \| None`
`program_id`	`str`
`execution_primitives_input`	`PrimitivesInput \| None`
`synthesis_warnings`	`list[str] \| None`
`compressed_compiled_qmod`	`bytes \| None`
`program_circuit`	`CircuitCodeInterface`
`has_compiled_qmod`	`bool`
`compiled_qmod`	`Model \| None`
`qasm`	`Code \| None`

to_base_program

to_base_program(
self:
) -> quantum_code.QuantumBaseCode

Parameters:

Name	Type	Description	Default
`self`	“		required

to_program

to_program(
self: ,
instruction_set: QuantumInstructionSet | None = None
) -> quantum_code.QuantumCode

Parameters:

Name	Type	Description	Default
`self`	“		required
`instruction_set`	`QuantumInstructionSet \| None`		None

save_results

save_results(
self: ,
filename: str | Path | None = None
) -> None

Saves quantum program results as json into a file. Parameters: filename (Union[str, Path]): Optional, path + filename of file. If filename supplied add .json suffix. Returns: None Parameters:

Name	Type	Description	Default
`self`	“		required
`filename`	`str \| Path \| None`		None

get_debug_info

get_debug_info(
self:
) -> list[FunctionDebugInfoInterface] | None

Parameters:

Name	Type	Description	Default
`self`	“		required

raise_warnings

raise_warnings(
self:
) -> None

Raises all warnings that were collected during synthesis. Parameters:

Name	Type	Description	Default
`self`	“		required

Preferences

Preferences for synthesizing a quantum circuit. Methods:

Name	Description
optimization_timeout_less_than_generation_timeout
make_output_format_list
validate_output_format
validate_backend_name
validate_backend

Attributes:

Name	Type	Description
`synthesize_all_separately`	`bool`
`symbolic_loops`	`bool`
`compatibility_mode`	`bool`
`backend_preferences`	`BackendPreferences \| None`
`machine_precision`	`int`	Specifies the precision used for quantum operations. Defaults to `DEFAULT_MACHINE_PRECISION`.
`backend_service_provider`	`str`	The provider company or cloud service for the requested backend. Defaults to `None`.
`backend_name`	`str`	The name of the requested backend or target. Defaults to `None`.
`custom_hardware_settings`	`CustomHardwareSettings`	Defines custom hardware settings for optimization. This field is ignored if backend preferences are specified.
`debug_mode`	`bool`	If `True`, debug information is added to the synthesized result, potentially slowing down the synthesis. Useful for executing interactive algorithms. Defaults to `True`.
`optimization_level`	`OptimizationLevel)`	The optimization level used during synthesis (0-3);
`output_format`	`List[QuantumFormat]`	Lists the output format(s) for the quantum circuit. Defaults to `[QuantumFormat.QASM]`. `QuantumFormat` Options: - QASM = “qasm” - QSHARP = “qsharp” - QIR = “qir” - IONQ = “ionq” - CIRQ_JSON = “cirq_json” - QASM_CIRQ_COMPATIBLE = “qasm_cirq_compatible”
`qasm3`	`Optional[bool]`	If `True`, outputs OpenQASM 3.0 in addition to 2.0, applicable to relevant attributes in `GeneratedCircuit`. Defaults to `None`.
`transpilation_option`	`TranspilationOption`	Sets the transpilation option to optimize the circuit. Defaults to `AUTO_OPTIMIZE`. See `TranspilationOption`
`solovay_kitaev_max_iterations`	`Optional[int]`	Specifies the maximum number of iterations for the Solovay-Kitaev algorithm, if used. Defaults to `None`.
`timeout_seconds`	`int`	Timeout setting for circuit synthesis in seconds. Defaults to `300`.
`optimization_timeout_seconds`	`Optional[int]`	Specifies the timeout for optimization in seconds, or `None` for no optimization timeout. This will still adhere to the overall synthesis timeout. Defaults to `None`.
`random_seed`	`int`	Random seed for circuit synthesis.

optimization_timeout_less_than_generation_timeout

optimization_timeout_less_than_generation_timeout(
cls: ,
optimization_timeout_seconds: pydantic.PositiveInt | None,
info: ValidationInfo
) -> pydantic.PositiveInt | None

Parameters:

Name	Type	Default
`cls`	“	required
`optimization_timeout_seconds`	`pydantic.PositiveInt \| None`	required
`info`	`ValidationInfo`	required

make_output_format_list

make_output_format_list(
cls: ,
output_format: Any
) -> list

Parameters:

Name	Type	Description	Default
`cls`	“		required
`output_format`	`Any`		required

validate_output_format

validate_output_format(
cls: ,
output_format: PydanticConstrainedQuantumFormatList,
info: ValidationInfo
) -> PydanticConstrainedQuantumFormatList

Parameters:

Name	Type	Default
`cls`	“	required
`output_format`	`PydanticConstrainedQuantumFormatList`	required
`info`	`ValidationInfo`	required

validate_backend_name

validate_backend_name(
cls: ,
backend_name: str | None
) -> str | None

Parameters:

Name	Type	Description	Default
`cls`	“		required
`backend_name`	`str \| None`		required

validate_backend

validate_backend(
self:
) -> Self

Parameters:

Name	Type	Description	Default
`self`	“		required

Constraints

Constraints for the quantum circuit synthesis engine. This class is used to specify constraints such as maximum width, depth, gate count, and optimization parameters for the synthesis engine, guiding the generation of quantum circuits that satisfy these constraints. Attributes:

Name	Type	Description
`max_width`	`int`	Maximum number of qubits allowed in the generated quantum circuit. Defaults to `None`.
`optimization_parameter`	`OptimizationParameterType`	Determines if and how the synthesis engine should optimize the solution. Defaults to `NO_OPTIMIZATION`. See `OptimizationParameterType`

Functions:

Name	Description
`write_qmod`	Creates a native Qmod file from a serialized model and outputs the synthesis options (Preferences and Constraints) to a file.

write_qmod

write_qmod(
model: SerializedModel | QFunc | GenerativeQFunc,
name: str,
directory: Path | None = None,
decimal_precision: int = DEFAULT_DECIMAL_PRECISION,
symbolic_only: bool = True
) -> None

Creates a native Qmod file from a serialized model and outputs the synthesis options (Preferences and Constraints) to a file. The native Qmod file may be uploaded to the Classiq IDE. Parameters:

Name	Type	Description	Default
`model`	`SerializedModel \| QFunc \| GenerativeQFunc`	The entry point of the Qmod model - a qfunc named ‘main’ (or alternatively the output of ‘create_model’).	required
`name`	`str`	The name to save the file by.	required
`directory`	`Path \| None`	The directory to save the files in. If None, the current working directory is used.	None
`decimal_precision`	`int`	The number of decimal places to use for numbers, set to 4 by default.	DEFAULT_DECIMAL_PRECISION
`symbolic_only`	`bool`	If True keep function definitions un-expanded and symbolic (note that Qmod functions with parameters of Python types are not supported in this mode)	True

Returns:

Type: None

Functions

synthesize

synthesize(
model: SerializedModel | BaseQFunc,
auto_show: bool = False,
constraints: Constraints | None = None,
preferences: Preferences | None = None
) -> QuantumProgram

Synthesize a model with the Classiq engine to receive a quantum program. More details Parameters:

Name	Type	Description	Default
`model`	`SerializedModel \| BaseQFunc`	The entry point of the Qmod model - a qfunc named ‘main’ (or alternatively the output of ‘create_model’).	required
`auto_show`	`bool`	Whether to ‘show’ the synthesized model (False by default).	False
`constraints`	Constraints \| None	Constraints for the synthesis of the model. See Constraints (Optional).	None
`preferences`	Preferences \| None	Preferences for the synthesis of the model. See Preferences (Optional).	None

Returns:

Type: QuantumProgram
Quantum program. (See: QuantumProgram)

show

show(
quantum_program: QuantumProgram,
display_url: bool = True
) -> None

Displays the interactive representation of the quantum program in the Classiq IDE. Parameters:

Name	Type	Description	Default
`quantum_program`	QuantumProgram	The quantum program to be displayed.	required
`display_url`	`bool`	Whether to print the url	True

assign_parameters

assign_parameters(
quantum_program: QuantumProgram,
parameters: ExecutionParams
) -> QuantumProgram

Assign parameters to a parametric quantum program. Parameters:

Name	Type	Description	Default
`quantum_program`	QuantumProgram	The quantum program to be assigned. This is the result of the synthesize method.	required
`parameters`	`ExecutionParams`	The parameter assignments.	required

Returns:

Type: QuantumProgram
The quantum program after assigning parameters.

export

export(
quantum_program: QuantumProgram,
target_language: TargetLanguage | None = TargetLanguage.QASM2,
transpilation_config: TranspilationConfig | FaultTolerantTranspilationConfig | None | Literal[True] = None
) -> str

Export a quantum program as a circuit string in the requested target language. Non-angle runtime parameters (e.g. integers that affect circuit structure such as repeat counts) must be assigned first using assign_parameters. Parameters:

Name	Type	Description	Default
`quantum_program`	QuantumProgram	The quantum program to export. This is the result of `synthesize`.	required
`target_language`	TargetLanguage \| None	The target language to export to. Defaults to `TargetLanguage.QASM2`.	TargetLanguage.QASM2
`transpilation_config`	TranspilationConfig \| FaultTolerantTranspilationConfig \| None \| Literal[True]	Transpilation configuration. Pass a `TranspilationConfig` or `FaultTolerantTranspilationConfig` to apply transpilation during export. Pass `True` to reuse the transpilation settings from the quantum program. Pass `None` to skip transpilation and export the circuit as synthesized. Defaults to `None`.	None

Returns:

Type: str
The exported circuit code as a string.

get_circuit_metrics

get_circuit_metrics(
quantum_program: QuantumProgram
) -> CircuitMetrics

Get the logical resource estimation (width, depth and gate counts) of a quantum program. For parametric programs, depth and gate counts may be returned as symbolic string expressions (e.g. "n + 1") instead of integers. Parameters:

Name	Type	Description	Default
`quantum_program`	QuantumProgram	The quantum program to estimate. This is the result of the synthesize method.	required

Returns:

Type: CircuitMetrics
The logical width, depth and gate counts of the quantum program.

get_transpiled_circuit_metrics

get_transpiled_circuit_metrics(
quantum_program: QuantumProgram
) -> CircuitMetrics

Get the hardware resource estimation (width, depth and gate counts) of a transpiled quantum program. Parameters:

Name	Type	Description	Default
`quantum_program`	QuantumProgram	The quantum program to estimate. This should be a transpiled quantum program.	required

Returns:

Type: CircuitMetrics
The width, depth and gate counts of the transpiled program.

set_preferences

set_preferences(
serialized_model: SerializedModel,
preferences: Preferences | None = None,
kwargs: Any = 
) -> SerializedModel

Overrides the preferences of a (serialized) model and returns the updated model. Parameters:

Name	Type	Description	Default
`serialized_model`	`SerializedModel`	The model in serialized form.	required
`preferences`	Preferences \| None	The new preferences to be set for the model. Can be passed as keyword arguments.	None
`kwargs`	`Any`

Returns:

Type: SerializedModel
The updated model with the new preferences applied.

set_execution_preferences

set_execution_preferences(
serialized_model: SerializedModel,
execution_preferences: ExecutionPreferences | None = None,
kwargs: Any = 
) -> SerializedModel

Overrides the execution preferences of a (serialized) model and returns the updated model. Parameters:

Name	Type	Description	Default
`serialized_model`	`SerializedModel`	A serialization of the defined model.	required
`execution_preferences`	`ExecutionPreferences \| None`	The new execution preferences to be set for the model. Can be passed as keyword arguments.	None
`kwargs`	`Any`

set_constraints

set_constraints(
serialized_model: SerializedModel,
constraints: Constraints | None = None,
kwargs: Any = 
) -> SerializedModel

Overrides the constraints of a (serialized) model and returns the updated model. Parameters:

Name	Type	Description	Default
`serialized_model`	`SerializedModel`	The model in serialized form.	required
`constraints`	Constraints \| None	The new constraints to be set for the model. Can be passed as keyword arguments.	None
`kwargs`	`Any`

Returns:

Type: SerializedModel
The updated model with the new constraints applied.

create_model

create_model(
entry_point: QFunc | GenerativeQFunc,
constraints: Constraints | None = None,
execution_preferences: ExecutionPreferences | None = None,
preferences: Preferences | None = None,
classical_execution_function: CFunc | None = None,
out_file: str | None = None
) -> SerializedModel

Create a serialized model from a given Qmod entry function and additional parameters. Parameters:

Name	Type	Description	Default
`entry_point`	`QFunc \| GenerativeQFunc`	The entry point function for the model, which must be a QFunc named ‘main’.	required
`constraints`	Constraints \| None	Constraints for the synthesis of the model. See Constraints (Optional).	None
`execution_preferences`	`ExecutionPreferences \| None`	Preferences for the execution of the model. See ExecutionPreferences (Optional).	None
`preferences`	Preferences \| None	Preferences for the synthesis of the model. See Preferences (Optional).	None
`classical_execution_function`	`CFunc \| None`	A function for the classical execution logic, which must be a CFunc (Optional).	None
`out_file`	`str \| None`	File path to write the Qmod model in native Qmod representation to (Optional).	None

Returns:

Type: SerializedModel
A serialized model.

qasm_to_qmod

qasm_to_qmod(
qasm: str,
qmod_format: QmodFormat
) -> str

Decompiles QASM to Native/Python Qmod. Returns Qmod code as a string. Native Qmod can be synthesized in the Classiq IDE, while Python Qmod can be copy-pasted to a Python file (.py) and synthesized by calling synthesize(main). Parameters:

Name	Type	Description	Default
`qasm`	`str`	QASM 2 or QASM 3 code	required
`qmod_format`	`QmodFormat`	The requested output format	required

Returns:

Type: str
The decompiled Qmod program

Providers

Applications

Qmod

TargetLanguage

TranspilationConfig

FaultTolerantTranspilationConfig

QuantumProgram

to_base_program

to_program

save_results

get_debug_info

raise_warnings

Preferences

optimization_timeout_less_than_generation_timeout

make_output_format_list

validate_output_format

validate_backend_name

validate_backend

Constraints

write_qmod

Functions

synthesize

show

assign_parameters

export

get_circuit_metrics

get_transpiled_circuit_metrics

set_preferences

set_execution_preferences

set_constraints

create_model

qasm_to_qmod

​TargetLanguage

​TranspilationConfig

​FaultTolerantTranspilationConfig

​QuantumProgram

​to_base_program

​to_program

​save_results

​get_debug_info

​raise_warnings

​Preferences

​optimization_timeout_less_than_generation_timeout

​make_output_format_list

​validate_output_format

​validate_backend_name

​validate_backend

​Constraints

​write_qmod

​Functions

​synthesize

​show

​assign_parameters

​export

​get_circuit_metrics

​get_transpiled_circuit_metrics

​set_preferences

​set_execution_preferences

​set_constraints

​create_model

​qasm_to_qmod

TargetLanguage

TranspilationConfig

FaultTolerantTranspilationConfig

QuantumProgram

to_base_program

to_program

save_results

get_debug_info

raise_warnings

Preferences

optimization_timeout_less_than_generation_timeout

make_output_format_list

validate_output_format

validate_backend_name

validate_backend

Constraints

write_qmod

Functions

synthesize

show

assign_parameters

export

get_circuit_metrics

get_transpiled_circuit_metrics

set_preferences

set_execution_preferences

set_constraints

create_model

qasm_to_qmod