Skip to content

Commit 1f819ad

Browse files
committed
Update githubb pages site with binder and small readme phrasing.
1 parent 9b37987 commit 1f819ad

File tree

2 files changed

+19
-5
lines changed

2 files changed

+19
-5
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -215,7 +215,7 @@ python -m ipykernel install --user --name=MLvenv
215215
### Google Colab
216216

217217
Running on Colab is useful as it allows you to access GPU resources.
218-
To run the notebooks in Google Colab click the following links for each of the exercises:
218+
To launch the notebooks in Google Colab click the following links for each of the exercises:
219219

220220
* [Exercise 01](https://colab.research.google.com/github/Cambridge-ICCS/ml-training-material/blob/colab/exercises/01_penguin_classification.ipynb) - [Worked Solution 01](https://colab.research.google.com/github/Cambridge-ICCS/ml-training-material/blob/colab/worked-solutions/01_penguin_classification_solutions.ipynb)
221221
* [Exercise 02](https://colab.research.google.com/github/Cambridge-ICCS/ml-training-material/blob/colab/exercises/02_penguin_regression.ipynb) - [Worked Solution 02](https://colab.research.google.com/github/Cambridge-ICCS/ml-training-material/blob/colab/worked-solutions/02_penguin_regression_solutions.ipynb)
@@ -229,8 +229,8 @@ _Notes:_
229229

230230
### binder
231231

232-
If you cannot operate using a local install, and do not wish to sign up for a Colab account,
233-
the exercises can be launched
232+
If you cannot operate using a local install, and do not wish to sign up for a Google account,
233+
the repository can be launched
234234
[on binder](https://mybinder.org/v2/gh/Cambridge-ICCS/ml-training-material/main).
235235

236236
_Notes:_

slides/index.html

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,7 @@ <h2 id="contents">Contents</h2>
8686
<ul>
8787
<li><a href="#github">GitHub</a></li>
8888
<li><a href="#colab">Colab</a></li>
89+
<li><a href="#binder">binder</a></li>
8990
<li><a href="#solutions">Solutions</a></li>
9091
</ul>
9192
<li><a href="#prerequisites">Prerequisites</a></li>
@@ -135,6 +136,7 @@ <h2 id="setup">Setup Instructions</h2>
135136
<ul>
136137
<li><a href="#github">a local install via Github</a></li>
137138
<li><a href="#colab">online via Google Colab</a></li>
139+
<li><a href="#binder">online via binder</a></li>
138140
</ul>
139141

140142
<p>We recommend the local install approach, especially if you forked the repository, as it is the easiest way to keep a copy of your work and push back to github.</p>
@@ -183,7 +185,8 @@ <h6>Optional) Keep virtual environment persistent in Jupyter Notebooks</h6>
183185
<code>python -m ipykernel install --user --name=MLvenv</code></p>
184186

185187
<h4 id="colab">Google Colab</h4>
186-
<p>To run the notebooks in Google Colab click the following links for each of the exercises:</p>
188+
<p>Running on Colab is useful as it allows you to access GPU resources.<br>
189+
To launch the notebooks in Google Colab click the following links for each of the exercises:</p>
187190
<ul>
188191
<li><a href="https://colab.research.google.com/github/Cambridge-ICCS/ml-training-material/blob/colab/exercises/01_penguin_classification.ipynb">Exercise 01</a></li>
189192
<li><a href="https://colab.research.google.com/github/Cambridge-ICCS/ml-training-material/blob/colab/exercises/02_penguin_regression.ipynb">Exercise 02</a></li>
@@ -196,6 +199,17 @@ <h4 id="colab">Google Colab</h4>
196199
<indent>If you leave a Colab session your work will be lost, so be careful to save any work you want to keep.</indent>
197200
</i></p>
198201

202+
<h4 id="binder">binder</h4>
203+
<p>To run the notebooks in binder click the following link:</p>
204+
<ul>
205+
<li><a href="https://mybinder.org/v2/gh/Cambridge-ICCS/ml-training-material/main">Launch repository in binder</a></li>
206+
</ul>
207+
208+
<p><i>Notes:<br>
209+
<indent>If you leave a binder session your work will be lost, so be careful to save any work you want to keep.</indent>
210+
<indent>Due to the limited resources provided by binder you will struggle to run training in exercises 3 and 4.</indent>
211+
</i></p>
212+
199213
<h4 id="solutions">Solutions</h4>
200214

201215
<p>Worked solutions for all of the exercises can be found in the <inlinecode>worked-solutions/</inlinecode> directory.
@@ -246,7 +260,7 @@ <h4>Python</h4>
246260
</ul>
247261

248262
<h4>git and GitHub</h4>
249-
<p>Unless participating via <a href="#colab">Colab</a> you will be expected to know how to:</p>
263+
<p>Unless participating via <a href="#colab">Colab</a> or <a href="#binder">binder</a> you will be expected to know how to:</p>
250264
<ul>
251265
<li>clone and/or fork a repository,</li>
252266
<li>commit, and</li>

0 commit comments

Comments
 (0)