Add Google Colab setup instructions for beginners. - #21
Open
Nhowmitha-suresh wants to merge 1 commit into
Open
Conversation
Reviewer's guide (collapsed on small PRs)Reviewer's GuideAdds a beginner-friendly section to the README explaining how to run the project on Google Colab with GPU support, including step-by-step instructions and practical notes for new users. Flow diagram for Google Colab setup stepsflowchart TD
A[Open Google Colab] --> B[Upload notebook from notebooks folder]
B --> C[Open Runtime menu]
C --> D[Click Change runtime type]
D --> E[Select GPU as hardware accelerator]
E --> F[Install required dependencies]
F --> G[Run cells step by step]
G --> H{GPU memory sufficient?}
H -->|Yes| I[Continue training]
H -->|No| J[Reduce batch size]
J --> G
File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
There was a problem hiding this comment.
Hey - I've left some high level feedback:
- Consider clarifying step 5 by either linking to an existing requirements file or giving a concrete install command (e.g.,
pip install -r requirements.txt) so beginners know exactly how to install dependencies.
Prompt for AI Agents
Please address the comments from this code review:
## Overall Comments
- Consider clarifying step 5 by either linking to an existing requirements file or giving a concrete install command (e.g., `pip install -r requirements.txt`) so beginners know exactly how to install dependencies.Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
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.
This PR adds a beginner-friendly section explaining how to run the project using Google Colab with GPU support.
This helps new users quickly experiment with the model.
Summary by Sourcery
Documentation: