sktime/sktime

[DOC] Improve documentation on multithreading and parallelization

Open

#6,174 建立於 2024年3月20日

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

描述

Describe the issue linked to the documentation

Pull request https://github.com/sktime/sktime/pull/6002 deprecates setting n_jobs through object initialization. The docstring of deprecation shows how to do it, but

  1. With :
c22_mv = Catch22(catch24=catch24, col_names="short_str_feat")
c22_mv.set_config(backend="joblib", backend_params={"n_jobs": n_jobs})

I get a warning c22_mv.set_config is not callablePylint[E1102:not-callable]

  1. I cannot find anywhere in documentation how to set n_jobs, and how the set_config should work.

Once we remove the deprecation warning, it will become unclear (in my opinion) how to use multithreading at all.

Suggest a potential alternative/fix

Ideally, one of the pages in documentation should be dedicated to guide on multithreading.

貢獻者指南

技術棧
python
領域
documentation
議題類型
documentation
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
1-2 days
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Pythonsktime basicsparallel computing concepts
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
75
研究方向
Investigate the deprecation in PR #6002 and the set config method. Review existing documentation on configuration and parallelization. Create a new page in the documentation that explains how to set n jobs using set config, with examples for different backends like joblib. Address the warning issue and clarify the correct usage.
[DOC] Improve documentation on multithreading and parallelization · sktime/sktime#6174 | Good First Issue