feat: Add CLI Commands for Browsing and Searching OpenML Runs
Nessuno ha ancora preso questa issue.
Valutazione
- Difficoltà
- 4/5
- Tempo stimato
- 3-5 giorni
- Idoneità per principianti
- 35/100
- Tipo di issue
- Funzionalità
- Chiarezza
- Specificata chiaramente
- Stato di attività
- Ferma
- Stack tecnologico
- python
- Ambito
- cli, machine-learning
Direzione di ricerca
Start with the runs_list(), runs_info(), and runs_download() entry points in openml/cli.py, then review the existing CLI patterns for configure, models, datasets, and tasks. Run the CLI tests in tests/test_openml/test_cli.py; done means the three commands support the documented filters, details, downloads, formatting, and mocked API behavior.
Scritto dal modello di indicizzazione a partire dal testo della issue.
Descrizione
Metadata
New Tests Added: Yes
Documentation Updated: No (CLI help text serves as documentation)
Change Log Entry: "Add CLI commands for browsing and searching OpenML runs: openml runs list, openml runs info, and openml runs download"
Details
What does this PR implement/fix?
This PR adds three new CLI subcommands under openml runs to improve the user experience of the run catalogue:
openml runs list - List runs with optional filtering (task_id, flow_id, uploader, tag, pagination, output format)
openml runs info <run_id> - Display detailed information about a specific run including task, flow, evaluations, and parameter settings
openml runs download <run_id> - Download a run and save predictions to local cache
Why is this change necessary? What is the problem it solves?
Currently, users must write Python code to browse or search OpenML runs, even for simple tasks like listing runs for a specific task or downloading run results. This creates a barrier to entry and makes the run catalogue less accessible. Adding CLI commands allows users to interact with the run catalogue directly from the command line without writing code.
This directly addresses the ESoC 2025 goal of "Improving user experience of the run catalogue in AIoD and OpenML".
How can I reproduce the issue this PR is solving and its solution?
Before (requires Python code):
import openml
runs = openml.runs.list_runs(task=[1], size=10)
for rid, run_dict in runs.items():
print(f"{rid}: Task {run_dict['task_id']}")
After (CLI commands):
# List first 10 runs for a specific task
openml runs list --task 1 --size 10
# List runs by a specific uploader
openml runs list --uploader "John Doe"
# Get detailed info about a run
openml runs info 12345
# Download a run and cache predictions
openml runs download 12345
# List runs for a specific flow, formatted as table
openml runs list --flow 42 --format table --verbose
# Filter by both task and flow
openml runs list --task 1 --flow 42
Implementation Details:
Added three new functions in openml/cli.py: runs_list(), runs_info(), and runs_download()
Integrated into main CLI parser with proper argument handling
Added comprehensive test suite in tests/test_openml/test_cli.py
Uses existing openml.runs.list_runs() and openml.runs.get_run() functions - no changes to core API
Follows existing CLI patterns (similar to configure, models, datasets, and tasks commands)
All tests use mocked API calls to avoid requiring server connections
Any other comments?
All pre-commit hooks pass (ruff, mypy, formatting)
No breaking changes
Follows project code style and patterns
Ready for review
- Lingua principale
- Python
- Stelle
- 361
- Fork
- 296
- Metriche di merge delle PR
- Nessuna PR unita negli ultimi 30g
Guida per i contributori
Apri la guida per i contributori
Come iniziare
- Leggi tutta la issue e poi la guida ai contributi del progetto.
- Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
- Fai un fork del repository e lavora su un branch.
- Apri una pull request che faccia riferimento al numero della issue.
Altre issue di openml/openml-python
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
openml/openml-python#1750 · 1 commento ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 88/100
openml/openml-python#1749 ·
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 92/100
openml/openml-python#1746 ·
-
Documentation Good First Issue
Difficoltà 2/5 1-3 ore Idoneità per principianti 74/100
openml/openml-python#1708 · 7 commenti ·
-
Good First Issue module:Run testing
Difficoltà 2/5 1-3 ore Idoneità per principianti 82/100
openml/openml-python#1646 · 7 commenti · 2 reazioni ·
Tutte le issue di openml/openml-python
Issue simili
-
area: harness bug status: needs-triage
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
Human-Agent-Society/reef#625 ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 70/100
-
Difficoltà 1/5 Meno di un'ora Idoneità per principianti 80/100
learningequality/kolibri#15351 · 2 commenti ·
-
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
-
Name consistency Aperta
Difficoltà 2/5 1-3 ore Idoneità per principianti 75/100
eellak/triplestore#65 · 1 commento ·