guzhujushi/MCM-ICM_Toolkit
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
22 Commits 1 Branch 0 Tags
cfc1be31ca7505e848fe3a18adad0c65344fedf1
Commit Graph
15 Commits
Author SHA1 Message Date
guzhujushi cfc1be31ca fix(stats): CV 改用 |mean|，并记录决策 37/38/39 与经验 12 
coefficient_of_variation:
- 分母由 mean 改为 |mean|（用户本人改），均值为负时 CV 不再是负值
- docstring 摘要 / Returns / Notes 同步，加一条测试钉住"均值为负时 CV 仍为正"

口径拍板（2026-10-03）:
- 决策 37: 非数值列的处置按输出契约分，不按包分 —— describe/zscore 丢掉（吐数值结果表），
  detect_outliers 保留列、掩码恒 False（吐与原表同形的掩码），刻意不统一
- 决策 38: CV 用 sigma/|mean|
- 决策 39: 工作约定 —— 语义/非法输入口径由用户拍板，Codex 只列选项不代选；
  ruff / STATUS.md / CHANGELOG.md / tests / docstring 这类与算法无关的工程事务 Codex 顺手补

经验（docs/dev/personal-pitfalls.md，只追加）:
- 第 12 条: 三个并列的 if 让后面的静默覆盖前面的（transform.normalize 三种 method 实际只走 max）
  第 11 条（上一轮）是 descriptive 的 .loc 对齐失败静默填 NaN —— 两条的共同点是"不抛异常"

验证: pytest 103 passed / 39 skipped；ruff All checks passed；pyright 0 errors。

docs: STATUS.md 决策 37/38/39 + 下一步；CHANGELOG 记录
 2026-10-03 13:26:13 +08:00
guzhujushi e9624cb3a7 feat(stats): describe 落地，修掉一个静默填 NaN 的 bug（L0 8/12） 
src/stats/descriptive.py 由用户本人实现，这里做审查 + 代修。

describe:
- 真 bug：df_num.describe().T 把表转反（行=变量、列=指标），而 docstring 与
  test_describe_reports_expected_keys 定的是"行=指标、列=变量"。转置后
  .loc[指标名] = <按变量索引的 Series> 与列名零交集，pandas 不报错，直接把
  missing / missing_ratio / skewness / kurtosis 四行整行填成 NaN（静默丢数据）；
  weights 分支则报 cannot set a row with mismatched columns。去掉 .T 一处修好三件事
- 补 median 行（pandas 只有 50%，测试契约定的是 median）
- 入参放宽到 list / tuple / ndarray（00_quickstart.py 传的就是 ndarray）
- weights 校验补齐：维度 / 长度 / NaN / 负值 / 和为 0（原先和为 0 时裸抛 ZeroDivisionError）
- docstring 按 4.7 补 Parameters / Returns / Raises

zscore: 修 RET505；docstring 补齐；DataFrame 取列处按坑 8 用 cast 收窄
coefficient_of_variation: 均值为 0 改抛 ValueError（取值问题不是类型问题）；
  空数组提前报错（原先静默 nan + RuntimeWarning）；错别字与文案修正

tests: 去掉 test_stats.py 的模块级 pytestmark —— 它把 6 条测试全部跳过（含已实现的
  describe），正是决策 26 要禁的写法。改为逐条 skip 未实现的 5 条，并新增 20 条用例。

验证：pytest 102 passed / 39 skipped（原 82/40）；ruff All checks passed；pyright 0 errors。
examples/01_clean_and_describe.py 填掉 TODO(L0)，实测 exit 0。

docs: STATUS.md L0 8/12 + 决策 35/36 + 三处待拍板口径；CHANGELOG 记录；
      personal-pitfalls 追加第 11 条（pandas 对不齐就静默填 NaN）
 2026-10-03 13:17:58 +08:00
guzhujushi 4552aee41c fix(data): 修掉 transform.py 的 3 处真 bug，并收口 4 个口径 
不是编辑器误报：pyright CLI 与 pytest 都能复现（修前 7 failed / 75 passed），
所以一行 # type: ignore 都没加。

