sktime/sktime

[ENH] move and consolidate model serialization format file specification to `sktime` file specifications docs

開放

#6,100 建立於 2024年3月9日

在 GitHub 查看貢獻者指南
 (3 則留言) (0 個反應) (0 位負責人)Python (1,192 個分叉)batch import
API designdocumentationenhancementgood first issuemodule:base-framework

倉庫指標

星標
 (7,162 顆星)
PR 合併指標
 (平均合併 26天 10小時) (30 天內合併 86 個 PR)

描述

We should move and consolidate the model serialization format file specification to the sktime file specifications docs.

Enhancement proposal that was implemented: https://github.com/sktime/enhancement-proposals/blob/main/steps/20_saveload/step.md

Important, this may have been slightly changed, so the updated docs should reflect current.

Target location is docs/source/api_reference/file_specifications, with a link in data_format.

Should be similiar to the ts format specification.

貢獻者指南

研究方向
首先，在 sktime 增強提案倉庫（https://github.com/sktime/enhancement proposals/blob/main/steps/20 saveload/step.md）中找到現有的模型序列化格式檔案規範。然後，按照 ts 格式規範的風格，將內容複製到 docs/source/api reference/file specifications 中。確保更新所有連結，並從 data format 建立一個連結。檢查規範的當前狀態，以反映自增強提案實施以來的任何更改。更新後的文件應進行一致性審查。
技術棧
python
領域
documentation
議題類型
文件
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
1
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1 小時以內
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
活躍
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
清晰
前置要求
Git
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
85