Skip to content

Update setup: control python version, explicit data folder, instructions for colab, and more #587

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 17 commits into
base: main
Choose a base branch
from

Conversation

qualiaMachine
Copy link
Collaborator

The key change here is that I require learners to download Python 3.11.9, which is compatible with Tensorflow and Keras. Newer versions of Python may run into some issues. There are a few other minor changes to the setup — let me know if you want this broken into multiple pull request. I'll summarize below:

  1. Provide overview of all setup steps at the top to help frame the full setup
  2. Require python version 3.11.9
  3. Add instructions for checking python version before/while installing packages and after Jupyter lab is launched to confirm everything worked
  4. Explicitly tell learners to create a data folder, and update episodes with data path, when needed
  5. Recommend Git Bash over Anaconda Prompt for those on Windows machines. Tends to have fewer Windows quirks.
  6. Emphasize/bold activating virtual environment before launching Jupyter Lab
  7. Call the virtual environment "venv", as this is standard practice. Add comments clarifying why we type "venv" twice when creating the virtual environment.
  8. Add note about Colab, and how learners will have to upload their data to MyDrive and mount their google drive (code shown)

Copy link

github-actions bot commented May 15, 2025

Thank you!

Thank you for your pull request 😃

🤖 This automated message can help you check the rendered files in your submission for clarity. If you have any questions, please feel free to open an issue in {sandpaper}.

If you have files that automatically render output (e.g. R Markdown), then you should check for the following:

  • 🎯 correct output
  • 🖼️ correct figures
  • ❓ new warnings
  • ‼️ new errors

Rendered Changes

🔍 Inspect the changes: https://github.com/carpentries-lab/deep-learning-intro/compare/md-outputs..md-outputs-PR-587

The following changes were observed in the rendered markdown documents:

 3-monitor-the-model.md    |   2 +-
 4-advanced-layer-types.md |   2 +-
 5-transfer-learning.md    |   2 +-
 md5sum.txt                |   8 +-
 setup.md                  | 182 +++++++++++++++++++++++++++++++++++-----------
 5 files changed, 147 insertions(+), 49 deletions(-)
What does this mean?

If you have source files that require output and figures to be generated (e.g. R Markdown), then it is important to make sure the generated figures and output are reproducible.

This output provides a way for you to inspect the output in a diff-friendly manner so that it's easy to see the changes that occur due to new software versions or randomisation.

⏱️ Updated at 2025-05-18 20:17:35 +0000

github-actions bot pushed a commit that referenced this pull request May 15, 2025
github-actions bot pushed a commit that referenced this pull request May 18, 2025
github-actions bot pushed a commit that referenced this pull request May 18, 2025
github-actions bot pushed a commit that referenced this pull request May 18, 2025
github-actions bot pushed a commit that referenced this pull request May 18, 2025
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