- 输入白名单漏了 pd.DataFrame -> standardize/log_transform 直接 TypeError，
  函数体里的 is_df 分支全是死代码；统一成模块级 _NUMERIC_TYPES 并前置到 np.asarray 之前
- normalize 三个 method 分支互相覆盖（minmax/vector 的结果被末尾无条件的 x/max 冲掉，
  实际三种 method 都只走 max），改成 if/elif/else
- one_hot_encode 按 data.columns 重包一层 DataFrame -> 哑变量列名对不上，编码列整列丢失，
  改为直接返回 get_dummies 的结果
- log_transform 的 offset 守卫写反（offset > 0 就抛错，恰好拒掉唯一合法用例），
  改为校验定义域前提 min(x) + offset > 0；offset=0 对全正数据合法
- 四个函数 docstring 按 docs/02-architecture.md 4.7 补齐 Parameters/Returns/Raises
- ruff 4 条 RET505 清掉；pyright 2 errors -> 0；测试 82 passed / 40 skipped

docs: STATUS.md L0 进度 7/12 + 决策 35；CHANGELOG 记录本轮回归与修复；
      personal-pitfalls 追加第 10 条（把真报错当成编辑器误报）
 2026-10-02 21:48:27 +08:00
guzhujushi 6eab0babde feat(data): transform.py 四个函数落地；补 18 条测试、清 5 条 ruff 
实现（用户本人写）：
- normalize（minmax / vector / max，三种都按列）+ feature_range 校验 + 常量列不出 nan
- standardize（按列，ddof 真的传下去）+ 类型守卫
- log_transform（offset=None 时自动取 1 - min(x)，保证 x + offset >= 1）+ 类型守卫
- one_hot_encode（自动识别对象列 / 指定列 / drop_first）
- data/ 下的 L0 至此结清（L0 7/12）

Codex 的轻度修复（不改接口与语义）：
- 清掉 5 条 ruff：RET503 / F541 / RET504 / RET505 / SIM108
- supported_method 与 feature_range 的校验提到 np.asarray 之前（守卫集中开头）
- 修掉说反的报错文案（条件是要求下界 < 上界，原文写"上界必须小于下界"）
- one_hot_encode 自动识别时显式加上 str / string：只写 object 在 pandas 3 上是弃用路径，
  每次调用发 Pandas4Warning，未来会变成"一列都选不中"的静默错误（详见坑 9）

测试：
- 新写 18 条（transform 段），其中两条是把原先挂着的 skip 转为实跑 ——
  normalize / standardize 的实现此前一条测试都没跑到（详见个人易错点 9）
- 82 passed / 40 skipped / 0 xfailed；ruff 0；pyright 0

文档：
- STATUS.md：E 节 + 验证表（122 条用例分布）+ 下一步重写（transform 待定的 4 个口径）+ 决策 34
- docs/04-environment.md：新增坑 9（pandas 3 的 str dtype 与 select_dtypes 弃用路径，含实测对照表）
- docs/dev/personal-pitfalls.md：只追加第 9 条（实现写完但测试还挂 skip，绿灯是假的）
- CHANGELOG.md：本轮变更 + 记录 transform 待定的 4 个口径
 2026-10-02 20:43:03 +08:00
guzhujushi 5749e50e83 chore: 补 S 档卡片 / examples；clean.py 收尾，xfail 清零 
实现收尾（Codex 代写，用户授权）：
- impute_missing 的 mode 分支改为返回新表（原先就地改调用方的 DataFrame，另外四支都返回新对象）
- detect_outliers 补入参类型校验（§4.7：非法类型抛 TypeError，不静默兜底）：
  接受 DataFrame / Series / list / tuple / ndarray；tuple 同时补进 is_ld_array；
  dict 不再被接受（以前靠 pd.DataFrame() 碰巧能过，见决策 33）

测试：
- 摘掉最后一条 xfail（mode 就地改）并加强断言
- 新增 3 条：非法类型抛 TypeError、元组按一维数组型处理、全 NaN 列与单元素列不抛异常
- 64 passed / 42 skipped / 0 xfailed（xfail 清零，7 条契约全部转正）；ruff 0；pyright 0

