Add CLI commands for browsing and searching OpenML tasks
Metadata
- Reference Issue: [(Enhancement: Add CLI commands for browsing and searching OpenML flows)](feat: Add CLI Commands for Browsing and Searching OpenML Tasks #1504)](https://github.com/openml/openml-python/issues/1504)
- New Tests Added: Yes
- Documentation Updated: No (CLI help text serves as documentation)
- Change Log Entry: "Add CLI commands for browsing and searching OpenML tasks:
openml tasks list,openml tasks info, andopenml tasks search"
Details
What does this PR implement/fix?
This PR adds three new CLI subcommands under openml tasks to improve the user experience of the task catalogue:
openml tasks list- List tasks with optional filtering (tag, task-type, status, data-name, pagination, output format)openml tasks info <task_id>- Display detailed information about a specific task including task type, dataset, target feature, evaluation measure, and class labelsopenml tasks search <query>- Search tasks by associated dataset name 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 tasks, even for simple operations like listing available tasks or finding tasks for a specific dataset. This creates a barrier to entry and makes the task catalogue less accessible. Adding CLI commands allows users to interact with the task catalogue directly from the command line without writing code.
This directly addresses the ESoC 2025 goal of "Improving user experience of the task catalogue in AIoD and OpenML".
How can I reproduce the issue this PR is solving and its solution?
Before (requires Python code):
import openml
tasks = openml.tasks.list_tasks(size=10)
for tid in tasks:
task = openml.tasks.get_task(tid)
print(f"{tid}: {task.task_type}")```
After (CLI commands):
bash
List first 10 tasks
openml tasks list --size 10
Search for tasks related to iris dataset
openml tasks search iris
Get detailed info about a task
openml tasks info 1
List classification tasks with a specific tag
openml tasks list --task-type "Supervised Classification" --tag study_14 --format table
List tasks with pagination
openml tasks list --offset 20 --size 10``` Implementation Details:
Added three new functions in openml/cli.py: tasks_list(), tasks_info() , and tasks_search() Added handler function tasks_handler() to route subcommands Integrated into main CLI parser with proper argument handling Added comprehensive test suite in tests/test_openml/test_cli.py
Uses existing openml.tasks.list_tasks() and openml.tasks.get_task() functions - no changes to core API Follows existing CLI patterns (similar to configure command) 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