Docs: Add HelloWorld Example Notebook (#69)#320
Closed
info-gallary wants to merge 4 commits into
Closed
Conversation
Collaborator
|
#202 the danra hello world example is almost complete. Please add your input there |
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
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.
Describe your changes
Added a HelloWorld.ipynb notebook to the docs folder to provide a simple, step-by-step onboarding guide.
This resolves the need for an end-to-end example notebook by demonstrating:
(I tested the environment setup and verified that mllam-data-prep and create_graph.py
execute as expected with the provided config)
Dependencies: Added ipykernel to development dependencies to support running the notebook.
Issue Link
closes #69
Type of change
Checklist before requesting a review
pullwith--rebaseoption if possible).Checklist for reviewers
Each PR comes with its own improvements and flaws. The reviewer should check the following:
Author checklist after completed review
reflecting type of change (add section where missing):
Checklist for assignee