文档：
- 新增 docs/algorithms/detect_outliers.md —— 第一张 S 档函数卡片（roadmap 要求约 15 张）
  除模板九节外多记三条判断：为什么不返回 Result、非数值列恒 False 的两条备选路各错在哪、
  ddof 口径与 stats.zscore 不一致（前者 1、后者 0，小样本差一成）
- 新增 examples/01_clean_and_describe.py —— 六个 data 函数的最小用法，实测跑通（exit 0）
- STATUS.md：E 节收尾、验证结果表、下一步重写（transform/standardize 的待定项）、决策 33
- CHANGELOG.md：把 [Unreleased] 里重复 7 次的 Added/Changed 小节合并成 Added/Changed/Notes；
  并修掉上轮遗留的缺陷 —— pyright 那条 bullet 的开头被吞掉，半句挂在 ruff 那条后面
 2026-10-02 15:48:12 +08:00
guzhujushi b6dc4bc5a6 feat(data): detect_outliers 收尾（文本列恒 False）+ 补测试与文档 
实现（用户本人写 + Codex 轻度收尾）：
- 统计量（quantile / mean / std）与掩码写入都收窄到数值列，含文本列的赛题表不再崩
- 非数值列在掩码里恒 False（用户定的语义），docstring Notes 补上这条
- 删掉死代码 data=data.copy()：下面的 to_frame()/pd.DataFrame() 本就返回新对象，
  函数全程只读 data，白复制一份；且它排在类型分派之前，会把错误入参的报错
  从 ValueError 变成 AttributeError
- 删掉那行死代码后 pyright 反而暴露 1 个真错：df[Index] 被类型存根当成 Series，
  .std() 于是被判成标量、std.replace(...) 非法。在取列子表处 cast 成 DataFrame
  按运行时真值收窄（详见 docs/04-environment.md 坑 8）

测试：
- test_detect_outliers_survives_text_columns 摘掉 xfail 并加强断言（文本列必须恒 False）
- 新增 test_detect_outliers_all_text_frame_returns_all_false，钉住"整表无数值列"边界
- 58 passed / 2 xfailed  ->  60 passed / 1 xfailed；ruff 0；pyright 0
- 仅剩 1 条 xfail：impute_missing 的 mode 分支就地改调用方的表（要选语义，留给用户）

文档：
- STATUS.md：L0 5/12、验证结果表、下一步重写、新增决策 32（非数值列恒 False）
- docs/04-environment.md：新增坑 8（pandas 存根让 df[Index] 退化成 Series，及三种无效修法）
- docs/dev/personal-pitfalls.md：只追加第 8 条（限制掩码 ≠ 限制统计量）
- CHANGELOG.md：本轮变更
 2026-10-02 15:41:08 +08:00
guzhujushi 319b16b17c fix(data): clean.py 轻度修复 + 摘掉 5 条已修好的 xfail 
Codex 直接改的（格式 / 死代码 / 纯 bug，不动接口与语义）：
- winsorize(Series) 直接崩：select_dtypes 在 Series 上不存在，Series 分支提到最前并加数值 dtype 守卫
- winsorize 的分位数改为只在数值列上算，含文本列的赛题表不再崩（与已有 numeric_cols 判断对齐）
- 删掉 detect_outliers 里已成空操作的 df = pd.DataFrame(data)，去掉 df 别名
- clean_missing 的嵌套 if 合并（ruff SIM102），清掉 W293 行尾空白与函数内连续空行

测试：
- 5 条 xfail 经 XPASS 信号确认已修好，摘掉 mark 转正式用例
  （detect_outliers 4 条 + winsorize 混合类型 1 条）
- 53 passed / 7 xfailed  ->  58 passed / 2 xfailed
- 剩 2 条 xfail 保留，且不是漏改而是设计没定：
  detect_outliers 遇文本列返回什么、impute_missing 的 mode 分支要不要就地改调用方的表
- ruff: 1 error -> All checks passed；pyright: 0 errors 不变

文档：
- STATUS.md：L0 进度 4/12、验证结果表、下一步重写、新增决策 31
  （Codex 可直接改 src 的范围：纯 bug / 格式 / 死代码；要选语义的留给用户）
