From 7d41f751ffeab299700e2b57f2a1e203064e2836 Mon Sep 17 00:00:00 2001 From: David Dobolyi <4490587+davedgd@users.noreply.github.com> Date: Sat, 5 Aug 2023 11:11:28 -0600 Subject: [PATCH] add getting started instructions to README --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 08439f4..7401f28 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,19 @@ -# python-class-examples +# Python Class Examples Various Python data analysis examples used in my courses. All of these Jupyter Notebooks have been tested in [Google Colab](http://colab.research.google.com) with a T4 GPU (although the TitanicSurvival examples [including MLJAR] do not require a GPU runtime). For help with learning Python, see my [python-bootcamp](https://github.com/davedgd/python-bootcamp). + +# Getting Started (with Google Colab) +- In the Google Colab menu, go to File -> Open notebook +- In the dialogue that appears, click the GitHub tab +- Enter this repo as your GitHub URL, i.e., https://github.com/davedgd/python-class-examples +- Click the search icon (or hit enter) +- Select the notebook you want to open to get started (e.g., AudioCraft.ipynb) +- **Note:** For most examples, you will also need to change the runtime type to one with a GPU... + - In the Google Colab menu, go to Runtime -> Change runtime type + - Under 'Hardware accelator' choose at least a 'T4 GPU' (or better) + - Click the Save button +- To run the notebook, in the Google Colab menu, go to Runtime -> Run all +- If you see a 'Warning: This notebook was not authored by Google' popup, click the 'Run anyway' button +- Wait patiently, as it make take a few minutes to install the packages and run the notebook +- **Note:** You may see occasional error messages, particularly when installing/loading pip packages -- you can generally safely ignore these (as long as the notebook runs)