---
title: 文档概览
---

# OptAgent 文档

OptAgent 使用统一的 Python 表达式模型描述变量、约束与目标，提供混合求解、启发式求解和 OptX 精确求解三类入口。精确求解可选择内置 HiGHS 或 OR-Tools CP-SAT，无须另装这些求解器的 Python 包。

首次使用请从[安装与许可证](start/installation.md)开始，然后运行[第一个模型](start/quickstart.md)。已有代码请查看[当前接口与迁移](guide/migration.md)。

## 开始使用

- [安装与许可证](start/installation.md)：Python 环境、安装包、申请和检查离线许可证。
- [第一个模型](start/quickstart.md)：声明变量、添加约束、最小化成本并读取结果。
- [当前接口与迁移](guide/migration.md)：核对调用方式、时间预算与结果有效期。

## 使用指南

- [变量、表达式与约束](guide/modeling.md)：数值变量、集合、序列、区间、数组和多目标。
- [选择求解路径](guide/solvers.md)：三类求解入口的适用场景与配置。
- [结果与诊断](guide/results.md)：读取解、处理超时、理解诊断与排查常见问题。

## 示例

- [示例库](examples/index.md)：按排程、路径、装箱等问题查找 Notebook 与建模说明。
- [本地运行](examples/running.md)：下载完整案例、准备环境并运行配套实例。

## Python API 参考

- [API 概览](api/index.md)：公开对象、调用入口和异常。
- [建模接口](api/modeling.md)：按用途查询变量工厂、表达式与外部函数。
- [OptModel 方法索引](api/model-reference.md)：直接定位方法的参数、返回值和异常。
- [求解与配置](api/solve.md)：求解参数、默认值和后端配置对象。

## 选择求解入口

| 入口 | 适用场景 | 配置 |
| --- | --- | --- |
| `solve()` | 自动协调启发式与精确求解能力；通常从此入口开始 | `time_limit_s`、`threads` 等命名参数 |
| `solve_heuristic()` | 独立启发式求解，当前使用遗传算法 | 通用参数直接传入，遗传参数使用 `ga=GaOptions(...)` |
| `solve_optx()` | 显式选择 HiGHS 或 CP-SAT 精确求解 | `HighsConfig` 或 `CpSatConfig`；省略时使用 HiGHS |

模型能够表达的问题，不一定能被每个入口接受。具体限制见[求解指南](guide/solvers.md)。