範例¶
範例對於希望快速上手 statsmodels 的新用戶來說非常寶貴,並且對於那些希望探索 statsmodels 新功能的人來說也非常有用。 我們希望為盡可能多的模型和使用案例提供文檔和教程! 如果任何 PR 引入新功能,請考慮提交一個範例。
使用者貢獻的範例/教程/食譜可以放在 statsmodels 範例 wiki 頁面 上。 該 wiki 頁面是可自由編輯的。 請在那裡發布您的酷炫技巧、範例和食譜!
如果您希望您的範例檔案被正式接受到 statsmodels 發行版並發佈在本網站上,您將需要完成正常的 修補程式提交流程 並按照後續的說明進行操作。
檔案格式¶
範例最好以 Jupyter Notebook 的形式貢獻。 請將您的 Notebook 儲存,並清除所有輸出儲存格,存放在 examples/notebooks
中。
範例展示區¶
我們有一個範例 Notebook 展示區,在此 可用。如果您希望您的範例顯示在此展示區中,請在 docs/source/examples/landing.yml
中加入指向該 Notebook 的連結。對於縮圖,請截取您認為最能吸引該 Notebook 的「亮點」畫面。圖片將以 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
。