predicateneuron 0.1.0__tar.gz

predicateneuron-0.1.0/.gitignore

@@ -0,0 +1,6 @@
+__pycache__/
+*.egg-info/
+dist/
+build/
+.venv/
+.pytest_cache/

predicateneuron-0.1.0/.idea/.gitignore

@@ -0,0 +1,8 @@
+# Default ignored files
+/shelf/
+/workspace.xml
+# Editor-based HTTP Client requests
+/httpRequests/
+# Datasource local storage ignored files
+/dataSources/
+/dataSources.local.xml

predicateneuron-0.1.0/.idea/inspectionProfiles/profiles_settings.xml

@@ -0,0 +1,6 @@
+<component name="InspectionProjectProfileManager">
+  <settings>
+    <option name="USE_PROJECT_PROFILE" value="false" />
+    <version value="1.0" />
+  </settings>
+</component>

predicateneuron-0.1.0/.idea/misc.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectRootManager" version="2" project-jdk-name="Python 3.10" project-jdk-type="Python SDK" />
+</project>

predicateneuron-0.1.0/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/predicateneuron.iml" filepath="$PROJECT_DIR$/.idea/predicateneuron.iml" />
+    </modules>
+  </component>
+</project>

predicateneuron-0.1.0/.idea/predicateneuron.iml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="PYTHON_MODULE" version="4">
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$" />
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+  </component>
+</module>

predicateneuron-0.1.0/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>

predicateneuron-0.1.0/.idea/workspace.xml

@@ -0,0 +1,73 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ChangeListManager">
+    <list default="true" id="559a1296-1549-4b57-aea7-e3c5fde5b111" name="Changes" comment="" />
+    <option name="SHOW_DIALOG" value="false" />
+    <option name="HIGHLIGHT_CONFLICTS" value="true" />
+    <option name="HIGHLIGHT_NON_ACTIVE_CHANGELIST" value="false" />
+    <option name="LAST_RESOLUTION" value="IGNORE" />
+  </component>
+  <component name="Git.Settings">
+    <option name="RECENT_GIT_ROOT_PATH" value="$PROJECT_DIR$" />
+  </component>
+  <component name="MarkdownSettingsMigration">
+    <option name="stateVersion" value="1" />
+  </component>
+  <component name="ProjectId" id="3L4p8byrBjmgCn1f0kxoOtLdrTO" />
+  <component name="ProjectViewState">
+    <option name="autoscrollFromSource" value="true" />
+    <option name="hideEmptyMiddlePackages" value="true" />
+    <option name="showLibraryContents" value="true" />
+  </component>
+  <component name="PropertiesComponent">
+    <property name="RunOnceActivity.OpenProjectViewOnStart" value="true" />
+    <property name="RunOnceActivity.ShowReadmeOnStart" value="true" />
+    <property name="WebServerToolWindowFactoryState" value="false" />
+  </component>
+  <component name="SpellCheckerSettings" RuntimeDictionaries="0" Folders="0" CustomDictionaries="0" DefaultDictionary="application-level" UseSingleDictionary="true" transferred="true" />
+  <component name="TaskManager">
+    <task active="true" id="Default" summary="Default task">
+      <changelist id="559a1296-1549-4b57-aea7-e3c5fde5b111" name="Changes" comment="" />
+      <created>1792723035825</created>
+      <option name="number" value="Default" />
+      <option name="presentableId" value="Default" />
+      <updated>1792723035825</updated>
+      <workItem from="1792723037060" duration="6169000" />
+    </task>
+    <task id="LOCAL-00001" summary="-initial commit">
+      <created>1792727916775</created>
+      <option name="number" value="00001" />
+      <option name="presentableId" value="LOCAL-00001" />
+      <option name="project" value="LOCAL" />
+      <updated>1792727916775</updated>
+    </task>
+    <task id="LOCAL-00002" summary="-fix tests">
+      <created>1792728400664</created>
+      <option name="number" value="00002" />
+      <option name="presentableId" value="LOCAL-00002" />
+      <option name="project" value="LOCAL" />
+      <updated>1792728400664</updated>
+    </task>
+    <option name="localTasksCounter" value="3" />
+    <servers />
+  </component>
+  <component name="TypeScriptGeneratedFilesManager">
+    <option name="version" value="3" />
+  </component>
+  <component name="Vcs.Log.Tabs.Properties">
+    <option name="TAB_STATES">
+      <map>
+        <entry key="MAIN">
+          <value>
+            <State />
+          </value>
+        </entry>
+      </map>
+    </option>
+  </component>
+  <component name="VcsManagerConfiguration">
+    <MESSAGE value="-initial commit" />
+    <MESSAGE value="-fix tests" />
+    <option name="LAST_COMMIT_MESSAGE" value="-fix tests" />
+  </component>
+</project>

