sktime/sktime

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

Open

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

在 GitHub 查看
 (3 留言) (0 反應) (0 負責人)Python (7,162 star) (1,192 fork)batch import
API designdocumentationenhancementgood first issuemodule:base-framework

描述

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.

貢獻者指南

技術棧
python
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
half day
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
fresh
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
mostly clear
前置要求
PythonSphinx documentationsktime repository structure
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
60
研究方向
First, locate the existing model serialization format file specification in the sktime enhancement proposals repo (https://github.com/sktime/enhancement proposals/blob/main/steps/20 saveload/step.md). Then, copy the content to docs/source/api reference/file specifications, following the style of the ts format specification. Ensure to update any links and create a link from data format. Check the current state of the specification to reflect any changes since the enhancement proposal was implemented. The updated docs should be reviewed for consistency.