Merge pull request #103 from orobix/feature/torch-upgrade

Feature/torch upgrade

.github/workflows/docs.yaml

@@ -22,7 +22,7 @@ jobs:
       - name: Install Dependencies
         run: |
           python -m pip install -U pip poetry
-          python -m poetry install --no-cache -E docs
+          python -m poetry install --no-cache --with docs
 
       - name: Determine Version
         id: determine_version

.github/workflows/tests.yml

@@ -37,7 +37,7 @@ jobs:
       - name: Install Package
         run: |
           python -m pip install -U pip poetry
-          python -m poetry install --no-cache -E test -E onnx
+          python -m poetry install --no-cache --with test -E onnx
 
       - name: Run Tests
         run: |

BREAKING_CHANGES.md

@@ -1,6 +1,13 @@
 # Breaking Changes
 All the breaking changes will be documented in this file.
 
+### [2.0.0]
+
+#### Changed
+
+- Quadra 2.0.0 works with torch 2 and pytorch lightning 2, lightning trainer configurations must be aligned following the [migration guide](https://lightning.ai/docs/pytorch/LTS/upgrade/migration_guide.html).
+- Quadra now relies on CUDA 12 to work instead of the old CUDA 11.6
+
 ### [1.5.0]
 
 #### Changed

CHANGELOG.md

@@ -2,6 +2,18 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+### [2.0.0]
+
+#### Updated
+
+- Update torch to 2.1.2 with CUDA 12 support
+- Update pytorch lightning to 2.1.*
+
+#### Changed
+
+- Refactor hydra plugins to use optional dev groups intend of extras to avoid dragging local packages around in external installations
+- Refactor extra dev dependencies to use poetry groups instead
+- Improve trainer configs to avoid wrong overrides when calling different trainer overrides
 ### [1.5.8]
 
 #### Fix

README.md

@@ -92,16 +92,18 @@ source myenv/bin/activate
   pip install --upgrade pip
   ```
 
-3a. **Install the `quadra` package** with pip:
-  ```shell
-  pip install git+https://github.com/orobix/quadra.git
-  ```
+3. Install the package
 
-3b. **Install the `quadra` package** with poetry:
-  ```shell
-  pip install poetry
-  poetry add git+https://github.com/orobix/quadra.git
-  ```
+    * **Install the `quadra` package** with pip:
+      ```shell
+      pip install git+https://github.com/orobix/quadra.git
+      ```
+
+    * **Install the `quadra` package** with poetry:
+      ```shell
+      pip install poetry
+      poetry add git+https://github.com/orobix/quadra.git
+      ```
 
 4. **Run from CLI**:
   Run the following command to check if the installation was successful:
@@ -243,7 +245,7 @@ First clone the repository from Github
 First clone the repository from `Github`, then we need to install the package with optional dependencies (generally in editable mode) and enable the pre-commit hooks.
 
 1. `git clone https://github.com/orobix/quadra.git && cd quadra` 
-1. Install `quadra` package in editable mode `poetry install -E dev -E docs -E test`
+1. Install `quadra` package in editable mode `poetry install --with test,dev,docs --all-extras`
 2. Install pre-commit hooks `pre-commit install`
 3. (Optional) Eventually build documentation by calling required commands (see below).
 

docs/tutorials/contribution.md

@@ -15,9 +15,9 @@ After setting up your environment you can install `Quadra` Library in different
 
 !!!info
 
-    - `poetry install -E dev` (for development) 
-    - `poetry install -E docs` (for documentation)
-    - `poetry install -E test` (for testing)
+    - `poetry install --with dev` (for development) 
+    - `poetry install --with docs` (for documentation)
+    - `poetry install --with test` (for testing)
 
 
 ## Pre-commit Hooks

docs/tutorials/devices_setup.md

@@ -12,7 +12,6 @@ devices: [0]
 accelerator: gpu
 min_epochs: 1
 max_epochs: 10
-resume_from_checkpoint: null
 log_every_n_steps: 10
 ```