Documentation and Release Inconsistencies
还没有人认领这个 Issue。
评估
- 难度
- 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 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库，在一个分支上完成修改。
- 提交 Pull Request，并在描述里引用这个 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 个 reaction ·
查看 openml/openml-python 的全部 Issue
相似的 Issue
-
bug
难度 2/5 1-3 小时 新手友好度 75/100
stephrobert/dsoxlab#238 ·
-
难度 2/5 1-3 小时 新手友好度 75/100
-
难度 2/5 1-3 小时 新手友好度 75/100
sublimehq/package_control#1780 ·
-
难度 2/5 1-3 小时 新手友好度 65/100
-
难度 2/5 1-3 小时 新手友好度 70/100
nwg-piotr/nwg-displays#145 ·