Add CI task

Author: bpesquet

.github/workflows/ci.yaml

@@ -0,0 +1,26 @@
+name: Continuous Integration
+
+on:
+  # Trigger the jobs on each push to main branch
+  push:
+    branches:
+      - main
+
+jobs:
+  ci-tests:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install poetry
+        run: pipx install poetry
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.x"
+          cache: "poetry"
+      - name: Install dependencies
+        run: poetry install
+      - name: Check the code
+        run: poetry run pylint pytorch_tutorial/*
+      - name: Run unit tests
+        run: poetry run pytest

ABOUT.md

@@ -6,7 +6,13 @@ In my opinion, a true gem for learning PyTorch from scratch was the [PyTorch Tut
 
 This project aims to follow a similar path by providing a set of bare-bones, self-sufficient, and beginner-friendly examples. They illustrate the core parts of PyTorch in a step-by-step fashion, from tensor manipulation to the training of Deep Learning models. They strive to keep up with API changes and follow good practices.
 
-Rather than Jupyter notebooks, these examples are provided as pure Python files because I think it facilitates a global understanding of their structure. It also simplifies [code formatting](https://github.com/psf/black), [linting](https://github.com/pylint-dev/pylint), and [testing](https://docs.pytest.org). All code examples are heavily commented and accompanied by README files for additional information.
+Rather than Jupyter notebooks, these examples are provided as standalone Python files for the following reasons:
+
+- it facilitates a global understanding of their structure;
+- it simplifies [formatting](https://github.com/psf/black), [linting](https://github.com/pylint-dev/pylint), [testing](https://docs.pytest.org) and [continuous integration](.github/workflows/ci.yaml);
+- it promotes concision and general code quality.
+
+All examples are heavily commented and accompanied by `README` files for an easier follow-through.
 
 You are very welcome to contribute to the improvement of this project through [ideas](https://github.com/bpesquet/pytorch-tutorial/issues) or [corrections](https://github.com/bpesquet/pytorch-tutorial/pulls).
 

README.md

@@ -28,17 +28,18 @@ This project is built with the following software:
 
 - [Poetry](https://python-poetry.org/) for dependency management;
 - [Black](https://github.com/psf/black) for code formatting;
-- [Pylint](https://github.com/pylint-dev/pylint) to detect mistakes in the code;
-- [pytest](https://docs.pytest.org) for testing the code;
-- [Marp](https://marp.app/) for showcasing Markdown files as slideshows during labs.
+- [Pylint](https://github.com/pylint-dev/pylint) to detect mistakes in the codebase;
+- [pytest](https://docs.pytest.org) for testing examples;
+- a [GitHub Action](.github/workflows/ci.yaml) for validating the code upon each push;
+- [Marp](https://marp.app/) for showcasing `README` files as slideshows during lectures or labs.
 
 ### Useful commands
 
 ```bash
 # Reformat all Python files
 black .
 
-# Check the code for mistakes
+# Check the codebase for mistakes
 pylint pytorch_tutorial/*
 
 # Run all code examples as unit tests