congrads 1.0.1__tar.gz → 1.0.3__tar.gz

{congrads-1.0.1 → congrads-1.0.3}/.gitlab-ci.yml

@@ -91,7 +91,7 @@ sync:
     - git clone git@github.com:ML-KULeuven/congrads.git ~/congrads-github/
 
     # 5. Install rsync and copy files from GitLab repository to GitHub repo, including hidden files
-    - rsync -av --exclude='.git' --exclude='.gitlab-ci.yml' ./ ~/congrads-github/
+    - rsync -av --delete --exclude='.git' --exclude='.gitlab-ci.yml' --exclude='dist' --exclude='public' ./ ~/congrads-github/
 
     # 6. Stage, commit and tag the files
     - cd ~/congrads-github/

{congrads-1.0.1 → congrads-1.0.3}/.readthedocs.yaml

@@ -4,20 +4,24 @@
 # Required
 version: 2
 
+formats: all
+
 # Set the OS, Python version, and other tools you might need
 build:
   os: ubuntu-24.04
   tools:
-    python: "3.13"
+    python: '3.13'
 
 # Build documentation in the "docs/" directory with Sphinx
 sphinx:
-   configuration: docs/conf.py
+  configuration: docs/conf.py
+  fail_on_warning: true
 
 # Optionally, but recommended,
 # declare the Python requirements required to build your documentation
 # See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
-# python:
-#    install:
-#    - requirements: docs/requirements.txt
-        
+python:
+  install:
+    - requirements: docs/requirements.txt
+    - method: pip
+      path: .

