Skip to content

Add Google Colab setup instructions for beginners. - #21

Open
Nhowmitha-suresh wants to merge 1 commit into
happy-jihye:mainfrom
Nhowmitha-suresh:improve-readme
Open

Add Google Colab setup instructions for beginners.#21
Nhowmitha-suresh wants to merge 1 commit into
happy-jihye:mainfrom
Nhowmitha-suresh:improve-readme

Conversation

@Nhowmitha-suresh

@Nhowmitha-suresh Nhowmitha-suresh commented Dec 20, 2025

Copy link
Copy Markdown

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:

  • Add a beginner-friendly section to the README describing step-by-step Google Colab setup and usage, including GPU selection and runtime notes.

@sourcery-ai

sourcery-ai Bot commented Dec 20, 2025

Copy link
Copy Markdown
Reviewer's guide (collapsed on small PRs)

Reviewer's Guide

Adds 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 steps

flowchart 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
Loading

File-Level Changes

Change Details Files
Document Google Colab GPU-based usage workflow for beginners in the README.
  • Introduce a new 'Running on Google Colab (Beginner Friendly)' section near the end of the README.
  • Outline step-by-step instructions for opening Colab, uploading a notebook from the notebooks folder, enabling GPU runtime, installing dependencies, and executing cells.
  • Add notes about expected training duration for GANs and guidance on using smaller batch sizes for limited GPU memory.
README.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@sourcery-ai sourcery-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant