Documentation and Release Inconsistencies
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 45/100
- issue の種類
- ドキュメント
- 明瞭さ
- おおむね明確
- 活発さ
- 静か
- 技術スタック
- python
- 領域
- documentation, release
調査の方向性
Start with the linked OpenML Python documentation example and compare its behavior with the package built from GitHub and installed from PyPI, focusing on run_model_on_task and the avoid_duplicate_runs parameter. Then review how the develop and main branches are used for development and releases. Done means the API-key or parameter requirement and the intended stable and development branches are clearly documented.
索引モデルが issue の本文から書いたものです。
説明
While trying to reproduce the example from the documentation, we noticed that it does not work when using the openml-python package built from the GitHub source in a local development environment. The same example does work when installing the package from PyPI, but only if avoid_duplicate_runs=False is explicitly passed to run_model_on_task; otherwise, an API key–related error is raised. If this behavior is expected, it might be helpful to document that an API key is required (or that this parameter needs to be set) in order to run the example successfully.
Additionally, it appears that the develop branch is currently being used for both active development and releases, while main is somewhat out of date. This can make it unclear which branch should be considered the stable reference point for users and contributors. Would it make sense to either update main and use it as the release branch, or to more explicitly document the intended branching and release strategy?
- 主要言語
- Python
- スター
- 361
- フォーク
- 296
- PR マージ指標
- 30日以内にマージされた PR はありません
コントリビューションガイド
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
openml/openml-python のほかの issue
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
openml/openml-python#1750 · コメント 1 件 ·
-
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
openml/openml-python#1749 ·
-
難易度 1/5 1時間未満 初心者へのやさしさ 92/100
openml/openml-python#1746 ·
-
Documentation Good First Issue
難易度 2/5 1〜3時間 初心者へのやさしさ 74/100
openml/openml-python#1708 · コメント 7 件 ·
-
Good First Issue module:Run testing
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
openml/openml-python#1646 · コメント 7 件 · リアクション 2 件 ·
openml/openml-python の issue をすべて見る
似ている issue
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 75/100
xinnan-tech/xiaozhi-fde-talk#263 ·
-
rules
難易度 1/5 1時間未満 初心者へのやさしさ 90/100
-
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
huggingface/Repo2RLEnv#163 · コメント 1 件 ·
-
難易度 1/5 1時間未満 初心者へのやさしさ 95/100
huggingface/sentence-transformers#4074 ·
-
comp/dashboard invalid P3
難易度 2/5 1〜3時間 初心者へのやさしさ 70/100
NousResearch/hermes-agent#121143 ·