SuperAPI AI 工具集

code-best-practice

编程与开发

查看项目

更新于 10-16 04:54

技能介绍

用途:这是 pymc-marketing 项目的编码约定、推荐实现与风格指南,用于指导贡献者编写符合项目标准的代码。

主要能力与规范: 代码风格:使用 Ruff 与 MyPy 强制检查;所有函数参数与返回值必须加类型注解;行宽上限 120 字符;导入由 Ruff 自动排序;在 init 中用 pydantic 做运行时输入校验。文档字符串采用 NumPy 风格,包含 Summary、Parameters、Returns、References、Examples 等部分,统计模型需引用相关论文,示例用 .. code-block:: python 指令。

性能与可扩展实现:数学运算避免 Python 循环,改用 numpy、xarray 或 pytensor 广播;PyMC 建模中用 pm.Data 承载可变输入,便于不重建模型图即可更换数据;使用命名维度 dims 而非原始形状;时间变化参数优先用 HSGP 替代标准高斯过程,将复杂度从 O(n^3) 降至 O(n·m);优化与敏感性分析等优先用 pytensor 操作,其图可编译到 C、JAX 或 MLX 并支持自动微分。

类结构:模型继承 MMM、CLVModel 等基类,实现 init(校验输入、存配置、不建模型)、build_model(构建 PyMC 上下文与 pm.Data)、_extract_predictive_variables(准备预测数据)等生命周期方法;用 default_model_config 定义默认先验,并用 pymc_extras.prior.Prior 以字典形式声明分布,便于用户覆盖。

测试:使用 pytest,要求高覆盖率,用 @pytest.mark.parametrize 覆盖多场景,用辅助函数生成合成数据验证模型恢复。

提交前检查:make lint、pre-commit run mypy --all-files、make test,并确保新增公开方法有文档字符串。

限制:资料未提供具体安装命令、版本要求或完整 API 列表。