- CHANGELOG.md：本轮变更，并修掉 [Unreleased] 里被重复追加撑坏的一句
- docs/dev/personal-pitfalls.md：只追加第 7 条（守卫子句要排在类型分派之后）
 2026-10-02 15:18:15 +08:00
guzhujushi c2595b6d07 feat(data): clean.py 四个函数落地；补测试、docstring 与 ruff 清理 
src 由用户本人写（决策 25），Codex 只做审查、补测试与文档。

实现（用户）：
- clean_missing：按行/列删缺失过多的行，threshold 用 math.ceil 算 min_non_na
  （3 列、阈值 0.5 时必须是 2；写 int() 截断会漏删）
- impute_missing / detect_outliers / winsorize（原属 L1，顺手落地）

Codex 改的轻度项：
- 按 §4.7 给四个函数补 Parameters / Returns / Raises（与 io.py 同一套 numpydoc 格式）
- ruff 6 -> 1：导入分组（I001）、elif 链改 if 加末尾无条件 return（RET505/RET503）、
  去掉多余 f 前缀（F541）、删掉只会被覆盖的 mask 初始化、去掉行尾空白（W293）
- tests/test_data.py：新增 13 条 clean 行为测试 + 7 条 xfail

结果：
- pytest 53 passed / 42 skipped / 7 xfailed（此前 40 / 44 / 0）
- pyright 0 errors, 0 warnings
- ruff 剩 1 条 SIM102，就在 detect_outliers 里那段待修的代码中，删掉即全绿

已知未修（详见 STATUS.md「下一步」）：
- detect_outliers 三个 bug：threshold 范围校验放错函数（iqr 分支 UnboundLocalError、
  zscore 默认 3.0 被 [0,1] 拒掉）、quantile 在含文本列的表上崩、
  is_series / is_ld_array 在 data 已转 DataFrame 之后才判断，因此永远为 False
- winsorize 同样在含文本列的表上崩
- impute_missing 的 mode 分支就地修改调用方的表
 2026-10-02 15:04:13 +08:00
guzhujushi 6758e81c9d fix(data): 校验早于副作用，补空行；经验写入 pitfalls 
save_table 的两处收尾（用户授权代改）：

- 后缀校验原先藏在 if/else 分支的 else 里，排在 path.parent.mkdir(...) 之后，
  传 sub/x.txt 会先把 sub\ 建出来再抛 ValueError。改成守卫子句，集中在 mkdir 之前，
  校验段结束后才产生副作用；此时 else 分支自然消失，用回 if/else 两路分派
- __all__ 与下一个 def 之间补回第二个空行（PEP 8 / E302）

测试：
- 新增 test_save_table_validates_before_touching_disk，
  断言参数非法时 tmp_path 下一个条目都不留（ValueError 与 TypeError 两条路径）
- 40 passed / 44 skipped，两套环境一致；ruff All checks passed

文档：
- docs/dev/personal-pitfalls.md 追加条目 5（参数校验排在副作用之后）
  与条目 6（把 lint 的"没报错"当成"没问题"），索引表同步加行
- STATUS：io.py 收尾，L0 第 3 项完成；测试计数 40
- CHANGELOG：Fixed 段补两条
 2026-10-01 23:26:47 +08:00
guzhujushi 19f4a15107 docs(data): 补齐 io 两个函数的 Parameters 与 Raises 
按 docs/02-architecture.md §4.7，每个公开函数都要写全 Parameters 与 Raises，
格式对齐参考实现 core/random.py 的 get_rng。

- docstring 由 Codex 代写（本轮用户明确授权）；函数体逻辑由用户本人改
- load_table：返回注解 Any -> pd.DataFrame，与 docstring 的承诺对齐；
  写明 FileNotFoundError / ValueError / ImportError 各自在什么情况下抛
- save_table：写明 TypeError / ValueError / ImportError；
  并把 isinstance(df, pd.DataFrame) 校验挪到 mkdir 之前
- 两套环境 pytest 均 39 passed / 44 skipped，ruff All checks passed
 2026-10-01 23:22:40 +08:00
