congrads 1.0.5__tar.gz → 1.0.7__tar.gz

{congrads-1.0.5 → congrads-1.0.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: congrads
-Version: 1.0.5
+Version: 1.0.7
 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
@@ -203,6 +203,20 @@ We welcome contributions to Congrads! Whether you want to report issues, suggest
 
 Congrads is licensed under the [The 3-Clause BSD License](LICENSE). We encourage companies that are interested in a collaboration for a specific topic to contact the authors for more information or to set up joint research projects.
 
+## Contacts
+
+Feel free to contact any of the below contact persons for more information or details about the project. Companies interested in a collaboration, or to set up joint research projects are also encouraged to get in touch with us.
+
+- Peter Karsmakers [ [email](mailto:peter.karsmakers@kuleuven.be) | [website](https://www.kuleuven.be/wieiswie/en/person/00047893) ]
+- Quinten Van Baelen [ [email](mailto:quinten.vanbaelen@kuleuven.be) | [website](https://www.kuleuven.be/wieiswie/en/person/00125540) ]
+
+## Contributors
+
+Below you find a list of people who contributed in making the toolbox. Feel free to contact them for any repository- or code-specific questions, suggestions or remarks.
+
+- Wout Rombouts [ [email](mailto:wout.rombouts@kuleuven.be) | [github profile](https://github.com/rombie18) ]
+- Quinten Van Baelen [ [email](mailto:quinten.vanbaelen@kuleuven.be) | [github profile](https://github.com/quinten-vb) ]
+
 ---
 
 Elevate your neural networks with Congrads! 🚀

{congrads-1.0.5 → congrads-1.0.7}/README.md

@@ -161,6 +161,20 @@ We welcome contributions to Congrads! Whether you want to report issues, suggest
 
 Congrads is licensed under the [The 3-Clause BSD License](LICENSE). We encourage companies that are interested in a collaboration for a specific topic to contact the authors for more information or to set up joint research projects.
 
+## Contacts
+
+Feel free to contact any of the below contact persons for more information or details about the project. Companies interested in a collaboration, or to set up joint research projects are also encouraged to get in touch with us.
+
+- Peter Karsmakers [ [email](mailto:peter.karsmakers@kuleuven.be) | [website](https://www.kuleuven.be/wieiswie/en/person/00047893) ]
+- Quinten Van Baelen [ [email](mailto:quinten.vanbaelen@kuleuven.be) | [website](https://www.kuleuven.be/wieiswie/en/person/00125540) ]
+
+## Contributors
+
+Below you find a list of people who contributed in making the toolbox. Feel free to contact them for any repository- or code-specific questions, suggestions or remarks.
+
+- Wout Rombouts [ [email](mailto:wout.rombouts@kuleuven.be) | [github profile](https://github.com/rombie18) ]
+- Quinten Van Baelen [ [email](mailto:quinten.vanbaelen@kuleuven.be) | [github profile](https://github.com/quinten-vb) ]
+
 ---
 
 Elevate your neural networks with Congrads! 🚀

{congrads-1.0.5 → congrads-1.0.7}/congrads/constraints.py

@@ -94,8 +94,7 @@ class Constraint(ABC):
             defined in the `descriptor`.
 
     Note:
-        - If `rescale_factor <= 1`, a warning is issued, and the value is
-          adjusted to a positive value greater than 1.
+        - If `rescale_factor <= 1`, a warning is issued.
         - If `name` is not provided, a name is auto-generated,
           and a warning is logged.
 
@@ -120,7 +119,7 @@ class Constraint(ABC):
 
         # Type checking
         validate_iterable("neurons", neurons, str)
-        validate_type("name", name, (str, type(None)))
+        validate_type("name", name, str, allow_none=True)
         validate_type("monitor_only", monitor_only, bool)
         validate_type("rescale_factor", rescale_factor, Number)
 
@@ -132,12 +131,13 @@ class Constraint(ABC):
         # Perform checks
         if rescale_factor <= 1:
             warnings.warn(
-                "Rescale factor for constraint %s is <= 1. The network \
-                    will favor general loss over the constraint-adjusted loss. \
-                    Is this intended behavior? Normally, the loss should \
-                    always be larger than 1.",
-                name,
+                f"Rescale factor for constraint {name} is <= 1. The network "
+                "will favor general loss over the constraint-adjusted loss. "
+                "Is this intended behavior? Normally, the rescale factor "
+                "should always be larger than 1.",
             )
+        else:
+            self.rescale_factor = rescale_factor
 
         # If no constraint_name is set, generate one based
         # on the class name and a random suffix
@@ -149,31 +149,18 @@ class Constraint(ABC):
             )
             self.name = f"{self.__class__.__name__}_{random_suffix}"
             warnings.warn(
-                "Name for constraint is not set. Using %s.", self.name
-            )
-
-        # If rescale factor is not larger than 1, warn user and adjust
-        if rescale_factor <= 1:
-            self.rescale_factor = abs(rescale_factor) + 1.5
-            warnings.warn(
-                "Rescale factor for constraint %s is < 1, adjusted value \
-                    %s to %s.",
-                name,
-                rescale_factor,
-                self.rescale_factor,
+                f"Name for constraint is not set. Using {self.name}.",
             )
-        else:
-            self.rescale_factor = rescale_factor
 
         # Infer layers from descriptor and neurons
         self.layers = set()
         for neuron in self.neurons:
             if neuron not in self.descriptor.neuron_to_layer.keys():
                 raise ValueError(
-                    f'The neuron name {neuron} used with constraint \
-                        {self.name} is not defined in the descriptor. Please \
-                        add it to the correct layer using \
-                        descriptor.add("layer", ...).'
+                    f"The neuron name {neuron} used with constraint "
+                    f"{self.name} is not defined in the descriptor. Please "
+                    "add it to the correct layer using "
+                    "descriptor.add('layer', ...)."
                 )
 
             self.layers.add(self.descriptor.neuron_to_layer[neuron])
@@ -675,13 +662,13 @@ class SumConstraint(Constraint):
         # weight list dimensions, raise error
         if weights_left and (len(neuron_names_left) != len(weights_left)):
             raise ValueError(
-                "The dimensions of neuron_names_left don't match with the \
-                    dimensions of weights_left."
+                "The dimensions of neuron_names_left don't match with the "
+                "dimensions of weights_left."
             )
         if weights_right and (len(neuron_names_right) != len(weights_right)):
             raise ValueError(
-                "The dimensions of neuron_names_right don't match with the \
-                    dimensions of weights_right."
+                "The dimensions of neuron_names_right don't match with the "
+                "dimensions of weights_right."
             )
 
         # If weights are provided for summation, transform them to Tensors

{congrads-1.0.5 → congrads-1.0.7}/congrads.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.2
 Name: congrads
-Version: 1.0.5
+Version: 1.0.7
 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
@@ -203,6 +203,20 @@ We welcome contributions to Congrads! Whether you want to report issues, suggest
 
 Congrads is licensed under the [The 3-Clause BSD License](LICENSE). We encourage companies that are interested in a collaboration for a specific topic to contact the authors for more information or to set up joint research projects.
 
+## Contacts
+
+Feel free to contact any of the below contact persons for more information or details about the project. Companies interested in a collaboration, or to set up joint research projects are also encouraged to get in touch with us.
+
+- Peter Karsmakers [ [email](mailto:peter.karsmakers@kuleuven.be) | [website](https://www.kuleuven.be/wieiswie/en/person/00047893) ]
+- Quinten Van Baelen [ [email](mailto:quinten.vanbaelen@kuleuven.be) | [website](https://www.kuleuven.be/wieiswie/en/person/00125540) ]
+
+## Contributors
+
+Below you find a list of people who contributed in making the toolbox. Feel free to contact them for any repository- or code-specific questions, suggestions or remarks.
+
+- Wout Rombouts [ [email](mailto:wout.rombouts@kuleuven.be) | [github profile](https://github.com/rombie18) ]
+- Quinten Van Baelen [ [email](mailto:quinten.vanbaelen@kuleuven.be) | [github profile](https://github.com/quinten-vb) ]
+
 ---
 
 Elevate your neural networks with Congrads! 🚀

{congrads-1.0.5 → congrads-1.0.7}/docs/index.rst

@@ -75,6 +75,35 @@ If you make use of this package or it's concepts in your research, please consid
 __ https://www.sciencedirect.com/science/article/abs/pii/S0925231223007592
 __ https://raw.githubusercontent.com/ML-KULeuven/congrads/main/docs/_static/VanBaelen2023.bib
 
+
+Contacts
+--------
+
+Feel free to contact any of the below contact persons for more information or details about the project. Companies interested in a collaboration, or to set up joint research projects are also encouraged to get in touch with us.
+
+- Peter Karsmakers [`email`__ | `website`__]
+- Quinten Van Baelen [`email`__ | `website`__]
+
+__ mailto:peter.karsmakers@kuleuven.be
+__ https://www.kuleuven.be/wieiswie/en/person/00047893
+__ mailto:quinten.vanbaelen@kuleuven.be
+__ https://www.kuleuven.be/wieiswie/en/person/00125540
+
+Contributors
+------------
+
+Below you find a list of people who contributed in making the toolbox. Feel free to contact them for any repository- or code-specific questions, suggestions or remarks.
+
+- Wout Rombouts [`email`__ | `github profile`__]
+- Quinten Van Baelen [`email`__ | `github profile`__]
+
+__ mailto:wout.rombouts@kuleuven.be
+__ https://github.com/rombie18
+__ mailto:quinten.vanbaelen@kuleuven.be
+__ https://github.com/quinten-vb
+
+---
+
 Contents
 --------