Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Documentation and Release Inconsistencies

Aperta
#1,530 8 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
45/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
python
Ambito
documentation, release

Direzione di ricerca

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.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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?

Lingua principale
Python
Stelle
361
Fork
296
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Apri la guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di openml/openml-python

Tutte le issue di openml/openml-python

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.