主要 API {#guide-main-api}¶

本页是 基本用法（Basic Usage）章节 的 API 速查入口：每一行同时给出函数 / 类的 API 参考链接（左列）和它在用户文档中实际出现的章节（右列）。当你只记得函数名、想直接跳到使用说明时，从本页进入比从 API 参考树进入更快。

完整、按模块组织的自动生成 API 树见 API 参考。

线路构建¶

API	在哪个用户文档章节中使用
`uniqc.Circuit`	主路径走读 · 1. 构造电路 · 构造电路 · 基本用法
`Circuit.h` / `Circuit.x` / `Circuit.cnot` …	构造电路 · 量子门
`Circuit.measure`	构造电路 · 基本用法
`Circuit.control` / `Circuit.dagger`	构造电路 · 控制结构
`Circuit.originir` / `Circuit.qasm`	构造电路 · 格式互转
`Circuit.unitary`	构造电路 · 提取酉矩阵
`uniqc.QReg` / `uniqc.QRegSlice`	构造电路 · 命名量子寄存器
`uniqc.Parameter` / `uniqc.Parameters`	构造电路 · 参数化电路
`uniqc.NamedCircuit` / `uniqc.circuit_def()`	构造电路 · Named Circuit

本地模拟¶

API	在哪个用户文档章节中使用
`uniqc.simulator.Simulator`	本地模拟 · OriginIR 模拟器 · 主路径走读 · 2. 本地模拟
`uniqc.simulator.Simulator`	本地模拟 · QASM 模拟器
`uniqc.simulator.OpcodeSimulator`	本地模拟 · Opcode 模拟器 · Opcode（进阶）
`uniqc.simulator.NoisySimulator`	本地模拟 · 带噪声的本地模拟 · 噪声模拟（进阶）
`simulate_pmeasure` / `simulate_statevector` / `simulate_shots`	本地模拟 · OriginIR 模拟器
`uniqc.simulator.create_simulator()`	本地模拟 · 入口总览
`uniqc.simulator.backend_alias()`	本地模拟 · 入口总览
`MPSSimulator` / `MPSConfig`	MPS 模拟器（进阶）
`TorchQuantumSimulator`	PyTorch 集成

提交任务到云平台¶

API	在哪个用户文档章节中使用
`uniqc.submit_task()`	主路径走读 · 3. 提交与后处理 · 提交任务 · 通用流程 · 提交任务 · 完整 API 参考
`uniqc.submit_batch()`	提交任务 · 批量提交
`uniqc.dry_run_task()`	主路径走读 · 真机提交模板 · 提交任务 · 通用流程
`uniqc.wait_for_result()`	主路径走读 · 3. 提交与后处理 · 提交任务 · 通用流程
`uniqc.query_task()`	提交任务 · 通用流程
`uniqc.OriginQOptions` / `uniqc.IBMOptions` / `uniqc.QuarkOptions` / `uniqc.DummyOptions`	提交任务 · 完整 API 参考 · 编译选项 · 类型化后端选项
`uniqc.BackendOptions` / `uniqc.BackendOptionsFactory`	编译选项 · 类型化后端选项
`uniqc.UnifiedResult`	提交任务 · 结果处理
`uniqc.TaskInfo` / `uniqc.TaskStatus`	提交任务 · 结果处理

任务管理与本地缓存¶

API	在哪个用户文档章节中使用
`uniqc.TaskManager`	任务管理器 · 概述
`uniqc.list_tasks()` / `uniqc.get_task()`	任务管理器 · 任务管理
`uniqc.clear_completed_tasks()` / `uniqc.clear_cache()`	任务管理器 · 任务管理

后端发现¶

API	在哪个用户文档章节中使用
`uniqc.list_backends()` / `uniqc.find_backend()` / `uniqc.fetch_all_backends()`	`uniqc backend` · 平台约定 · 统一后端工厂
`uniqc.get_backend()`	平台约定 · 统一后端工厂
`uniqc.BackendInfo`	平台约定 · 统一后端工厂
`uniqc.DummyBackend`	平台约定 · DummyBackend · Dummy 系统（进阶）
`uniqc.OriginQBackend` / `uniqc.IBMBackend` / `uniqc.QuarkBackend`	平台约定 · 统一后端工厂

编译与区域选择¶

API	在哪个用户文档章节中使用
`uniqc.compile()` / `uniqc.compile_for_backend()`	编译选项（进阶） · 编译强度
`local_compile` / `cloud_compile`（提交时 kwarg）	编译强度
`uniqc.RegionSelector` / `uniqc.RegionSearchResult` / `uniqc.ChainSearchResult`	编译选项 · 区域选择器
`uniqc.TranspilerConfig`	编译选项（进阶）
`uniqc.QubitTopology` / `uniqc.Qubit`	构造电路 · 命名量子寄存器 · 平台约定 · DummyBackend

后处理 / 结果分析¶

API	在哪个用户文档章节中使用
`uniqc.calculate_expectation()`	主路径走读 · 3. 提交与后处理
`uniqc.shots2prob()` / `uniqc.kv2list()`	主路径走读 · 3. 提交与后处理

校准与读出误差缓解¶

API	在哪个用户文档章节中使用
`uniqc.ReadoutEM`	校准（进阶） · 统一读出误差缓解 ReadoutEM
`uniqc.M3Mitigator`	校准（进阶） · M3 读出误差缓解
`uniqc.ReadoutCalibrationResult`	校准（进阶） · 读出误差校准
`uniqc.XEBResult`	校准（进阶） · XEB 交叉熵基准测试

PyTorch 集成¶

API	在哪个用户文档章节中使用
`uniqc.torch_adapter`	PyTorch 集成
`uniqc.QuantumLayer` / `uniqc.TorchQuantumLayer`	PyTorch · QuantumLayer
`uniqc.torch_adapter.parameter_shift_gradient()`	PyTorch · Parameter-Shift 梯度
`uniqc.torch_adapter.batch_execute()` / `uniqc.torch_adapter.batch_execute_with_params()`	PyTorch · 批量执行
`uniqc.torch_adapter.compute_all_gradients()`	PyTorch · 多参数电路

格式互转与解析¶

API	在哪个用户文档章节中使用
`uniqc.compile.originir`	OriginIR · Python API 参考
`uniqc.OriginIR_BaseParser`	OriginIR · Python API 参考
`uniqc.OpenQASM2_BaseParser` / `uniqc.compile.qasm`	QASM · 格式互转操作
`Circuit.from_originir` / `Circuit.from_qasm`	构造电路 · 格式互转 · QASM · 格式互转操作

可视化¶

API	在哪个用户文档章节中使用
`uniqc.plot_time_line()`	主路径走读 · 5. 可视化 · 编译选项 · API 速查
`uniqc.circuit_to_html()`	主路径走读 · 5. 可视化
`Circuit.draw` / `uniqc.compile.draw.draw()`	构造电路 · 可视化
`uniqc.compile.compute_gate_depth()`	构造电路 · 线路信息

异常类型¶

API	在哪个用户文档章节中使用
`uniqc.UnifiedQuantumError`（基类）	提交任务 · 平台边界与限制
`uniqc.AuthenticationError` / `uniqc.NetworkError` / `uniqc.QuotaExceededError` / `uniqc.InsufficientCreditsError`	任务管理器 · 错误处理
`uniqc.TaskFailedError` / `uniqc.TaskNotFoundError` / `uniqc.TaskTimeoutError`	任务管理器 · 错误处理
`uniqc.BackendError` / `uniqc.BackendNotFoundError` / `uniqc.BackendNotAvailableError` / `uniqc.BackendOptionsError`	平台约定 · 统一后端工厂
`uniqc.CircuitError` / `uniqc.NotSupportedGateError` / `uniqc.UnsupportedGateError` / `uniqc.CircuitTranslationError`	构造电路 · 量子门 · QASM · 格式互转
`uniqc.CompilationFailedError` / `uniqc.CompilationResult` / `uniqc.CompatibilityReport`	编译选项（进阶） · 编译强度
`uniqc.ConfigError` / `uniqc.ConfigValidationError` / `uniqc.ProfileNotFoundError` / `uniqc.PlatformNotFoundError`	平台约定 · 配置约定
`uniqc.RegisterDefinitionError` / `uniqc.RegisterNotFoundError` / `uniqc.RegisterOutOfRangeError`	构造电路 · 命名量子寄存器
`uniqc.StaleCalibrationError`	校准（进阶） · 缓存管理
`uniqc.TopologyError` / `uniqc.TimelineDurationError` / `uniqc.NotMatrixableError` / `uniqc.MissingDependencyError`	构造电路 · 提取酉矩阵 · 平台约定 · DummyBackend