guzhujushi b6456d97d8 feat(data): 实现 load_table 与 save_table 
由用户本人实现（决策 25），Codex 只做审查与补测试。

- 按扩展名分派 .csv / .xlsx / .xls
- .csv 默认编码探测 utf-8 -> utf-8-sig -> gbk -> gb18030；
  显式传 encoding= 时不再探测
- na_values 默认吃下空串 / NA / N/A / #N/A / null / -
- save_table 自动建父目录，返回实际写入的 Path
 2026-10-01 23:11:47 +08:00
guzhujushi c93810ffb1 fix(core): 补齐 get_rng 类型校验，set_seed 覆盖 numpy 旧全局 
get_rng 的"共享单例生成器"设计由用户本人提出，本提交只在其上修 bug。

- random_state 判断从 isinstance(x, int) 放宽到 (int, np.integer)：
  np.int64 不是 int 的子类，之前会静默退回全局流、种子被无声忽略
- 非预期类型改成抛 TypeError（含 bool / float / str / list），不再静默降级
- get_rng 签名补上 np.integer 与 Generator，与 docstring 的承诺一致
- set_seed 同时调用 np.random.seed：sklearn / statsmodels 走的是 numpy
  旧全局状态，不覆盖它们"提交能重跑"就有洞（带 noqa: NPY002 与理由）
- 测试：TestRandom 由 4 条增到 7 条（np.integer、非法类型、共享生成器推进）
- 新增 docs/dev/personal-pitfalls.md：个人易错点清单，只追加、不通读，
  首批记录本轮 4 个点；docs/README.md 补上 05 与该文件的索引
- STATUS.md：L0 进度说明更新，决策 24 改写（共享单例）、新增决策 25
  （src/ 实现默认由用户本人写）
 2026-10-01 19:38:59 +08:00
guzhujushi 658b266614 feat(core): 实现 get_rng 与 set_seed 
L0 第 2 项落地。

- get_rng(int) 固定种子可复现；get_rng(Generator) 原样透传；
  get_rng() 跟随 set_seed 设过的全局种子，没设过则交给系统熵源
- set_seed(seed) 除记录 _GLOBAL_SEED 外，还调用 np.random.seed，
  让 sklearn / statsmodels 这些走 numpy 旧全局状态的库也能复现；
  这是全项目唯一碰旧接口的位置，标注了 noqa: NPY002 与理由
- 已知取舍写进 docstring：同一全局种子下多次 get_rng() 是同一条流
- tests/test_core.py：TestRandom 去掉 skip；把原来那条自证式的
  test_set_seed_makes_global_reproducible 换成两条真断言
  （不传 random_state 也要可复现、旧全局状态被覆盖）
- STATUS.md：L0 进度 2/12，新增决策 23（允许 set_seed 碰旧接口）
  与 24（不做 SeedSequence.spawn 拆分）；CHANGELOG.md 同步
 2026-10-01 19:19:15 +08:00
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
guzhujushi 5319589dfd chore: 初始化 MCM/ICM Toolkit 仓库骨架 
审查并精简 ChatGPT 的建库建议后落地的第一版骨架，只定接口不写实现。

- 建议审查：14 个包 → 7 个；约 250 个函数 → 约 40 个；5 个 Result 类 → 1 个
  （docs/01-suggestion-review.md）
- docs/：架构、路线图（含永久不做清单）、环境、Git 工作流、函数卡片模板
- src/mcm_toolkit/：core / data / stats / models / solve / decision / viz
  共 23 个模块，均为签名 + docstring + NotImplementedError
- tests/：9 个文件，其中 test_api_surface.py 已通过（20 passed）
- examples/ problems/ notebooks/ figures/ tables/ 骨架
- pyproject.toml（核心依赖 4 个 + 6 组 extras）、environment.yml
- scripts/：setup-venv.ps1（ASCII + LF）、setup-conda.ps1、doctor.ps1
- 环境：.venv（system-site-packages）与 conda 环境 mcm-toolkit 均已建好，
  数值栈版本与 base 完全对齐（numpy 2.4.6 / scipy 1.18.1 / pandas 3.0.6，MKL 后端）
 2026-10-01 17:43:48 +08:00