包级接口导航¶
首次学习使用 根接口参考。需要自定义 ansatz、梯度配置、任务存储或参考编译时，从对应的 cascaqit.<package> 导入类型。根入口保持常用操作；没有出现在根入口的类型不一定是私有实现。
下表说明各包负责什么，并链接到当前文档版本的公开导出声明。打开源码中的 __all__ 可查看该包的导出名；具体参数以同一提交中的定义为准。本页提供高级接口的查找入口，完整手写成员说明目前覆盖根接口。
| 包与导出源码 | 用途与边界 |
|---|---|
cascaqit.algorithms |
Ansatz 定义、梯度、优化器与诊断结果。常用入口见 VQE/QAOA 参考；高级类型从本包导入。 |
cascaqit.analog |
原子阵列、波形、寻址与 AHS 程序；包括未放在根入口的位点相位类型。 |
cascaqit.backends |
任务保存、历史与后端协议。硬件/云协议类型不提供真实服务连接。 |
cascaqit.compiler |
公开参考编译流程、处理步骤和缓存；输出不是私有编译器的设备执行包。 |
cascaqit.consistency |
跨模块记录、来源和引用的一致性检查；不代替物理模型验证。 |
cascaqit.control |
控制通道、寻址及并发等能力声明；用于表达约束。 |
cascaqit.diagnostics |
结构化诊断、严重性与来源位置，供程序读取错误信息。 |
cascaqit.digital |
Circuit 构造及数字线路中间表示。一般学习从根入口 Circuit 开始。 |
cascaqit.discretization |
根据 Target 将已校验的控制转换到允许的网格，并记录变化。 |
cascaqit.hybrid |
Hybrid 程序、依赖图、计划和编排。内部计划不能直接当作 Backend 输入。 |
cascaqit.interop |
显式导入/导出与受限 OpenQASM 转换；支持范围以转换检查为准。 |
cascaqit.native_ir |
原生程序、引用及编译结果的结构类型；用于保存和跨模块传递。 |
cascaqit.observables |
可观测量声明、Pauli 类型与批量结果。 |
cascaqit.parameters |
参数声明、表达式、schema、绑定结果及扫描。单位标签不执行隐式换算。 |
cascaqit.problems |
图、MIS/MWIS、QUBO/Ising、目标评估与问题编译；约束罚项需满足各模型的条件。 |
cascaqit.readiness |
检查离线硬件/云提交所需记录是否齐备；不证明已经接入或运行设备。 |
cascaqit.reports |
离线就绪检查与相关记录的报告集合；学习实验图表见 visualization。 |
cascaqit.results |
ResultIR、执行轨迹、结果视图和附件引用；读取引用不会自动下载远程附件。 |
cascaqit.runtime |
执行入口、Job 和批任务的协议与调度结构。 |
cascaqit.simulators |
本地规划器、状态表示、演化方法与物理噪声；方法和规模受程序及资源检查约束。 |
cascaqit.submission |
构造离线硬件提交请求及校验摘要；不上传或发起真实硬件任务。 |
cascaqit.sweep |
参数网格与扫描/优化辅助函数。 |
cascaqit.syntax |
受限装饰器前端、AST/HIR、源码映射与降级；不能执行任意 Python 作为量子程序。 |
cascaqit.targets |
Target、校准、注册表和能力投影；声明目标不代表该设备在线可用。 |
cascaqit.validation |
检查程序与目标约束，返回可定位的诊断。 |
cascaqit.visualization |
实验报告、图表渲染和输出配置；保持图表与保存的结果对应。 |
优先从包的公开入口导入，避免依赖下划线名称或内部文件路径。Alpha 阶段接口仍可能变化；复现实验时保存 SDK 提交，并使用同版本的示例和文档。
例如 GradientConfig、HardwareEfficientAnsatz 属于 cascaqit.algorithms；JobHistoryQuery 属于 cascaqit.backends。配置对象的创建只声明设置，真正执行仍需调用相应算法或后端。