Added module level docstring to flows and runs tutorial example. #53
Open
shavaiz594 wants to merge 1 commit intoopenml:mainfrom
Open
Added module level docstring to flows and runs tutorial example. #53shavaiz594 wants to merge 1 commit intoopenml:mainfrom
shavaiz594 wants to merge 1 commit intoopenml:mainfrom
Conversation
shavaiz594
changed the title
Anubhav741
pushed a commit
to Anubhav741/docs
that referenced
this pull request
Feb 22, 2026
Added setup guide for [`aiondemand`](https://github.com/aiondemand/aiondemand) and [`AIoD-rest-api`](https://github.com/aiondemand/AIoD-rest-api) ## Related Issues openml#53
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR adds clear module-level docstrings to the following example scripts:
->simple_datasets_tutorial.py
->simple_flows_and_runs_tutorial.py
The added docstrings provide a brief overview of each tutorial’s purpose, including what concepts they demonstrate and how they help users understand the OpenML Python API.
These improvements:
-> Enhance readability for new users
->Provide quick context when opening the files in editors/IDEs
->Align the examples with good Python documentation practices
Type of change:
Documentation improvement (no functional changes).