{congrads-1.0.1 → congrads-1.0.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: congrads
-Version: 1.0.1
+Version: 1.0.3
 Summary: A toolbox for using Constraint Guided Gradient Descent when training neural networks.
 Author-email: Wout Rombouts <wout.rombouts@kuleuven.be>, Quinten Van Baelen <quinten.vanbaelen@kuleuven.be>, Peter Karsmakers <peter.karsmakers@kuleuven.be>
 License: Copyright 2024 DTAI - KU Leuven
@@ -41,7 +41,7 @@ Requires-Dist: tensorboard>=2.18.0
 Requires-Dist: tqdm>=4.66.5
 
 <div align="center">
-	<img src="docs/_static/congrads_export.png" height="200">
+	<img src="https://github.com/ML-KULeuven/congrads/blob/main/docs/_static/congrads_export.png?raw=true" height="200">
 	<p>
 	<b>Incorporate constraints into neural network training for more reliable and robust models.</b>
 	</p>
@@ -98,7 +98,7 @@ Please read the documentation at https://congrads.readthedocs.io/en/latest/ to g
 ### 3. **Basic Usage**
 
 Below, a basic example can be found that illustrates how to work with the Congrads toolbox.
-For additional examples, refer to the [examples](https://github.com/ML-KULeuven/congrads/examples) and [notebooks](https://github.com/ML-KULeuven/congrads/notebooks) folders in the repository.
+For additional examples, refer to the [examples](https://github.com/ML-KULeuven/congrads/tree/main/examples) and [notebooks](https://github.com/ML-KULeuven/congrads/tree/main/notebooks) folders in the repository.
 
 #### 1. First, select the device to run your code on with.
 

{congrads-1.0.1 → congrads-1.0.3}/README.md

@@ -1,5 +1,5 @@
 <div align="center">
-	<img src="docs/_static/congrads_export.png" height="200">
+	<img src="https://github.com/ML-KULeuven/congrads/blob/main/docs/_static/congrads_export.png?raw=true" height="200">
 	<p>
 	<b>Incorporate constraints into neural network training for more reliable and robust models.</b>
 	</p>
@@ -56,7 +56,7 @@ Please read the documentation at https://congrads.readthedocs.io/en/latest/ to g
 ### 3. **Basic Usage**
 
 Below, a basic example can be found that illustrates how to work with the Congrads toolbox.
-For additional examples, refer to the [examples](https://github.com/ML-KULeuven/congrads/examples) and [notebooks](https://github.com/ML-KULeuven/congrads/notebooks) folders in the repository.
+For additional examples, refer to the [examples](https://github.com/ML-KULeuven/congrads/tree/main/examples) and [notebooks](https://github.com/ML-KULeuven/congrads/tree/main/notebooks) folders in the repository.
 
 #### 1. First, select the device to run your code on with.
 

{congrads-1.0.1 → congrads-1.0.3}/congrads.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: congrads
-Version: 1.0.1
+Version: 1.0.3
 Summary: A toolbox for using Constraint Guided Gradient Descent when training neural networks.
 Author-email: Wout Rombouts <wout.rombouts@kuleuven.be>, Quinten Van Baelen <quinten.vanbaelen@kuleuven.be>, Peter Karsmakers <peter.karsmakers@kuleuven.be>
 License: Copyright 2024 DTAI - KU Leuven
@@ -41,7 +41,7 @@ Requires-Dist: tensorboard>=2.18.0
 Requires-Dist: tqdm>=4.66.5
 
 <div align="center">
-	<img src="docs/_static/congrads_export.png" height="200">
+	<img src="https://github.com/ML-KULeuven/congrads/blob/main/docs/_static/congrads_export.png?raw=true" height="200">
 	<p>
 	<b>Incorporate constraints into neural network training for more reliable and robust models.</b>
 	</p>
@@ -98,7 +98,7 @@ Please read the documentation at https://congrads.readthedocs.io/en/latest/ to g
 ### 3. **Basic Usage**
 
 Below, a basic example can be found that illustrates how to work with the Congrads toolbox.
-For additional examples, refer to the [examples](https://github.com/ML-KULeuven/congrads/examples) and [notebooks](https://github.com/ML-KULeuven/congrads/notebooks) folders in the repository.
+For additional examples, refer to the [examples](https://github.com/ML-KULeuven/congrads/tree/main/examples) and [notebooks](https://github.com/ML-KULeuven/congrads/tree/main/notebooks) folders in the repository.
 
 #### 1. First, select the device to run your code on with.
 

{congrads-1.0.1 → congrads-1.0.3}/congrads.egg-info/SOURCES.txt

@@ -2,10 +2,8 @@
 .gitlab-ci.yml
 .pylintrc
 .readthedocs.yaml
-DIAGRAM.md
 LICENSE
 README.md
-README_DEV.md
 pyproject.toml
 .vscode/extensions.json
 .vscode/settings.json
@@ -17,7 +15,6 @@ congrads/datasets.py
 congrads/descriptor.py
 congrads/metrics.py
 congrads/networks.py
-congrads/requirements.txt
 congrads/transformations.py
 congrads/utils.py
 congrads.egg-info/PKG-INFO
@@ -31,6 +28,8 @@ docs/concepts.rst
 docs/conf.py
 docs/index.rst
 docs/make.bat
+docs/requirements.in
+docs/requirements.txt
 docs/start.rst
 docs/_static/VanBaelen2023.bib
 docs/_static/congrads_export.png

congrads-1.0.3/docs/requirements.in

@@ -0,0 +1,2 @@
+sphinx==8.1.3
+sphinx-rtd-theme==3.0.2

congrads-1.0.3/docs/requirements.txt

@@ -0,0 +1,57 @@
+#
+# This file is autogenerated by pip-compile with Python 3.11
+# by the following command:
+#
+#    pip-compile requirements.in
+#
+alabaster==1.0.0
+    # via sphinx
+babel==2.17.0
+    # via sphinx
+certifi==2025.1.31
+    # via requests
+charset-normalizer==3.4.1
+    # via requests
+docutils==0.21.2
+    # via
+    #   sphinx
+    #   sphinx-rtd-theme
+idna==3.10
+    # via requests
+imagesize==1.4.1
+    # via sphinx
+jinja2==3.1.5
+    # via sphinx
+markupsafe==3.0.2
+    # via jinja2
+packaging==24.2
+    # via sphinx
+pygments==2.19.1
+    # via sphinx
+requests==2.32.3
+    # via sphinx
+snowballstemmer==2.2.0
+    # via sphinx
+sphinx==8.1.3
+    # via
+    #   -r requirements.in
+    #   sphinx-rtd-theme
+    #   sphinxcontrib-jquery
+sphinx-rtd-theme==3.0.2
+    # via -r requirements.in
+sphinxcontrib-applehelp==2.0.0
+    # via sphinx
+sphinxcontrib-devhelp==2.0.0
+    # via sphinx
+sphinxcontrib-htmlhelp==2.1.0
+    # via sphinx
+sphinxcontrib-jquery==4.1
+    # via sphinx-rtd-theme
+sphinxcontrib-jsmath==1.0.1
+    # via sphinx
+sphinxcontrib-qthelp==2.0.0
+    # via sphinx
+sphinxcontrib-serializinghtml==2.0.0
+    # via sphinx
+urllib3==2.3.0
+    # via requests

{congrads-1.0.1 → congrads-1.0.3}/docs/start.rst

@@ -123,4 +123,4 @@ Example
 
     core.fit(max_epochs=50)
 
-For more examples, refer to the GitHub repository's `example folder <https://github.com/ML-KULeuven/congrads/examples>`_ or the `notebooks folder <https://github.com/ML-KULeuven/congrads/notebooks>`_ for more examples.
+For more examples, refer to the GitHub repository's `example folder <https://github.com/ML-KULeuven/congrads/tree/main/examples>`_ or the `notebooks folder <https://github.com/ML-KULeuven/congrads/tree/main/notebooks>`_ for more examples.

congrads-1.0.1/DIAGRAM.md

@@ -1,135 +0,0 @@
-```mermaid
-
-classDiagram
-
-    Constraint <|-- ScalarConstraint
-
-    class Constraint {
-        name
-        get_reference()
-        check_constraint()
-        calculate_direction()
-    }
-
-    class ScalarConstraint {
-        name
-        reference
-        comparator
-        scalar
-        get_reference()
-        check_constraint()
-        calculate_direction()
-    }
-
-
-    LightningModule <|-- CGGDModule
-
-    class CGGDModule {
-        on_train_start()
-        training_step()
-        validation_step()
-    }
-
-
-    Module <|-- BCNetwork
-
-    class Module {
-        forward()
-    }
-
-    class BCNetwork {
-        n_inputs
-        n_outputs
-        n_hidden_layers
-        hidden_dim
-        forward()
-        static linear()
-    }
-
-
-    CGGDModule <|-- BCModel
-
-    class LightningModule {
-        forward()
-        training_step()
-        validation_step()
-        configure_optimizers()
-    }
-
-    class BCModel {
-        network
-        constraints
-        lr
-        loss_function
-        forward()
-        training_step()
-        validation_step()
-        configure_optimizers()
-    }
-
-
-    LightningDataModule <|-- BCDataModule
-
-    class LightningDataModule{
-      prepare_data()
-      setup()
-      train_dataloader()
-      val_dataloader()
-      test_dataloader()
-    }
-
-    class BCDataModule{
-        dataset_directory
-        batch_size
-        train_size
-        val_size
-        shuflle_train
-        shuffle_val
-        shuffle_test
-        num_workers
-        pin_memory
-        prepare_data()
-        setup()
-        train_dataloader()
-        val_dataloader()
-        test_dataloader()
-        static transform()
-    }
-
-
-    Dataset <|-- BCDataset
-
-    class Dataset {
-        __len__()
-        __getitem__()
-    }
-    class BCDataset{
-        root
-        download
-        transform
-        __len__()
-        __getitem__()
-        download()
-        check_exists()
-    }
-
-    Constraint "many" --o "1" BCModel : has
-    BCNetwork "1" --o "1" BCModel : has
-    BCDataset "1" --o "1" BCDataModule : has
-
-
-    note "RED: low-level Pytorch interfaces\nORANGE: Pytorch Lightning interfaces\nGREEN: Dataset-specific interfaces\nBLUE: CGGD custom interfaces"
-
-    style Module fill:#ea5656
-    style Dataset fill:#ea5656
-    style LightningDataModule fill:#ea7d56
-    style LightningModule fill:#ea7d56
-    style BCModel fill:#57b356
-    style BCNetwork fill:#57b356
-    style BCDataset fill:#57b356
-    style BCDataModule fill:#57b356
-    style CGGDModule fill:#568bb3
-    style Constraint fill:#568bb3
-    style ScalarConstraint fill:#568bb3
-
-```

congrads-1.0.1/README_DEV.md

@@ -1,9 +0,0 @@
-# Releasing new version
-
-To release a new version into the world make sure the following points are followed:
-
-1. Update the package version, both in [pyproject.toml](pyproject.toml) and in the package itself [congrads/__init__.py](congrads/__init__.py)
-2. Regenerate the distribution archives with ```python3 -m build```
-3. Publish the code to PyPi with ```python3 -m twine upload --repository pypi dist/*```
-
-For more information, refer to [this guide](https://packaging.python.org/en/latest/tutorials/packaging-projects/).

congrads-1.0.1/congrads/requirements.txt

@@ -1,6 +0,0 @@
-numpy==2.2.2
-pandas==2.2.3
-setuptools==75.6.0
-torch==2.5.0
-torchvision==0.20.0
-tqdm==4.66.5