跳转至

使用指南

本栏目面向首次接入 OptAgent 的用户,按“安装 -> 建模 -> 求解 -> 配置策略 -> 查看结果”的顺序组织公开使用文档。

推荐阅读顺序

  1. 安装指南:确认支持环境,获取安装包并完成安装。
  2. 建模接口:用 ModelBuilder 描述变量、约束和目标。
  3. 求解接口:用 Orchestrator().run(...) 发起求解。
  4. 策略配置:在自动选择、内置预设和显式配置之间做选择。
  5. 结果查看:读取 final_solution、阶段 trace 与诊断信息。

最短闭环

from optagent import ModelBuilder, Orchestrator

# 1. 创建 builder,并用 metadata 标记案例,方便后续 trace 和日志识别。
builder = ModelBuilder(metadata={"case": "minimal_usage"})

# 2. 创建两个 0/1 决策变量,表示是否选择对应方案。
x = builder.int_var(default=0, lb=0, ub=1, name="x")
y = builder.int_var(default=0, lb=0, ub=1, name="y")

# 3. 登记容量约束:两个方案最多选择一个。
builder.constraint(x + y <= 1, name="capacity")

# 4. 登记收益最大化目标。
builder.maximize((x * 3) + (y * 2), name="profit")

# 5. 冻结模型,得到可交给编排器求解的 program。
program = builder.freeze()

# 6. 运行编排器;不传配置时会自动选择内置策略。
result = Orchestrator().run(program)
solution = result.final_solution

# 7. 输出最终状态、目标值和变量赋值。
print(solution.status.value)
print(solution.objective_values)
print(solution.variable_values)

与其他栏目关系

  • 使用指南解释“怎么做”,适合接入时阅读。
  • API 参考列出公开对象和字段,适合查参数与成员。
  • 示例提供公开示例仓库入口和分类说明。
  • 需要查对象、配置字段和精确解兼容范围时,阅读 API 参考