Use HiPerGator to Launch Jupyter and Open a Notebook

Watch

This video was part of the Computing for AI course. It is provided here as a refresher, in case you would like to watch it again.

Thumbnail screenshot of a Practicum AI video Video: Launching a Jupyter session on HiPerGator

Use HiPerGator to Launch Jupyter and Open a Notebook

Using HiPerGator requires that you have a HiPerGator account.

A HiPerGator account is not provided as part of the Practicum AI courses via Professional and Workforce Development.

If you have an account, you will want to ensure you are part of a group with access to at least 2 NCUs, 1 GPU, and 1 TB of Blue storage. Details of these resources are reviewed in the HiPerGator New User Account training.

Launching a Jupyter Notebook session on HiPerGator involves specifying the resources that your session will use. As outlined in the account training, the HiPerGator scheduler needs information on four key elements:

  1. How many CPUs do you want: For the Practicum AI trainings, 2 should be sufficient.
  2. How much memory do you want: For the Practicum AI trainings, 15GB should be sufficient.
  3. How many GPUs do you want: For the Practicum AI trainings, 1 should be sufficient (though we don’t need one for this course).
  4. How long do you want the resources: For the Practicum AI trainings, 2 hours should be sufficient for most exercises.

We will use the Open OnDemand (OOD) web interface to launch and connect to Jupyter sessions. OOD provides an easy interface to provide the resource request, submit the job to the scheduler, and connect to the Jupyter server once it starts.

Steps to launch a Jupyter Notebook session

  • Once you have a HiPerGator account, log in at: https://ood.rc.ufl.edu/
  • Click on the Jupyter Notebook pinned application card.
    • Alternatively, you can use the Interactive Apps menu, scroll all the way to the bottom, and select Jupyter Notebook

Screen shot of the OOD page and the pinned Jupyter Notebook app card to use

  • The next screen allows you to request resources to run a job on HiPerGator.
  • See the image for reference, but the suggested resource request for most of the Practicum AI courses is:
    • Number of CPUs: 1 or 2
    • Maximum Memory: 15GB
    • SLURM Account and QOS: Group name as needed.
    • Time Requested: 2
    • Cluster Partition: default (or gpu if you want a GPU, though this course does not use it)
    • Generic Resource Request: blank (or “gpu:a100:1” if you selected gpu above.)
  • After entering the information, click the Launch button

Screenshot of the launch button

  • On the next page, your job will have a card. The card will start with a light blue border with “Queued” in the upper right. That means your job has been submitted to the scheduler and is waiting for the scheduler to find resources (or for them to be available in your group’s allocation). Once the resources are available, the card will change to a bark blue border with “Starting,” and finally, when your job is ready, it will have a green border, say “Running,” and have a button to click to “Connect to Jupyter.”

Screenshot of the stages of your job card: queued, starting, and running

  • Clicking the “Connect to Jupyter” button will open a new tab and should open with a window like what is pictured below—on future connections, it will normally open with the documents you had opened last time.

Screenshot of the screen that appears after clicking on the Connect to Jupyter button

Cloning your repository onto the HPC system

  • In a different tab, go to your GitHub repository for this course. It should be at GitHub, then your GitHub username, then the repository name you provided, e.g., python-for-ai.
  • Click on the following three buttons:
    • The Green <> Code button
    • The SSH button
    • The copy button to copy the URL. See the image for reference.

      Note: in the Computing for AI course, you set up SSH keys on HiPerGator and added the public key to your GitHub account. So, now, rather than the HTTPS link, we can use the SSH link.

    Screenshot of the buttons to click to get the clone link for your repository using HTTPS

  • Return to your Jupyter tab and click the Git tab on the far left of the Jupyter screen (3rd one down), then Clone a Repository button.

Screenshot of the Jupyter screen, showing the git tab and the Clone a repository button

  • Paste the URL you copied from your GitHub repository above in the pop-up window.

Screenshot the popup where you paste the URL you copied from GitHub

  • Click back on the File Browser tab (top tab on the left under the Jupyter logo). You should now have a folder with the name of your repository (python-for-ai). Double-click to open that folder.
  • Open the 01_brief_intro_python.ipynb notebook.
  • Read through the notebook and follow the exercises.

Return to Module 1 to continue.