docs: Add basic tutorials #134
Open
Conversation
This file contains 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
Motivation for this is mostly that the empty section before the `---` at the bottom triggered an error in Sphinx. But also without this, I don't think that there is any use of having them there, as they don't provide any useful information.
Add two basic tutorials for grid_search and hp_optimization. The goal of these tutorials is to get new users started. As such, they are intentionally minimalistic and do not explain all the available options. They should enable beginners to get cluster_utils running fast and from there allow them to explore more options step by step (though for that much more documentation needs to be written eventually). I put them in the "Basics" section for now, but if more tutorials will be added, it might make sense to add a dedicated "Tutorials" section.
|
@nitinjain96 No code change here, but if you have time for it, it would be great if you could read through the tutorials, to check if everything is easy to understand (from the perspective of a new user). |
Write some better introduction for the tutorials, so users can better understand what the expected outcome of the tutorial is.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Add two basic tutorials for grid_search and hp_optimization.
The goal of these tutorials is to get new users started. As such, they are intentionally minimalistic and do not explain all the available options. They should enable beginners to get cluster_utils running fast and from there allow them to explore more options step by step (though for that much more documentation needs to be written eventually).
I put them in the "Basics" section for now, but if more tutorials will be added, it might make sense to add a dedicated "Tutorials" section.
Rendered pages
Here is what the tutorial pages look like when built locally:
Addresses part of #50.