18 lines
776 B
Markdown
18 lines
776 B
Markdown
|
# API 参考
|
||
|
|
|
||
|
|
**本目录不放手写 API 文档。** 手写的 API 文档一定会和代码脱节。
|
||
|
|
|
||
|
|
接口的权威来源是三个地方，按优先级：
|
||
|
|
|
||
|
|
1. **源码 docstring** —— 每个函数的数学含义、参数、返回值、Notes、示例都写在那里；
|
||
|
|
2. **`__all__`** —— 每个子包的公开 API 清单，`tests/test_api_surface.py` 会校验它和实际导出一致；
|
||
|
|
3. **`docs/02-architecture.md`** —— 跨函数的约定（`Result` 字段、RNG 规则、`fit/predict/score` 协议）。
|
||
|
|
|
||
|
|
需要生成站点时用 mkdocs + mkdocstrings（后者直接从 docstring 生成）：
|
||
|
|
|
||
|
|
```powershell
|
||
|
|
pip install mkdocs mkdocstrings[python]
|
||
|
|
mkdocs serve
|
||
|
|
```
|
||
|
|
|
||
|
|
**本仓库不把 mkdocs 放进依赖**——它是可选的、和比赛无关的工具。
|