Skip to content

Small updates following JOSE review #57

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 30, 2024
Merged

Small updates following JOSE review #57

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
be2b405
Point to issues rather than new-issue in contribution guidelines.
jatkinson1000 May 30, 2024
3f7f94c
Add major package versions on readme in case users experience issues …
jatkinson1000 May 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -195,7 +195,12 @@ From within the root directory in a active virtual environment run:
```
pip install .
```
This will download the relevant dependencies into the venv as well as setting up the datasets that we will be using in the course.
This will download the relevant dependencies into the venv as well as setting up the
datasets that we will be using in the course.\
Whilst the workshop should install and run with the latest versions of python libraries,
it has been tested with following versions for major dependencies: torch 2.0.1,
pandas 2.1.0, palmerpenguins 0.1.4, ipykernel 6.25.2, matplotlib 3.8.0, notebook 7.0.3.


#### 4. Run the notebook

Expand Down Expand Up @@ -261,7 +266,7 @@ If you spot an issue with the materials please let us know by
here on GitHub clearly describing the problem.

If you are able to fix an issue that you spot, or an
[existing open issue](https://github.com/Cambridge-ICCS/ml-training-material/issues/new/choose)
[existing open issue](https://github.com/Cambridge-ICCS/ml-training-material/issues)
please get in touch by commenting on the issue thread.

Contributions from the community are welcome.
Expand Down
6 changes: 4 additions & 2 deletions slides/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,9 @@ <h6>3) Install dependencies</h6>

<p>From within the root directory in a active virtual environment run:
<code>pip install .</code>
This will download the relevant dependencies into the venv as well as setting up the datasets that we will be using in the course.</p>
This will download the relevant dependencies into the venv as well as setting up the datasets that we will be using in the course.<br>
Whilst the workshop should install and run with the latest versions of python libraries, it has been tested with following versions for major dependencies: torch 2.0.1, pandas 2.1.0, palmerpenguins 0.1.4, ipykernel 6.25.2, matplotlib 3.8.0, notebook 7.0.3.</p>


<h6>4) Run the notebook</h6>
<p>From the current directory, launch the Jupyter notebook server:
Expand Down Expand Up @@ -293,7 +295,7 @@ <h2 id="license">License</h2>

<h2 id="contribution-guidelines-and-support">Contribution Guidelines and Support</h2>
<p>If you spot an issue with the materials please let us know by <a href="https://github.com/Cambridge-ICCS/ml-training-material/issues/new/choose" target=blank>opening an issue</a> on GitHub clearly describing the problem.</p>
<p>If you are able to fix an issue that you spot, or an <a href="https://github.com/Cambridge-ICCS/ml-training-material/issues/new/choose" target=blank>existing open issue</a> please get in touch by commenting on the issue thread.</p>
<p>If you are able to fix an issue that you spot, or an <a href="https://github.com/Cambridge-ICCS/ml-training-material/issues" target=blank>existing open issue</a> please get in touch by commenting on the issue thread.</p>
<p>Contributions from the community are welcome. To contribute back to the repository please first <a href="https://github.com/Cambridge-ICCS/ml-training-material/fork" target=blank>fork it</a>, make the neccessary changes to fix the problem, and then open a pull request back to this repository clerly describing the changes you have made. We will then preform a review and merge once ready.</p>
<p>If you would like support using these materials, adapting them to your needs, or delivering them please get in touch either via GitHub or via <a href="https://github.com/Cambridge-ICCS" target=blank>ICCS</a>.</p>

Expand Down
Loading