添加新方法、函数和类

尽管在大多数情况下，向 SciPy 添加代码相当简单，但在某些情况下并非如此。本文档包含有关一些特定情况的详细信息，在这些情况下，从一开始就不清楚任务涉及的内容。

添加新的统计分布

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

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

如何创建新的连续分布

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

实施前

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

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

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

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

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

2. 创建一个 GitHub 上的 SciPy Issue，列出分布、参考资料和包含它的原因。

实施

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.pdf() 而言，squirrel_gen.ppf() 的计算成本很高，请考虑在调用 squirrel_gen() 时设置 momtype。

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

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

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

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

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 中示例代码中的 number of continuous distributions。

4. 成功构建文档。

5. 提交 PR。

参考文献

[JKB]

Johnson, Kotz 和 Balakrishnan，“Continuous Univariate Distributions, Volume 1”，第二版，John Wiley and Sons，p. 173 (1994)。