例¶

例は、statsmodelsをすぐに使い始めたい新規ユーザーにとって非常に貴重であり、statsmodelsの新機能を試したいユーザーにとっても非常に役立ちます。可能な限り多くのモデルとユースケースに関するドキュメントとチュートリアルを提供したいと考えています！新しい機能を導入するPRには、例を提出することを検討してください。

ユーザーが投稿した例/チュートリアル/レシピは、statsmodelsの例のwikiページに掲載できます。このwikiページは自由に編集できます。あなたのクールなトリック、例、レシピをそこに投稿してください！

例のファイルをstatsmodelsのディストリビューションに正式に受け入れてこのウェブサイトに掲載したい場合は、通常のパッチ提出プロセスに従い、以下の手順に従う必要があります。

ファイル形式¶

例は、Jupyter Notebookとして投稿するのが最適です。すべての出力セルをクリアした状態で、ノートブックをexamples/notebooksに保存してください。

例のギャラリー¶

例のノートブックのギャラリーはこちらで利用できます。例をこのギャラリーに表示したい場合は、docs/source/examples/landing.ymlにノートブックへのリンクを追加してください。サムネイルについては、ノートブックの最もアピールできる「フック」だと思うもののスクリーンショットを撮ってください。画像は360 x 225（W x H）で表示されます。画像を360 x 225の倍数（720 x 450が推奨）の解像度のPNGとして保存するのが最適です。

可能であれば、PNGファイルを縮小することを忘れないでください。このウェブサイトが役立ちます。

PRを提出する前に¶

時間を節約し、新しい例を既存の例にうまく適合させるために、以下の点を考慮してください。

statsmodelsの例がどのように見えるかを感じるために、例のソースコードを見てください。

docsディレクトリからmake htmlを実行してドキュメントをビルドし、完全にレンダリングされたHTMLページで例がどのように表示されるかを確認してください。例のHTMLファイルはdocs/build/html/examples/notebooks/generatedに表示されます。