API 使用总览
本页按任务列出公共入口、返回形式和对应参考页。普通线路工作流从 unitarylab 顶层导入;算法和应用能力从 unitarylab.library 及其子模块导入。
线路与寄存器
from unitarylab import Circuit, Register, ClassicalRegister| 任务 | 入口 | 返回或行为 | 文档 |
|---|---|---|---|
| 创建线路 | Circuit(...) | 新 Circuit | 创建线路与寄存器 |
| 添加门或线路测量 | h()、cx()、measure() 等 | 原地修改线路 | 量子门与测量 |
| 复制、求逆或展开 | copy()、inverse()、decompose() 等 | 新 Circuit | 线路变换 |
| 组合或初始化 | append()、prepend()、initialize() | 原地修改线路 | 线路变换 |
执行与结果
| 任务 | 入口 | 返回值 | 文档 |
|---|---|---|---|
| 纯态或 MPS 执行 | Circuit.execute() | ExecutionResult | 执行线路与查看结果 |
| 密度矩阵执行 | Circuit.execute_density() | DensityMatrixResult | 密度矩阵与噪声模型 |
| 选择执行实现和设备 | backend、device、dtype | 执行配置 | 执行后端与参数 |
| 概率、采样和期望值 | probability()、sample()、expectation() | 标量、字典或列表 | 执行线路与查看结果 |
execute() 的 shots 表示整条含线路测量程序的重复执行次数。ExecutionResult.sample() 从已有结果分布采样,不会重新执行线路。
绘图、分析与格式转换
| 任务 | 入口 | 返回值 | 文档 |
|---|---|---|---|
| 绘制线路 | Circuit.draw() | 绘图对象或文本表示 | 线路分析与绘图 |
| 分析线路 | Circuit.analyze() | CircuitInfo | 线路分析与绘图 |
| 导入或导出 OpenQASM | from_qasm*()、to_qasm*() | Circuit、字符串或文件 | OpenQASM 与 Python 导入导出 |
| 生成 Python 重建代码 | to_python*() | 字符串或文件 | OpenQASM 与 Python 导入导出 |
编译与真机
from unitarylab import QCompiler, CompileConfig, CompilationResult, HardwareResult| 阶段 | 入口 | 返回值 | 是否提交任务 |
|---|---|---|---|
| 规则优化 | Circuit.optimize() | 新 Circuit | 否 |
| 门基转译 | Circuit.transpile() | 新 Circuit | 否 |
| 映射与编译 | Circuit.compile() | CompilationResult | 否 |
| 真机提交 | Circuit.submit() | HardwareResult | 是 |
编译和提交的参数、凭据及额度风险见线路优化与编译和真机任务提交。
算法顶层入口
from unitarylab.library import (
QFT, IQFT, QPE, LCU,
block_encode, hamiltonian_simulation, solve,
QSVT, QSP, QSP_hamiltonian_simulation,
)| 返回形式 | 入口 |
|---|---|
Circuit | QFT()、IQFT()、LCU() |
| 线路或三元组 | QPE() |
| 结果对象 | block_encode()、hamiltonian_simulation()、solve()、QSVT() |
| 低层线路或元组 | QSP()、QSP_hamiltonian_simulation() |
参数和返回字段见算法库概览。
应用子模块
| 任务 | 模块 | 主要返回形式 |
|---|---|---|
| Pauli 分解和线路构造 | unitarylab.library.pauli_operator | 列表、矩阵或 Circuit |
| Fermi–Hubbard 工具 | unitarylab.library.fermi_hubbard | 字典、字符串或结果对象 |
| Ising/QUBO 求解 | unitarylab.library.qubocore | 字典 |
| PDE 求解 | unitarylab.library.equation | 字典和生成文件 |
| 量子机器学习 | unitarylab.library.qml | PyTorch 张量、模型和训练记录 |
| 量子化学扩展 | unitarylab_chemistry | 分阶段结果对象 |
对应页面分别为 Pauli 工具、Fermi–Hubbard 工具、QUBO 与 Ising 求解、PDE 求解框架、QML 概览与后端和量子化学扩展。
最后更新于