[DOC] Add usage examples to core function docstrings (Fixes #1538)

[Abhishek9639]

[DOC] Add usage examples to core function docstrings. Closes #1538

Metadata

• Reference Issue: Fixes [DOC] Add Usage Examples to Core Function Docstrings #1538
• New Tests Added: No
• Documentation Updated: Yes
• Change Log Entry: Add usage examples to core function docstrings

Details

This PR adds usage examples to selected public core functions in the project
to improve developer experience and documentation clarity.

The following functions were updated with example usage sections:

• get_dataset()
• get_datasets()
• get_task()
• run_model_on_task()
• get_suite()
• get_study()
• create_study()

Why this change is necessary:
Examples in docstrings help users understand how to use the functions directly
from IDE hover tooltips and improve auto-generated documentation.

Reproduction:
No bug reproduction is required. This is a documentation enhancement.

Additional Notes:
Only docstrings were modified. No functional code changes were made.

[Abhishek9639]

[geetu040]

Please fix the code quality checks, here is the guide
http://openml.github.io/openml-python/latest/developer_setup/#4-configure-quality-gates

[Abhishek9639]

Hii @geetu040 and @fkiraly,
Fixed the code quality checks. All pre-commit checks are now passing.
Please review it.

[geetu040]

Really nice. Left comment for one example, otherwise looks all good and it covers all the mentioned functions in the issue.

[Abhishek9639]

@geetu040,
Addressed all feedback,
Fixed run_model_on_task example using HistGradientBoostingClassifier instead of DecisionTreeClassifier (it handles missing values natively, so no more ValueError: could not convert string to float) Removed .DS_Store and features_with_whitespaces.xml.pkl
If any further changes are needed, please let me know.
Please review

[geetu040]

see #1689 (comment)

[Abhishek9639]

@geetu040,
Updated as suggested now using openml.tasks.get_task(6) with DecisionTreeClassifier. Also removed .DS_Store and features_with_whitespaces.xml.pkl as requested. All pre-commit checks are passing. Please review
If any other changes are needed. please let me know.
Thanks

[geetu040]

LGTM.

@fkiraly please merge.

[PGijsbers]

One minor suggestion, otherwise LGTM.
Feel free to dismiss my review when the change is made.

[Abhishek9639]

Hi @PGijsbers
Done. updated the description to "decision trees" as you suggested.
Let me know if it looks good.
Thanks

[codecov-commenter]

Codecov Report

❌ Patch coverage is 66.66667% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 54.67%. Comparing base (e653ef6) to head (3f919ea).

Files with missing lines	Patch %	Lines
openml/runs/functions.py	50.00%	1 Missing ⚠️

Additional details and impacted files

@@           Coverage Diff           @@
##             main    #1689   +/-   ##
=======================================
  Coverage   54.67%   54.67%           
=======================================
  Files          63       63           
  Lines        5108     5108           
=======================================
  Hits         2793     2793           
  Misses       2315     2315           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[Abhishek9639]

Hi @PGijsbers,
The 2 failing CI checks (test_initialize_model_from_run and test_run_exists) seem to be pre-existing flaky tests sklearn flow parameter mismatches on the test server, not related to this PR's docstring change.
Thanks