UQPyL 文档
UQPyL 提供统一的问题建模协议，以及一组用于采样、敏感性分析、优化、推断、校准和代理建模的不确定性量化工作流。
大多数工作流都从 Problem 或 ModelProblem 开始，然后将该对象传给一个或多个功能模块。
text
Problem / ModelProblem -> Method -> Result从这里开始
| 目标 | 阅读 |
|---|---|
| 跑通最短完整工作流 | Quick Start |
| 理解统一的建模协议 | Problem |
| 查看完整工作流示例 | Examples |
| 查类、参数和结果对象 | API Reference |
选择工作流
| 任务 | 模块指南 | API |
|---|---|---|
| 定义输入空间、目标、约束、仿真和评估输出 | Problem | Problem API |
| 为实验、分析、初始化或建模生成设计样本 | Design of Experiment | DOE API |
| 分析输入如何影响模型或目标输出 | Analysis | Analysis API |
| 搜索单目标、多目标或昂贵模型的最优解 | Optimization | Optimization API |
| 运行 MCMC 风格的参数推断 | Inference | Inference API |
| 让仿真模型拟合观测数据 | Calibration | Calibration API |
| 训练预测型代理模型 | Surrogate Modeling | Surrogate API |
推荐阅读路径
- 先看 Quick Start，理解整个工作流的基本形状。
- 在使用任何功能模块前，先看 Problem。
- 再从上面的工作流表里选择一个你需要的模块页。
- 当你需要查构造参数、返回字段或 reader 类时，再看 API Reference。
- 如果你想复制完整模式，继续看 Examples。
核心概念
| 概念 | 在哪里看 |
|---|---|
Problem | 静态目标与约束问题。见 Problem。 |
ModelProblem | 带观测、掩码和仿真上下文的仿真模型。见 Problem。 |
Eval | problem.evaluate() 的标准输出对象。见 Problem API。 |
| 结果对象 | 如 AnaResult、OptResult、InfResult、CalResult 等模块结果对象。见 API Reference。 |
| 保存结果 | 如 AnaReader、OptReader、InfReader、CalReader 等 sqlite reader。见各模块 API 页面。 |
API 参考
API 参考按模块拆分。
| 模块 | API 页面 |
|---|---|
UQPyL.problem | Problem API |
UQPyL.doe | DOE API |
UQPyL.analysis | Analysis API |
UQPyL.optimization | Optimization API |
UQPyL.inference | Inference API |
UQPyL.calibration | Calibration API |
UQPyL.surrogate | Surrogate API |
项目说明
| 页面 | 用途 |
|---|---|
| Changelog | 面向用户的版本变更记录。 |