Update docs and Ci #120

.github/workflows/auto-publish.yml

@@ -12,37 +12,32 @@ jobs:
         - name: Set up Python
           uses: actions/[email protected]
           with:
-            python-version: 3.8
+            python-version: 3.9
 
         - name: Install poetry
           run: make setup
-
+
+        - name: Install poeblix for version freezing
+          run: poetry self add poeblix@latest
+
         - name: Bump version
           run: |
             poetry version prerelease
-    
 
         - name: Commit changes
           run: |
             git config --local user.email "[email protected]"
             git config --local user.name "GitHub Action"
             git add .
             git commit -m "Bump version" || echo "No changes to commit"
-   
-
-        - name: Update diagram
-          uses: githubocto/repo-visualizer@main
-          with:
-            excluded_paths: "ignore,.github"
-            should_push: false
-
+
         - name: Push changes
           run: git push
+
+        - name: Build with lockfile versions
+          run: poetry blixbuild --only-lock
 
-        - name: Build and publish to pypi
-          uses: JRubics/poetry-publish@v1.16
+        - name: Publish distribution 📦 to PyPI
+          uses: pypa/gh-action-pypi-publish@release/v1
           with:
-            python_version: 3.8
-            pypi_token: ${{ secrets.PYPI_TOKEN }}
-            allow_poetry_pre_release: "yes"
-            ignore_dev_requirements: "yes"
+            password: ${{ secrets.PYPI_TOKEN }}

.github/workflows/build.yml

@@ -7,7 +7,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ["3.8", "3.9", "3.10"]
+        python-version: ["3.9", "3.10", "3.11"]
 
     steps:
     - uses: actions/checkout@v2

docs/basics/quickstart.md

@@ -70,6 +70,13 @@ system:
           - _target_: torchvision.transforms.Normalize
             mean: [0.5, 0.5, 0.5]
             std: [0.5, 0.5, 0.5]
+
+  postprocessing:
+      # Format the batch as required by Lighter as lighter 
+      # takes a dictionary as input. 
+      batch:
+          train: '$lambda x: {"input": x[0], "target": x[1]}'
+
 ```
 
 For more information about each of the LighterSystem components and how to override them, see [here](./config.md)
@@ -79,6 +86,10 @@ We just combine the Trainer and LighterSystem into a single YAML and run the com
 
 === "cifar10.yaml"
     ```yaml
+    trainer:
+      _target_: pytorch_lightning.Trainer
+      max_epochs: 100
+
     system:
       _target_: lighter.LighterSystem
       batch_size: 512
@@ -109,6 +120,12 @@ We just combine the Trainer and LighterSystem into a single YAML and run the com
                 mean: [0.5, 0.5, 0.5]
                 std: [0.5, 0.5, 0.5]
 
+      postprocessing:
+          # Format the batch as required by Lighter as lighter 
+          # takes a dictionary as input. 
+          batch:
+              train: '$lambda x: {"input": x[0], "target": x[1]}'
+
     ```
 === "Terminal"
     ```

pyproject.toml

@@ -41,7 +41,7 @@ classifiers = [  #! Update me
 
 
 [tool.poetry.dependencies]
-python = "^3.8"
+python = "^3.9"
 torch = "^2.1.2"
 pandas = "^1.5.3"
 pytorch-lightning = "^2.1.3"