Files
MCM-ICM_Toolkit/CHANGELOG.md
T
guzhujushi cb96c847dd feat(core): 实现 Result 的 __repr__ 与 summary
L0 第 1 项落地。

- __repr__:单行紧凑;data 只给类型与规模(ndarray(100000)),
  绝不整数组打印;__repr__ 永不抛异常
- summary():可直接贴进论文的 Markdown 表格,
  行序 success → params.* → metrics.* → extras.*(按插入顺序,不排序),
  float 走 .6g,竖线转义,message 以引用行附在表后
- 新增 5 个模块级私有辅助:_fmt_scalar / _fmt_cell / _fmt_mapping /
  _describe_data / _truncate
- tests/test_core.py:去掉 test_result_repr_is_readable 的 skip,
  并补 3 条行为测试(默认值与失败路径与十万级数组、Markdown 结构、幂等)
- STATUS.md:L0 进度 1/12;新增决策 21(repr 不打印 data 内容)、
  22(summary 行序不排序);CHANGELOG.md 同步
2026-10-01 18:48:43 +08:00

1.9 KiB
Raw Blame History

更新日志

格式参考 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.ps1
  • environment.yml:需联网时的精确复现方案
  • pyproject.toml:核心依赖只 4 个,其余走 extras

Changed

  • core.Result:补上 __repr__ 与 summary() 实现(L0 第 1 项落地)。 repr 紧凑单行且不打印 data 内容;summary() 输出可直接贴进论文的 Markdown 表格。

Notes

  • 除 core.Result 外,其余函数体尚未实现(统一 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

  • 项目初始化,包结构落盘(实现为空)。