Skip to content

Commit

Permalink
add getting started instructions to README
Browse files Browse the repository at this point in the history
  • Loading branch information
davedgd authored Aug 5, 2023
1 parent 0671ce3 commit 7d41f75
Showing 1 changed file with 16 additions and 1 deletion.
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -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)

0 comments on commit 7d41f75

Please sign in to comment.