示例¶

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

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

如果你希望你的示例文件被正式接受并发布到statsmodels的官方网站上，你需要通过正常的补丁提交流程，并遵循后续的指示。

文件格式¶

示例最好以 Jupyter Notebook 的形式贡献。将您的笔记本保存为所有输出单元格已清除的 examples/notebooks。

示例图库¶

我们有一个示例笔记本画廊，可在此处查看：here。如果您希望您的示例出现在此画廊中，请在docs/source/examples/landing.yml中添加笔记本的链接。对于缩略图，请截取您认为最适合作为笔记本“钩子”的部分的截图。图像将以360 x 225（宽 x 高）的尺寸显示。最好将图像保存为PNG格式，分辨率为360 x 225的倍数（首选720 x 450）。

请记住，如果可以的话，请缩小PNG文件。 这个网站可以帮助你完成这个任务。

在提交PR之前¶

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

查看示例源代码以了解 statsmodels 示例的外观。

构建文档 通过从文档目录运行 make html 来查看您的示例在完全渲染的html页面中的外观。您的示例的html文件将出现在 docs/build/html/examples/notebooks/generated。