Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Documentation and Release Inconsistencies

Đang mở
  • Có gì không ổn?
#1,530 8 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
45/100
Loại issue
Tài liệu
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Ít trao đổi
Công nghệ
python
Lĩnh vực
documentation, release

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

Documentation question

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?

Ngôn ngữ chính
Python
Star
362
Fork
304
Merge trung bình
2 ngày 20 giờ
Pull request đã merge (30 ngày)
2

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của openml/openml-python

Tất cả issue của openml/openml-python

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.