feat: Add CLI Commands for Browsing and Searching OpenML Studies
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 3/5
- Tempo estimado
- 1-2 dias
- Facilidade para iniciantes
- 52/100
Direção de pesquisa
Start in openml/cli.py with the existing resource CLI patterns and review tests/test_openml/test_cli.py, including its mocked API calls. Verify the studies list, info, and search commands and their documented filtering, pagination, format, and type options. Done means the command behavior is covered by the test suite and the listed pre-commit checks pass.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
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 studies: openml studies list, openml studies info, and openml studies search"
Details
What does this PR implement/fix?
This PR adds three new CLI subcommands under openml studies to improve the user experience of the study/benchmark suite catalogue:
openml studies list - List studies with optional filtering (status, uploader, pagination, output format)
openml studies info <study_id> - Display detailed information about a specific study including tasks, datasets, and metadata
openml studies search - Search studies by name/alias with case-insensitive matching
Why is this change necessary? What is the problem it solves?
Currently, users must write Python code to browse or search OpenML studies and benchmark suites, even for simple tasks like listing available studies or finding a specific benchmark. This creates a barrier to entry and makes the study catalogue less accessible. Adding CLI commands allows users to interact with the study catalogue directly from the command line without writing code.
This directly addresses the ESoC 2025 goal of "Improving user experience of the study catalogue in AIoD and OpenML".
How can I reproduce the issue this PR is solving and its solution?
Before (requires Python code):
import openml
studies = openml.study.list_studies(size=10)
for sid in studies:
study = openml.study.get_study(sid)
print(f"{sid}: {study.name}")
After (CLI commands):
# List first 10 studies
openml studies list --size 10
# Search for benchmark suites by name
openml studies search "OpenML-CC18"
# Get detailed info about a study
openml studies info 14
# List studies by a specific uploader
openml studies list --uploader "openml-bot" --format table
# List benchmark suites (studies with main_entity_type='task')
openml studies list --type suite
Implementation Details:
Added three new functions in openml/cli.py: studies_list(), studies_info(), and studies_search()
Integrated into main CLI parser with proper argument handling
Added comprehensive test suite in tests/test_openml/test_cli.py
Uses existing openml.study.list_studies() and openml.study.get_study() functions - no changes to core API
Follows existing CLI patterns (similar to other resource CLI 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
- Linguagem predominante
- Python
- Estrelas
- 361
- Forks
- 296
- Métricas de merge de PRs
- Nenhum PR com merge em 30d
Guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de openml/openml-python
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 70/100
openml/openml-python#1750 · 1 comentário ·
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 88/100
openml/openml-python#1749 ·
-
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 92/100
openml/openml-python#1746 ·
-
Documentation Good First Issue
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 74/100
openml/openml-python#1708 · 7 comentários ·
-
Good First Issue module:Run testing
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 82/100
openml/openml-python#1646 · 7 comentários · 2 reações ·
Todas as issues de openml/openml-python
Issues semelhantes
-
agent-ready documentation needs-triage
Dificuldade 1/5 1-3 horas Facilidade para iniciantes 88/100
-
documentation
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 91/100
-
workflow-status page template still says reusable workflows are "triggered only by workflow_call:" Aberta
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 92/100
-
instance instance add
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 72/100
searxng/searx-instances#939 · 1 comentário ·
-
area-deployment area-integrations triage:bot-seen
Dificuldade 2/5 Meio dia Facilidade para iniciantes 86/100