添加新方法、函数和类

虽然在大多数情况下向 SciPy 添加代码非常简单，但在某些情况下并非如此。本文档包含一些特定情况的详细信息，这些情况可能一开始不清楚该任务涉及什么。

添加新的统计分布

数百年来，统计学家、数学家和科学家需要理解、分析和建模数据。这导致了大量的统计分布，其中许多分布彼此相关。对新型数据进行建模以及将理论考虑应用于新学科继续产生新的分布。SciPy 建模了大约十几个离散分布 离散统计分布 和 100 个连续分布 连续统计分布。

要添加新的分布，需要一个好的参考。SciPy 通常使用 [JKB] 作为其黄金标准，WikipediaDistributions 文章通常提供一些额外的细节和/或图形图。

如何创建新的连续分布

要向 SciPy 添加连续分布，需要执行几个步骤。（添加离散分布是类似的）。我们将在下面的说明中使用虚构的“Squirrel”分布。

实现之前

1. 查看 Squirrel 是否已实现——这可以节省大量精力！

   • 它可能已使用不同的名称实现。

   • 它可能已使用不同的参数化（形状参数）实现。

   • 它可能是更一般的分布族的一种特化。

   多个学科发现/重新发现分布（或特化或不同的参数化）是很常见的。存在一些现有的 SciPy 分布是其他分布的特化。例如，scipy.stats.arcsine 分布是 scipy.stats.beta 分布的特化。这些重复存在的原因是（非常！）历史的和广泛的用法原因。目前，主要由于此类添加会导致用户困惑增加，因此不支持向 SciPy 添加现有分布的新特化/重新参数化。

2. 在 GitHub 上创建一个 SciPy 问题，列出分布、参考文献及其包含的原因。

实现

1. 查找与 Squirrel 相似的现有分布。使用其代码作为 Squirrel 的模板。

2. 阅读 scipy/stats/_distn_infrastructure.py 中类 rv_continuous 的文档字符串。

3. 编写类 squirrel_gen 的新代码，并将其插入到 scipy/stats/_continuous_distns.py 中，该文件（主要）按分布名称的字母顺序排列。

4. 分布是否具有无限支持？如果不是，则需要在调用 squirrel_gen(name='squirrel', a=?, b=?) 时指定左端点和/或右端点 a, b。

5. 如果支持取决于形状参数，则需要实现 squirrel_gen._get_support()。

6. 默认继承的 _argcheck() 实现检查形状参数是否为正数。创建一个更合适的实现。

7. 如果 squirrel_gen.ppf() 的计算成本相对于 squirrel_gen.pdf() 较高，请考虑在调用 squirrel_gen() 时设置 momtype。

8. 如果 squirrel_gen.rvs() 的计算成本很高，请考虑实现特定的 squirrel_gen._rvs()。

9. 将名称添加到 scipy/stats/__init__.py 的文档字符串中的列表中。

10. 将名称和一组好的示例形状参数添加到 scipy/stats/_distr_params.py 中的 distcont 列表中。这些形状参数用于测试和自动文档生成。

11. 将名称和一组无效的示例形状参数添加到 _distr_params.py 中 invdistcont 列表中的。这些形状参数也用于测试。

12. 将 TestSquirrel 类和任何特定测试添加到 scipy/stats/tests/test_distributions.py。

13. 运行并通过（！）测试。

实现之后

1. 添加一个教程 doc/source/tutorial/stats/continuous_squirrel.rst

2. 将其添加到 doc/source/tutorial/stats/continuous.rst 中连续分布的列表中。

3. 更新 doc/source/tutorial/stats.rst 中示例代码中的 连续分布的数量。

4. 成功构建文档。

5. 提交 PR。

参考文献

[JKB]

Johnson、Kotz 和 Balakrishnan，“连续单变量分布，第 1 卷”，第二版，John Wiley and Sons，第 173 页（1994 年）。