示例¶

示例对于希望快速上手 statsmodels 的新用户来说非常宝贵，对于那些希望探索 statsmodels 的新功能的用户来说，它们也极其有用。我们希望为尽可能多的模型和用例提供文档和教程！请考虑为引入新功能的任何 PR 提交一个示例。

用户贡献的示例/教程/配方可以放在 statsmodels 示例维基页面 上。该维基页面可以自由编辑。请在上面发布你的酷技巧、示例和配方！

如果你希望你的示例文件被正式接受到 statsmodels 发行版中并在本网站上发布，你需要通过正常的 补丁提交流程 并遵循以下说明。

文件格式¶

示例最好以 Jupyter Notebook 的形式贡献。将你的笔记本保存到 examples/notebooks 中，清除所有输出单元。

示例库¶

我们有一个示例笔记本库，可 在此处 获取。如果你希望你的示例显示在这个库中，请在 docs/source/examples/landing.yml 中添加指向笔记本的链接。对于缩略图，请截取你认为最适合笔记本的“钩子”的屏幕截图。该图像将以 360 x 225（宽 x 高）显示。最好将图像保存为 PNG，分辨率为 360 x 225 的倍数（推荐 720 x 450）。

请记住，如果可以，请缩小 PNG 文件。 此网站 可以提供帮助。

提交 PR 之前¶

为了节省你的时间，并使新示例很好地融入现有的示例，请考虑以下几点。

查看示例源代码，了解 statsmodels 示例应该是什么样子。

构建文档，从 docs 目录运行 make html，看看你的示例在完全呈现的 html 页面中的外观。你的示例的 html 文件将出现在 docs/build/html/examples/notebooks/generated 中。