Skip to content

Deep Learning Software Carpentries Tutorial and JupyterLab Page#966

Merged
wwarriner merged 36 commits intouabrc:mainfrom
iam4tune:add-deeplearning-intro
Oct 17, 2025
Merged

Deep Learning Software Carpentries Tutorial and JupyterLab Page#966
wwarriner merged 36 commits intouabrc:mainfrom
iam4tune:add-deeplearning-intro

Conversation

@iam4tune
Copy link
Contributor

@iam4tune iam4tune commented Apr 17, 2025

Pull Request

Overview

Added links for Software Carpentries Deep Learning tutorial to our docs. The PR also includes the JupyterLab page.

Proposed Changes

  • Added a link to the Carpentries Deep Learning tutorial anywhere "deep learning" is mentioned in the documentation.
  • Created a new page that provides guidance on using JupyterLab through Open OnDemand, with notes for Conda environment handling and selection.
  • Added a section "Choosing the right Jupyter Application" on the index page for OOD.

Related Issues

Fixes #924

@iam4tune iam4tune changed the title Add deeplearning intro Deep Learning Software Carpentries Tutorial and JupyterLab Page Apr 17, 2025
@iam4tune iam4tune added this to the Sprint 25-14 milestone Apr 17, 2025
@iam4tune iam4tune added the pr: changes requested Review complete, needs changes label Apr 17, 2025
@iam4tune iam4tune marked this pull request as draft April 18, 2025 19:02
@iam4tune iam4tune modified the milestones: Sprint 25-14, Sprint 25-15 Apr 22, 2025
@iam4tune iam4tune marked this pull request as ready for review April 28, 2025 20:03
@iam4tune iam4tune added pr: review PR is ready for review and removed pr: changes requested Review complete, needs changes labels Apr 28, 2025
@iam4tune iam4tune self-assigned this Apr 28, 2025
@iam4tune iam4tune modified the milestones: Sprint 25-15, Sprint 25-16 May 6, 2025
Copy link
Contributor

@wwarriner wwarriner left a comment

Choose a reason for hiding this comment

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

Wow, a lot of great work! Very thorough!

There are some SPAG and style things to work out.

My main concern is the large amount of cross-linked/duplicated content shared between the Jupyter Notebook and JupyterLab pages. Perhaps we could move that content out to a common page "Working with Jupyter Software". Then, at appropriate places in each of the two pages (Notebook, Lab), direct the users to the common page to continue practicing.

Think of it this way... each page (Notebook, Lab) is an introduction to the software and how it works on Cheaha. Once they reader understands the content specific to their chosen software, point them to the shared page.

I envision it like this...

index.md  -->  jupyter.md     -->  $common.md
        \--->  jupyterlab.md  ----/

One additional consideration. The Carpentries content is a separate topic and totally separable from the Jupyter content. Can you please migrate it to a separate PR? You can branch off of this branch and push to your fork and start a new PR that way.

@wwarriner wwarriner added pr: changes requested Review complete, needs changes and removed pr: review PR is ready for review labels May 29, 2025
@wwarriner
Copy link
Contributor

wwarriner commented May 29, 2025

I need to clarify about the second person pronoun "you". If you want to use them that is generally OK, but be consistent. Either stick to "we/you" or avoid it. Mostly it is avoided in your work, hence my suggestions to remove.

@iam4tune iam4tune modified the milestones: Sprint 25-16, Sprint 25-18 Jun 3, 2025
@wwarriner wwarriner modified the milestones: Sprint 25-18, Sprint 25-19 Jun 24, 2025
@wwarriner wwarriner modified the milestones: Sprint 25-19, Sprint 25-20 Jul 1, 2025
@iam4tune iam4tune modified the milestones: Sprint 25-20, Sprint 25-21 Jul 15, 2025
Copy link
Contributor

@wwarriner wwarriner left a comment

Choose a reason for hiding this comment

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

Great, very close! I went ahead and made some cleanup type changes, and renamed the ood_jupyter.md file.

Not all of the comments need fixing, some are FYI.

The major thing we need changed is the long bullets in "Why use *?" sections. If you have need for list-within-list, first consider if that's really necessary, then break it up into itemized lists.

@wwarriner wwarriner added pr: changes requested Review complete, needs changes and removed pr: review PR is ready for review labels Sep 19, 2025
@wwarriner wwarriner removed this from the Sprint 25-24 milestone Sep 19, 2025
@iam4tune iam4tune added pr: review PR is ready for review and removed pr: changes requested Review complete, needs changes labels Oct 7, 2025
Copy link
Contributor

@wwarriner wwarriner left a comment

Choose a reason for hiding this comment

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

Good work! Made some reorg tweaks, and this is ready to merge.

@wwarriner wwarriner added pr: merge PR is ready to merge and removed pr: review PR is ready for review labels Oct 17, 2025
@wwarriner
Copy link
Contributor

Please make an issue to enhance this page using templates/macros (when available).

@wwarriner wwarriner merged commit 5ba0a13 into uabrc:main Oct 17, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pr: merge PR is ready to merge

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add Carpentries "Intro to Deep Learning" lesson

3 participants