predicateneuron-0.1.0/CITATION.cff

@@ -0,0 +1,24 @@
+cff-version: 1.2.0
+message: "If you use this software, please cite the paper."
+title: "Predicate Neuron: Differentiable Quantization of Predicate Relations in Gradient-based Learning"
+authors:
+  - family-names: "Konstantoulas"
+    given-names: "Ioannis"
+  - family-names: "Loi"
+    given-names: "Iliana"
+  - family-names: "Sgarbas"
+    given-names: "Kyriakos"
+repository-code: "https://github.com/IoannisKonstantoulas/predicateneuron"
+license: MIT
+preferred-citation:
+  type: article
+  title: "Predicate Neuron: Differentiable Quantization of Predicate Relations in Gradient-based Learning"
+  authors:
+    - family-names: "Konstantoulas"
+      given-names: "Ioannis"
+    - family-names: "Loi"
+      given-names: "Iliana"
+    - family-names: "Sgarbas"
+      given-names: "Kyriakos"
+  year: 2026
+  url: "https://TODO"

predicateneuron-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

predicateneuron-0.1.0/PKG-INFO

@@ -0,0 +1,151 @@
+Metadata-Version: 2.5
+Name: predicateneuron
+Version: 0.1.0
+Summary: Differentiable predicate neuron (intersection / union / symmetric difference) and predicate layers for Keras, TensorFlow and PyTorch
+Project-URL: Homepage, https://github.com/IoannisKonstantoulas/predicateneuron
+Project-URL: Paper, https://TODO
+License: Apache 2.0
+License-File: LICENSE
+Requires-Python: >=3.9
+Requires-Dist: numpy
+Provides-Extra: all
+Requires-Dist: keras>=3.0; extra == 'all'
+Requires-Dist: tensorflow>=2.16; extra == 'all'
+Requires-Dist: torch>=2.0; extra == 'all'
+Provides-Extra: dev
+Requires-Dist: pytest; extra == 'dev'
+Provides-Extra: keras
+Requires-Dist: keras>=3.0; extra == 'keras'
+Provides-Extra: tensorflow
+Requires-Dist: keras>=3.0; extra == 'tensorflow'
+Requires-Dist: tensorflow>=2.16; extra == 'tensorflow'
+Provides-Extra: torch
+Requires-Dist: torch>=2.0; extra == 'torch'
+Description-Content-Type: text/markdown
+
+# predicateneuron
+
+A differentiable **predicate neuron** and ready-made **predicate layers** for Keras, TensorFlow and PyTorch.
+
+The neuron combines two inputs in [0, 1] with a fuzzy-logic operation (intersection, union or symmetric difference). A
+single learnable parameter, `theta`, decides which operation is used, so the network learns which logical relation to
+apply to each pair of features.
+
+> Code accompanying the paper: **TODO: title** ([link](https://TODO)).
+
+## Installation
+
+```bash
+pip install "predicateneuron[keras]"        # Keras 3 (TensorFlow, PyTorch or JAX backend)
+pip install "predicateneuron[tensorflow]"   # TensorFlow >= 2.16
+pip install "predicateneuron[torch]"        # PyTorch
+pip install "predicateneuron[all]"          # everything
+```
+
+Only the framework you need has to be installed. Importing `predicateneuron` itself pulls in none of them.
+
+## Quick start
+
+**Keras / TensorFlow**
+
+```python
+import keras
+from predicateneuron.keras import PredicateLayer  # or: from predicateneuron.tf import ...
+
+model = keras.Sequential([
+    keras.Input((8,)),
+    PredicateLayer(
+        temperature=0.06, theta_initializer=keras.initializers.Constant(0.5),
+        hard_forward=False, hard_backward=False
+    ),
+    keras.layers.Dense(1, activation="sigmoid"),
+])
+```
+
+**PyTorch**
+
+```python
+import torch
+from predicateneuron.torch import PredicateLayer
+
+model = torch.nn.Sequential(
+    PredicateLayer(in_features=8, temperature=0.06, theta_init=0.5,
+                   hard_forward=False, hard_backward=False,
+                   torch.nn.Linear(28, 1),  # 8 inputs -> 8*7/2 = 28 pairs
+                   torch.nn.Sigmoid(),
+                   )
+```
+
+Inputs are expected to lie in [0, 1], for example sigmoid outputs or normalized features.
+
+## The neuron
+
+For inputs `x1`, `x2` and a learnable `theta`:
+
+| `theta`        | operation            | formula              |
+|----------------|----------------------|----------------------|
+| `< 0.25`       | intersection         | `x1·x2`              |
+| `0.25 … 0.75`  | union                | `x1 + x2 − x1·x2`    |
+| `≥ 0.75`       | symmetric difference | `x1 + x2 − 2·x1·x2`  |
+
+The function is also available directly: `from predicateneuron.keras import predicate_neuron` (or `.torch`).
+
+### Forward and backward modes
+
+Two independent switches control how the neuron behaves.
+
+| Flag                      | `True`                                               | `False` (default)                                                   |
+|---------------------------|------------------------------------------------------|---------------------------------------------------------------------|
+| `hard_forward`            | output uses the single operation selected by `theta` | output is a softmax mixture of the three operations (`temperature`) |
+| `hard_backward`           | input gradients from the selected operation only     | input gradients from the exact derivative of the soft mixture       |
+
+The gradient with respect to `theta` always comes from the softmax surrogate, in every mode. All four combinations are
+valid. The defaults are (`hard_forward=False`, `hard_backward=False`)
+
+## Layers
+
+| Layer                       | Pairs                                              | Output size  |
+|-----------------------------|----------------------------------------------------|--------------|
+| `PredicateLayer`            | every unique pair `(i, j)`, `i < j`                | `n(n−1)/2`   |
+| `MinimalPredicateLayer`     | disjoint pairs `(0,1), (2,3), …`; odd last input is passed through | `⌈n/2⌉` |
+| `MinimalJointPredicateLayer`| overlapping circular pairs `(0,1), (1,2), …, (n−1,0)` | `n`       |
+
+Every layer owns one `theta` per pair and accepts inputs of any rank, with the features on the last axis.
+
+## Switching modes
+
+Each layer keeps its own flags, so layers in one model can run in different modes.
+
+```python
+from predicateneuron.keras import set_model_hard_forward, set_model_hard_backward
+
+# a single layer
+layer.set_hard_forward(False)
+layer.set_hard_backward(False)
+
+# every predicate layer in a model (including nested ones)
+set_model_hard_forward(model, False)  # e.g. soft warm-up
+set_model_hard_backward(model, False)
+set_model_hard_forward(model, True)  # switch back to hard gates
+
+# mixed: all soft except one layer
+set_model_hard_forward(model, False)
+model.get_layer("last_predicate").set_hard_forward(True)
+```
+
+The flags are stored as variables (Keras) or buffers (PyTorch), so they can be changed during training without
+rebuilding the model. In Keras they are also part of `get_config`, so saved models restore their mode.
+
+## Notes
+
+- Keras support targets **Keras 3**. TensorFlow 2.15 and earlier ship Keras 2 as `tf.keras`, which is not supported.
+- Both `theta` and the three candidate operations are differentiated separately by design (see *Forward and backward
+  modes*), so soft mode is not plain backpropagation through the mixture unless `hard_backward=False`.
+
+## Citation
+
+If you use this code, please cite the paper (see `CITATION.cff`).
+
+## License
+
+Apache 2.0

predicateneuron-0.1.0/README.md

@@ -0,0 +1,126 @@
+# predicateneuron
+
+A differentiable **predicate neuron** and ready-made **predicate layers** for Keras, TensorFlow and PyTorch.
+
+The neuron combines two inputs in [0, 1] with a fuzzy-logic operation (intersection, union or symmetric difference). A
+single learnable parameter, `theta`, decides which operation is used, so the network learns which logical relation to
+apply to each pair of features.
+
+> Code accompanying the paper: **TODO: title** ([link](https://TODO)).
+
+## Installation
+
+```bash
+pip install "predicateneuron[keras]"        # Keras 3 (TensorFlow, PyTorch or JAX backend)
+pip install "predicateneuron[tensorflow]"   # TensorFlow >= 2.16
+pip install "predicateneuron[torch]"        # PyTorch
+pip install "predicateneuron[all]"          # everything
+```
+
+Only the framework you need has to be installed. Importing `predicateneuron` itself pulls in none of them.
+
+## Quick start
+
+**Keras / TensorFlow**
+
+```python
+import keras
+from predicateneuron.keras import PredicateLayer  # or: from predicateneuron.tf import ...
+
+model = keras.Sequential([
+    keras.Input((8,)),
+    PredicateLayer(
+        temperature=0.06, theta_initializer=keras.initializers.Constant(0.5),
+        hard_forward=False, hard_backward=False
+    ),
+    keras.layers.Dense(1, activation="sigmoid"),
+])
+```
+
+**PyTorch**
+
+```python
+import torch
+from predicateneuron.torch import PredicateLayer
+
+model = torch.nn.Sequential(
+    PredicateLayer(in_features=8, temperature=0.06, theta_init=0.5,
+                   hard_forward=False, hard_backward=False,
+                   torch.nn.Linear(28, 1),  # 8 inputs -> 8*7/2 = 28 pairs
+                   torch.nn.Sigmoid(),
+                   )
+```
+
+Inputs are expected to lie in [0, 1], for example sigmoid outputs or normalized features.
+
+## The neuron
+
+For inputs `x1`, `x2` and a learnable `theta`:
+
+| `theta`        | operation            | formula              |
+|----------------|----------------------|----------------------|
+| `< 0.25`       | intersection         | `x1·x2`              |
+| `0.25 … 0.75`  | union                | `x1 + x2 − x1·x2`    |
+| `≥ 0.75`       | symmetric difference | `x1 + x2 − 2·x1·x2`  |
+
+The function is also available directly: `from predicateneuron.keras import predicate_neuron` (or `.torch`).
+
+### Forward and backward modes
+
+Two independent switches control how the neuron behaves.
+
+| Flag                      | `True`                                               | `False` (default)                                                   |
+|---------------------------|------------------------------------------------------|---------------------------------------------------------------------|
+| `hard_forward`            | output uses the single operation selected by `theta` | output is a softmax mixture of the three operations (`temperature`) |
+| `hard_backward`           | input gradients from the selected operation only     | input gradients from the exact derivative of the soft mixture       |
+
+The gradient with respect to `theta` always comes from the softmax surrogate, in every mode. All four combinations are
+valid. The defaults are (`hard_forward=False`, `hard_backward=False`)
+
+## Layers
+
+| Layer                       | Pairs                                              | Output size  |
+|-----------------------------|----------------------------------------------------|--------------|
+| `PredicateLayer`            | every unique pair `(i, j)`, `i < j`                | `n(n−1)/2`   |
+| `MinimalPredicateLayer`     | disjoint pairs `(0,1), (2,3), …`; odd last input is passed through | `⌈n/2⌉` |
+| `MinimalJointPredicateLayer`| overlapping circular pairs `(0,1), (1,2), …, (n−1,0)` | `n`       |
+
+Every layer owns one `theta` per pair and accepts inputs of any rank, with the features on the last axis.
+
+## Switching modes
+
+Each layer keeps its own flags, so layers in one model can run in different modes.
+
+```python
+from predicateneuron.keras import set_model_hard_forward, set_model_hard_backward
+
+# a single layer
+layer.set_hard_forward(False)
+layer.set_hard_backward(False)
+
+# every predicate layer in a model (including nested ones)
+set_model_hard_forward(model, False)  # e.g. soft warm-up
+set_model_hard_backward(model, False)
+set_model_hard_forward(model, True)  # switch back to hard gates
+
+# mixed: all soft except one layer
+set_model_hard_forward(model, False)
+model.get_layer("last_predicate").set_hard_forward(True)
+```
+
+The flags are stored as variables (Keras) or buffers (PyTorch), so they can be changed during training without
+rebuilding the model. In Keras they are also part of `get_config`, so saved models restore their mode.
+
+## Notes
+
+- Keras support targets **Keras 3**. TensorFlow 2.15 and earlier ship Keras 2 as `tf.keras`, which is not supported.
+- Both `theta` and the three candidate operations are differentiated separately by design (see *Forward and backward
+  modes*), so soft mode is not plain backpropagation through the mixture unless `hard_backward=False`.
+
+## Citation
+
+If you use this code, please cite the paper (see `CITATION.cff`).
+
+## License
+
+Apache 2.0

predicateneuron-0.1.0/pyproject.toml

@@ -0,0 +1,29 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "predicateneuron"
+version = "0.1.0"
+description = "Differentiable predicate neuron (intersection / union / symmetric difference) and predicate layers for Keras, TensorFlow and PyTorch"
+readme = "README.md"
+requires-python = ">=3.9"
+license = { text = "Apache 2.0" }
+dependencies = ["numpy"]
+
+[project.optional-dependencies]
+keras      = ["keras>=3.0"]
+tensorflow = ["tensorflow>=2.16", "keras>=3.0"]
+torch      = ["torch>=2.0"]
+all        = ["keras>=3.0", "tensorflow>=2.16", "torch>=2.0"]
+dev        = ["pytest"]
+
+[project.urls]
+Homepage = "https://github.com/IoannisKonstantoulas/predicateneuron"
+Paper = "https://TODO"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/predicateneuron"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]