把"数据类型必须明确"从口头要求变成仓库规则,每个函数都适用。 - 判断顺序表:整数用 (int, np.integer)、浮点用 (float, np.floating)、 bool 要放在 int 判断之前、数组先 np.asarray 归一化 - 硬规则:非法类型必须 raise TypeError,不许静默兜底 (静默的后果是"种子被忽略、结果不可复现且无提示",最难查) - 要求每个公开函数写全 Parameters(含 None 走哪条分支)与 Raises - docs/03-roadmap.md §3.2 开发纪律加一行指针
2.5 KiB
2.5 KiB
更新日志
格式参考 Keep a Changelog, 版本号参考 语义化版本。
[Unreleased]
Added
- 仓库骨架:
src/mcm_toolkit/7 个包(core / data / stats / models / solve / decision / viz) - 顶层
__init__.py只导出 7 个子包 + 8 个快捷函数,__all__即公开 API 清单 core.Result:唯一的结果对象(替代原建议里的 5 个 Result 类)docs/01-suggestion-review.md:对 ChatGPT 建库建议的审查与精简(14 包 → 7 包,~250 函数 → ~40)docs/02-architecture.md:包边界、Result/ RNG /fit-predict-score协议、依赖分层docs/03-roadmap.md:L0/L1/L2 分级 + 永久不做清单docs/04-environment.md:conda / venv 配置与三个已踩的坑docs/dev/function-card-template.md:S 档算法的函数卡片模板.venv(基于 Anaconda base,--system-site-packages)+ 可编辑安装 —— 10.5 MB,离线可用- conda 环境
mcm-toolkit(D:\anaconda\envs\mcm-toolkit)—— Python 3.13.15,含 SALib / pymoo / pyright scripts/setup-conda.ps1/scripts/setup-venv.ps1/scripts/doctor.ps1environment.yml:需联网时的精确复现方案pyproject.toml:核心依赖只 4 个,其余走 extras
Changed
core.get_rng/core.set_seed:实现(L0 第 2 项)。get_rng收int/np.integer/Generator/None,其余类型抛TypeError;无参调用复用同一个会推进的共享生成器。set_seed同时覆盖 numpy 旧全局状态,让 sklearn / statsmodels 也可复现。core.Result:补上__repr__与summary()实现(L0 第 1 项落地)。repr紧凑单行且不打印data内容;summary()输出可直接贴进论文的 Markdown 表格。
Added
docs/02-architecture.md§4.7「类型约定」:注解要写全、numpy 标量的判断写法、 非法类型必须抛TypeError。配套在docs/03-roadmap.md的开发纪律里加了指针。docs/dev/personal-pitfalls.md:个人易错点清单,只追加、不通读
Notes
- 除
core.Result、core.get_rng、core.set_seed外,其余函数体尚未实现(统一raise NotImplementedError+TODO(L0/L1/v0.2)标记)。 这是刻意的:先定接口,再按docs/03-roadmap.md的 L0 → L1 顺序填实现。 - 已知缺口:
SALib(Sobol/Morris)、pymoo、pyright未安装(本机离线)。
[0.0.1] - 2026-10-01
Added
- 项目初始化,包结构落盘(实现为空)。