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

qualiaMachine · 2025-05-15T20:23:58Z

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:

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

1. Create folder for workshop - store data and venv folder 2. Call virtual environment folder "venv", following conventions 3. Require Python 3.11.9. Newer versions of Python are not yet compatible with Tensorflow

…lder)

github-actions · 2025-05-15T20:24:07Z

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

carschno

Again, apologies for the late review.
I have left a few suggestions, mostly about using .venv instead of venv.

carschno · 2025-09-01T14:49:22Z

learners/setup.md

 ```shell
-py -m venv dl_workshop
+# Use python3 or py instead if one of them points to 3.11.9.
+python -m venv venv # 1st "venv" is commmand, 2nd venv is name of the virtual environment / folder


The guide linked above uses .venv as environment folder, which has become best practice. The downside is (on purpose) that the folder is invisible by default, but I think I would prefer sticking with the instructions to avoid confusion.

Suggested change

python -m venv venv # 1st "venv" is commmand, 2nd venv is name of the virtual environment / folder

python -m venv .venv

carschno · 2025-09-01T14:50:25Z

learners/setup.md

 ```shell
-python3 -m venv dl_workshop
+python --version
+py --version


I think this line has potential for confusion. Where does a py binary come from? Is it likely to occur when following the instructions above?

Suggested change

py --version

carschno · 2025-09-01T14:50:53Z

learners/setup.md

+
+Open a terminal and run the following commands.
+
+1. Create a [virtual environment](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/#create-and-use-virtual-environments) called `venv` using the "venv" command:


Suggested change

1. Create a [virtual environment](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/#create-and-use-virtual-environments) called `venv` using the "venv" command:

1. Create a [virtual environment](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/#create-and-use-virtual-environments) using the "venv" command:

carschno · 2025-09-01T14:55:04Z

learners/setup.md

+If you run the `ls` command from `~/Desktop/dl_workshop`, you should see a new `venv` folder inside it
+
+```shell
+ls
+```
+
+```output
+venv/
+```


To be consistent with my suggestions above, and for conciseness:

Suggested change

If you run the `ls` command from `~/Desktop/dl_workshop`, you should see a new `venv` folder inside it

```shell

ls

```

```output

venv/

```

If you run the `ls` command from `~/Desktop/dl_workshop`, you should see a new `.venv` folder inside it

```shell

ls -a -d .venv

.venv

carschno · 2025-09-01T14:55:16Z

learners/setup.md


 ```shell
-source dl_workshop/bin/activate
+source venv/bin/activate


Suggested change

source venv/bin/activate

source .venv/bin/activate

carschno · 2025-09-01T14:55:27Z

learners/setup.md


 ```shell
-dl_workshop\Scripts\activate
+venv\Scripts\activate


Suggested change

venv\Scripts\activate

.venv\Scripts\activate

carschno · 2025-09-01T14:55:37Z

learners/setup.md

+If you're using Git Bash on Windows, you need to add the source command first.
+
+```shell
+source venv/Scripts/activate


Suggested change

source venv/Scripts/activate

source .venv/Scripts/activate

carschno · 2025-09-01T14:56:17Z

learners/setup.md

-Remember that you need to activate your environment every time you restart your terminal!
+**Note**: Remember that you need to activate your environment every time you restart your terminal, and before you launch Jupyter Lab!
+
+3. After activating the enviornment, upgrade pip. This is a good practice to follow when you first initialize your virtual environment (beforing installing additional packages). [Pip](https://pip.pypa.io/en/stable/) is the package management system built into Python.Pip should be available in your system once you installed Python successfully.


Typo:

Suggested change

3. After activating the enviornment, upgrade pip. This is a good practice to follow when you first initialize your virtual environment (beforing installing additional packages). [Pip](https://pip.pypa.io/en/stable/) is the package management system built into Python.Pip should be available in your system once you installed Python successfully.

3. After activating the environment, upgrade pip. This is a good practice to follow when you first initialize your virtual environment (beforing installing additional packages). [Pip](https://pip.pypa.io/en/stable/) is the package management system built into Python.Pip should be available in your system once you installed Python successfully.

ashwinvis · 2025-09-05T10:36:37Z

learners/setup.md

+
+4. Install the required packages:
+
+Follow the OS-specific instructions below. NOte that It may take 10-20 minutes to install everything.


Suggested change

Follow the OS-specific instructions below. NOte that It may take 10-20 minutes to install everything.

Follow the OS-specific instructions below. Note that it may take 10-20 minutes to install everything.

qualiaMachine added 13 commits May 12, 2025 21:46

Update setup.md

b821a55

1. Create folder for workshop - store data and venv folder 2. Call virtual environment folder "venv", following conventions 3. Require Python 3.11.9. Newer versions of Python are not yet compatible with Tensorflow

Update setup.md

812de10

Update setup.md

28c1d7e

Update setup.md

e2b394b

Update setup.md

2ea33dd

Update setup.md

5f45564

Update setup.md

4b355ff

specify to move data to workshop folder

5b848b5

explicitly tell learners where to put all 5 data files (in data subfo…

02097ba

…lder)

match setup (data stored in data subfolder)

7268d69

fix typo from last commit

81128ad

update data path to match setup

a337f55

adjust headers (only core steps as 2nd level header)

c5ef5d7

github-actions bot pushed a commit that referenced this pull request May 15, 2025

differences for PR #587

fe62bc0

avoid uploading venv note

e6faa3c

github-actions bot pushed a commit that referenced this pull request May 18, 2025

differences for PR #587

eacd83d

windows should use terminal as well. never use windows command prompt

285e2d9

github-actions bot pushed a commit that referenced this pull request May 18, 2025

differences for PR #587

fd8dc52

bold activate env.

4ebb21d

github-actions bot pushed a commit that referenced this pull request May 18, 2025

differences for PR #587

90d2017

add min version numbers as comments

0bb44ab

github-actions bot pushed a commit that referenced this pull request May 18, 2025

differences for PR #587

81a5df1

carschno reviewed Sep 1, 2025

View reviewed changes

	python -m venv venv # 1st "venv" is commmand, 2nd venv is name of the virtual environment / folder
	python -m venv .venv


		Open a terminal and run the following commands.

		1. Create a [virtual environment](https://packaging.python.org/en/latest/guides/installing-using-pip-and-virtual-environments/#create-and-use-virtual-environments) called `venv` using the "venv" command:

	3. After activating the enviornment, upgrade pip. This is a good practice to follow when you first initialize your virtual environment (beforing installing additional packages). [Pip](https://pip.pypa.io/en/stable/) is the package management system built into Python.Pip should be available in your system once you installed Python successfully.
	3. After activating the environment, upgrade pip. This is a good practice to follow when you first initialize your virtual environment (beforing installing additional packages). [Pip](https://pip.pypa.io/en/stable/) is the package management system built into Python.Pip should be available in your system once you installed Python successfully.


		4. Install the required packages:

		Follow the OS-specific instructions below. NOte that It may take 10-20 minutes to install everything.

Uh oh!

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

Are you sure you want to change the base?

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

Uh oh!

Conversation

qualiaMachine commented May 15, 2025

Uh oh!

github-actions bot commented May 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Thank you!

Rendered Changes

Uh oh!

carschno left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

This comment was marked as duplicate.

Uh oh!

ashwinvis Sep 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

github-actions bot commented May 15, 2025 •

edited

Loading

ashwinvis Sep 5, 2025 •

edited

Loading