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

MCM/ICM Toolkit

这是我参加美赛时用的学习和准备复用的代码,有需要可以自行克隆和修改。

美赛(MCM/ICM)编程手的竞赛层工具箱: 把比赛中反复手写的代码沉淀成"高频算法自己实现 + 成熟库薄封装 + 统一结果接口"。

不替代 SciPy / scikit-learn / statsmodels / NetworkX / SALib / SymPy。 只做它们到"4 天赛程能用"之间的那一层。

快速开始

# 1) 建环境(两条路选一条)
.\scripts\setup-venv.ps1        # venv,零下载,复用 Anaconda base 的科学栈
.\scripts\setup-conda.ps1      # conda 环境 mcm-toolkit(精准包列表,走代理下载)

# 2) 自检
.\scripts\doctor.ps1

# 3) 激活
.\.venv\Scripts\Activate.ps1
import mcm_toolkit as mcm

mcm.set_seed(42)
r = mcm.bootstrap_ci(data, statistic=np.median, random_state=42)
print(r.params["low"], r.params["high"])

当前状态(v0.0.1)

本地 git 仓库已初始化(main,首次提交 5319589),远程 Gitea 待配置。

接口已定,实现未填。 所有函数体是 raise NotImplementedError + TODO(L0/L1/v0.2) 标记, 按 docs/03-roadmap.md 的 L0 → L1 顺序填。

目录

路径 说明
src/mcm_toolkit/ 包源码,7 个子包
tests/ 测试,与包一一对应(测已知解析解,不测实现细节)
examples/ 每个模块一个能跑的最小例子
problems/ 历年真题(每做完一题,反向沉淀 1~3 个通用函数)
notebooks/ 探索用
docs/ 需求、架构、路线图、环境、规范
scripts/ 环境脚本
STATUS.md 当前进度

子包

包 职责 关键函数
core 基础设施 Result get_rng check_*
data 读 / 洗 / 变换 / 采样 load_table detect_outliers normalize
stats 描述 / 推断 / bootstrap describe bootstrap_ci fit_distribution
models 回归 / 时序 / ML fit_linear fit_arima compare_models
solve 优化 / 模拟 / 敏感性 monte_carlo simulated_annealing sobol_analyze
decision 评价决策 entropy_weights ahp_weights topsis gm11
viz 出图出表 plot save_figure save_table

文档

开始动手前请先读 docs/01-suggestion-review.md—— 它记录了"为什么最终结构是这样",以及明确不做什么。

许可

MIT,见 LICENSE。

S
Description
这是我参加美赛时用的学习和准备复用的代码,有需要可以自行克隆和修改
Readme MIT
2.1 MiB
0 Stars 1 Watchers 0 Forks
Languages
Python 95.4%
PowerShell 4.6%