predicateneuron 0.1.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of predicateneuron might be problematic. Click here for more details.

@@ -0,0 +1,8 @@
1
+ """predicateneuron: framework-specific code lives in subpackages, so importing
2
+ `predicateneuron` never forces Keras, TensorFlow or PyTorch to be installed.
3
+
4
+ from predicateneuron.keras import PredicateLayer, MinimalPredicateLayer, MinimalJointPredicateLayer # Keras 3
5
+ from predicateneuron.tf import PredicateLayer, MinimalPredicateLayer, MinimalJointPredicateLayer # tf.keras users
6
+ from predicateneuron.torch import PredicateLayer, MinimalPredicateLayer, MinimalJointPredicateLayer # PyTorch
7
+ """
8
+ __version__ = "0.1.0"
@@ -0,0 +1,18 @@
1
+ try:
2
+ import keras
3
+ except ImportError as e:
4
+ raise ImportError(
5
+ "predicateneuron.keras requires Keras 3. Install with: pip install 'predicateneuron[keras]'") from e
6
+
7
+ from .functional import predicate_neuron
8
+ from .layers import PredicateLayer, MinimalPredicateLayer, MinimalJointPredicateLayer, set_model_hard_forward, \
9
+ set_model_hard_backward
10
+
11
+ __all__ = [
12
+ "predicate_neuron",
13
+ "PredicateLayer",
14
+ "MinimalPredicateLayer",
15
+ "MinimalJointPredicateLayer",
16
+ "set_model_hard_forward",
17
+ "set_model_hard_backward"
18
+ ]
@@ -0,0 +1,39 @@
1
+ from keras import ops
2
+
3
+
4
+ def predicate_neuron(x1, x2, theta, temperature=0.06, hard_forward=True, hard_backward=True):
5
+ """Differentiable predicate neuron, element-wise over broadcastable x1, x2, theta.
6
+
7
+ Forward : theta selects intersection (<0.25), union (<0.75) or symmetric
8
+ difference (otherwise) when `hard_forward`, else a softmax mixture
9
+ of the three over positions [0, 0.5, 1].
10
+ Backward:
11
+ d/dtheta always from the soft (softmax) surrogate.
12
+ d/dx1,x2 hard_backward=True : derivative of the hard-selected operation
13
+ (behaviour of the original paper code).
14
+ hard_backward=False: exact derivative of the soft mixture,
15
+ sum_k p_k * d(op_k)/dx.
16
+ Implemented with stop_gradient, so it works on every Keras backend.
17
+ """
18
+ sg = ops.stop_gradient
19
+
20
+ intersection = x1 * x2
21
+ union = x1 + x2 - intersection
22
+ symmetric_diff = x1 + x2 - 2.0 * intersection
23
+
24
+ # hard path (differentiable w.r.t. x only; the gate itself is a constant)
25
+ t = sg(theta)
26
+ gate = ops.where(t < 0.25, 0, ops.where(t < 0.75, 1, 2))
27
+ y_hard = ops.where(gate == 0, intersection, ops.where(gate == 1, union, symmetric_diff))
28
+
29
+ # soft path
30
+ positions = ops.cast(ops.convert_to_tensor([0.0, 0.5, 1.0]), x1.dtype)
31
+ values = ops.stack([intersection, union, symmetric_diff], axis=-1)
32
+ logits = -ops.square(ops.expand_dims(theta, -1) - positions) / temperature
33
+ p = ops.softmax(logits, axis=-1)
34
+ y_soft_theta = ops.sum(sg(values) * p, axis=-1) # gradient only to theta
35
+ y_soft_x = ops.sum(values * sg(p), axis=-1) # gradient only to x
36
+
37
+ forward = ops.where(hard_forward, y_hard, y_soft_theta)
38
+ y_x = ops.where(hard_backward, y_hard, y_soft_x) # what x "sees" in backward
39
+ return sg(forward) + (y_soft_theta - sg(y_soft_theta)) + (y_x - sg(y_x))
@@ -0,0 +1,151 @@
1
+ import keras
2
+ import numpy as np
3
+ from keras import ops
4
+
5
+ from .functional import predicate_neuron
6
+
7
+
8
+ def set_model_hard_forward(model, value):
9
+ """Switch predicate layer between hard/soft forward pass."""
10
+ for layer in getattr(model, "layers", []):
11
+ if isinstance(layer, _BasePredicateLayer):
12
+ layer.set_hard_forward(value)
13
+ set_model_hard_forward(layer, value)
14
+
15
+
16
+ def set_model_hard_backward(model, value):
17
+ """Switch predicate layer between operation-selection (True) and weighted-aggregate (False) of input gradients."""
18
+ for layer in getattr(model, "layers", []):
19
+ if isinstance(layer, _BasePredicateLayer):
20
+ layer.set_hard_backward(value)
21
+ set_model_hard_backward(layer, value)
22
+
23
+
24
+ class _BasePredicateLayer(keras.layers.Layer):
25
+ def __init__(
26
+ self, temperature=0.06, theta_initializer=keras.initializers.Constant(0.5),
27
+ hard_forward=False, hard_backward=False, **kwargs
28
+ ):
29
+ super().__init__(**kwargs)
30
+ self.temperature = temperature
31
+ self._hard_forward = bool(hard_forward)
32
+ self._hard_backward = bool(hard_backward)
33
+ self.theta_initializer = keras.initializers.get(theta_initializer)
34
+
35
+ def _make_weights(self, n_pairs):
36
+ self.theta = self.add_weight(
37
+ name="theta", shape=(n_pairs,),
38
+ initializer=self.theta_initializer, trainable=True)
39
+ self.hard_forward = self.add_weight(
40
+ name="hard_forward", shape=(),
41
+ initializer=keras.initializers.Constant(float(self._hard_forward)),
42
+ trainable=False)
43
+ self.hard_backward = self.add_weight(
44
+ name="hard_backward", shape=(),
45
+ initializer=keras.initializers.Constant(float(self._hard_backward)),
46
+ trainable=False)
47
+
48
+ def set_hard_forward(self, value):
49
+ self._hard_forward = bool(value)
50
+ if getattr(self, "hard_forward", None) is not None:
51
+ self.hard_forward.assign(float(self._hard_forward))
52
+
53
+ def set_hard_backward(self, value):
54
+ self._hard_backward = bool(value)
55
+ if getattr(self, "hard_backward", None) is not None:
56
+ self.hard_backward.assign(float(self._hard_backward))
57
+
58
+ def _hard_fw(self):
59
+ return ops.greater(self.hard_forward, 0.5)
60
+
61
+ def _hard_bw(self):
62
+ return ops.greater(self.hard_backward, 0.5)
63
+
64
+ def get_config(self):
65
+ config = super().get_config()
66
+ config.update({
67
+ "temperature": self.temperature,
68
+ "hard_forward": self._hard_forward,
69
+ "hard_backward": self._hard_backward,
70
+ "theta_initializer": keras.initializers.serialize(self.theta_initializer),
71
+ })
72
+ return config
73
+
74
+
75
+ @keras.saving.register_keras_serializable(package="predicateneuron")
76
+ class PredicateLayer(_BasePredicateLayer):
77
+ """Pairwise fully connected: One predicate neuron for every unique pair (i<j) of inputs:
78
+ (..., n) -> (...,n(n-1)/2)."""
79
+
80
+ def build(self, input_shape):
81
+ n = input_shape[-1]
82
+ if n is None:
83
+ raise ValueError("The last input dimension must be known.")
84
+ n = int(n)
85
+ if n < 2:
86
+ raise ValueError("PredicateLayer needs at least 2 input features.")
87
+ self.n_inputs = n
88
+ i, j = np.triu_indices(n, k=1)
89
+ self._idx_i, self._idx_j = i, j
90
+ self.n_pairs = len(i)
91
+ self._make_weights(self.n_pairs)
92
+
93
+ def call(self, x):
94
+ x1 = ops.take(x, self._idx_i, axis=-1)
95
+ x2 = ops.take(x, self._idx_j, axis=-1)
96
+ return predicate_neuron(x1, x2, self.theta, self.temperature,
97
+ self._hard_fw(), self._hard_bw())
98
+
99
+ def compute_output_shape(self, input_shape):
100
+ n = int(input_shape[-1])
101
+ return tuple(input_shape[:-1]) + (n * (n - 1) // 2,)
102
+
103
+
104
+ @keras.saving.register_keras_serializable(package="predicateneuron")
105
+ class MinimalPredicateLayer(_BasePredicateLayer):
106
+ """Neurons on disjoint consecutive pairs (0,1),(2,3),...,(n-1,n). Possible leftover odd input passes through."""
107
+
108
+ def build(self, input_shape):
109
+ n = input_shape[-1]
110
+ if n is None:
111
+ raise ValueError("The last input dimension must be known.")
112
+ self.n_inputs = int(n)
113
+ self.n_pairs = self.n_inputs // 2
114
+ self._make_weights(self.n_pairs)
115
+
116
+ def call(self, x):
117
+ if self.n_pairs == 0:
118
+ return x
119
+ m = 2 * self.n_pairs
120
+ y = predicate_neuron(
121
+ x[..., 0:m:2], x[..., 1:m:2], self.theta, self.temperature, self._hard_fw(), self._hard_bw()
122
+ )
123
+ if self.n_inputs % 2 == 1:
124
+ y = ops.concatenate([y, x[..., -1:]], axis=-1)
125
+ return y
126
+
127
+ def compute_output_shape(self, input_shape):
128
+ n = int(input_shape[-1])
129
+ return tuple(input_shape[:-1]) + (n // 2 + n % 2,)
130
+
131
+
132
+ @keras.saving.register_keras_serializable(package="predicateneuron")
133
+ class MinimalJointPredicateLayer(_BasePredicateLayer):
134
+ """Neurons on joint circular pairs (0,1),(1,2),...,(n-2,n-1),(n-1,0)."""
135
+
136
+ def build(self, input_shape):
137
+ n = input_shape[-1]
138
+ if n is None:
139
+ raise ValueError("The last input dimension must be known.")
140
+ if n < 2:
141
+ raise ValueError("MinimalJointPredicateLayer needs at least 2 input features.")
142
+ self.n_inputs = int(n)
143
+ self.n_pairs = int(n)
144
+ self._make_weights(self.n_pairs)
145
+
146
+ def call(self, x):
147
+ x_next = ops.concatenate([x[..., 1:], x[..., :1]], axis=-1)
148
+ return predicate_neuron(x, x_next, self.theta, self.temperature, self._hard_fw(), self._hard_bw())
149
+
150
+ def compute_output_shape(self, input_shape):
151
+ return tuple(input_shape[:-1]) + (int(input_shape[-1]),)
predicateneuron/tf.py ADDED
@@ -0,0 +1,15 @@
1
+ """TensorFlow entry point: the Keras 3 layers are native tf.keras layers when the
2
+ Keras backend is TensorFlow (the default; TF >= 2.16). Make sure KERAS_BACKEND is
3
+ unset or 'tensorflow' if you pass raw tf tensors to `predicate_neuron`."""
4
+ from .keras import (
5
+ predicate_neuron, PredicateLayer, MinimalPredicateLayer, MinimalJointPredicateLayer,
6
+ set_model_hard_forward, set_model_hard_backward)
7
+
8
+ __all__ = [
9
+ "predicate_neuron",
10
+ "PredicateLayer",
11
+ "MinimalPredicateLayer",
12
+ "MinimalJointPredicateLayer",
13
+ "set_model_hard_forward",
14
+ "set_model_hard_backward"
15
+ ]
@@ -0,0 +1,18 @@
1
+ try:
2
+ import torch
3
+ except ImportError as e:
4
+ raise ImportError(
5
+ "predicateneuron.torch requires PyTorch. Install with: pip install 'predicateneuron[torch]'") from e
6
+
7
+ from .functional import predicate_neuron
8
+ from .layers import PredicateLayer, MinimalPredicateLayer, MinimalJointPredicateLayer, set_model_hard_forward, \
9
+ set_model_hard_backward
10
+
11
+ __all__ = [
12
+ "predicate_neuron",
13
+ "PredicateLayer",
14
+ "MinimalPredicateLayer",
15
+ "MinimalJointPredicateLayer",
16
+ "set_model_hard_forward",
17
+ "set_model_hard_backward"
18
+ ]
@@ -0,0 +1,40 @@
1
+ import torch
2
+
3
+
4
+ def predicate_neuron(x1, x2, theta, temperature=0.06, hard_forward=True, hard_backward=True):
5
+ """Differentiable predicate neuron, element-wise over broadcastable x1, x2, theta.
6
+
7
+ Forward : theta selects intersection (<0.25), union (<0.75) or symmetric
8
+ difference (otherwise) when `hard_forward`, else a softmax mixture
9
+ of the three over positions [0, 0.5, 1].
10
+ Backward:
11
+ d/dtheta always from the soft (softmax) surrogate.
12
+ d/dx1,x2 hard_backward=True : derivative of the hard-selected operation
13
+ (behaviour of the original paper code).
14
+ hard_backward=False: exact derivative of the soft mixture,
15
+ sum_k p_k * d(op_k)/dx.
16
+ Works with autograd, torch.compile, double backward."""
17
+ intersection = x1 * x2
18
+ union = x1 + x2 - intersection
19
+ symmetric_diff = x1 + x2 - 2.0 * intersection
20
+
21
+ t = theta.detach()
22
+ gate = (t >= 0.25).long() + (t >= 0.75).long() # 0,1,2 as in the original
23
+ y_hard = torch.where(gate == 0, intersection, torch.where(gate == 1, union, symmetric_diff))
24
+
25
+ positions = torch.tensor([0.0, 0.5, 1.0], dtype=x1.dtype, device=x1.device)
26
+ values = torch.stack([intersection, union, symmetric_diff], dim=-1)
27
+ logits = -torch.square(theta.unsqueeze(-1) - positions) / temperature
28
+ p = torch.softmax(logits, dim=-1)
29
+ y_soft_theta = (values.detach() * p).sum(dim=-1) # gradient only to theta
30
+ y_soft_x = (values * p.detach()).sum(dim=-1) # gradient only to x
31
+
32
+ hf = torch.as_tensor(hard_forward, dtype=torch.bool, device=x1.device)
33
+ hb = torch.as_tensor(hard_backward, dtype=torch.bool, device=x1.device)
34
+ forward = torch.where(hf, y_hard, y_soft_theta)
35
+ y_x = torch.where(hb, y_hard, y_soft_x)
36
+ return (
37
+ forward.detach()
38
+ + (y_soft_theta - y_soft_theta.detach())
39
+ + (y_x - y_x.detach())
40
+ )
@@ -0,0 +1,127 @@
1
+ import torch
2
+ from torch import nn
3
+
4
+ from .functional import predicate_neuron
5
+
6
+
7
+ def set_model_hard_forward(model, value):
8
+ """Switch predicate layer between hard/soft forward pass."""
9
+ for m in model.modules():
10
+ if isinstance(m, (PredicateLayer, MinimalPredicateLayer, MinimalJointPredicateLayer)):
11
+ m.set_hard_forward(value)
12
+
13
+
14
+ def set_model_hard_backward(model, value):
15
+ """Switch predicate layer between operation-selection (True) and weighted-aggregate (False) of input gradients."""
16
+ for m in model.modules():
17
+ if isinstance(m, (PredicateLayer, MinimalPredicateLayer, MinimalJointPredicateLayer)):
18
+ m.set_hard_backward(value)
19
+
20
+
21
+ class PredicateLayer(nn.Module):
22
+ """Pairwise fully connected: One predicate neuron for every unique pair (i<j) of inputs:
23
+ (..., n) -> (...,n(n-1)/2)."""
24
+
25
+ def __init__(self, in_features, temperature=0.06, theta_init=0.5, hard_forward=False, hard_backward=False):
26
+ super().__init__()
27
+ if in_features < 2:
28
+ raise ValueError("PredicateLayer needs at least 2 input features.")
29
+ self.in_features = in_features
30
+ self.temperature = temperature
31
+ self.theta_init = theta_init
32
+ i, j = torch.triu_indices(in_features, in_features, offset=1)
33
+ self.register_buffer("idx_i", i, persistent=False)
34
+ self.register_buffer("idx_j", j, persistent=False)
35
+ self.n_pairs = i.numel()
36
+ self.theta = nn.Parameter(torch.empty(self.n_pairs))
37
+ self.register_buffer("hard_forward", torch.tensor(bool(hard_forward)))
38
+ self.register_buffer("hard_backward", torch.tensor(bool(hard_backward)))
39
+ self.reset_parameters()
40
+
41
+ def reset_parameters(self):
42
+ nn.init.constant_(self.theta, self.theta_init)
43
+
44
+ def set_hard_forward(self, value):
45
+ self.hard_forward.fill_(bool(value))
46
+
47
+ def set_hard_backward(self, value):
48
+ self.hard_backward.fill_(bool(value))
49
+
50
+ def forward(self, x):
51
+ return predicate_neuron(
52
+ x[..., self.idx_i], x[..., self.idx_j], self.theta, self.temperature, self.hard_forward, self.hard_backward
53
+ )
54
+
55
+ def extra_repr(self):
56
+ return (f"in_features={self.in_features}, n_pairs={self.n_pairs}, "
57
+ f"temperature={self.temperature}, hard_forward={bool(self.hard_forward)}, "
58
+ f"hard_backward={bool(self.hard_backward)}")
59
+
60
+
61
+ class MinimalPredicateLayer(nn.Module):
62
+ """Neurons on disjoint consecutive pairs (0,1),(2,3),...,(n-1,n). Possible leftover odd input passes through."""
63
+
64
+ def __init__(self, in_features, temperature=0.06, theta_init=0.5, hard_forward=False, hard_backward=False):
65
+ super().__init__()
66
+ self.in_features = in_features
67
+ self.temperature = temperature
68
+ self.theta_init = theta_init
69
+ self.n_pairs = in_features // 2
70
+ self.theta = nn.Parameter(torch.empty(self.n_pairs))
71
+ self.register_buffer("hard_forward", torch.tensor(bool(hard_forward)))
72
+ self.register_buffer("hard_backward", torch.tensor(bool(hard_backward)))
73
+ self.reset_parameters()
74
+
75
+ def reset_parameters(self):
76
+ nn.init.constant_(self.theta, self.theta_init)
77
+
78
+ def set_hard_forward(self, value):
79
+ self.hard_forward.fill_(bool(value))
80
+
81
+ def set_hard_backward(self, value):
82
+ self.hard_backward.fill_(bool(value))
83
+
84
+ def forward(self, x):
85
+ if self.n_pairs == 0:
86
+ return x
87
+ m = 2 * self.n_pairs
88
+ y = predicate_neuron(
89
+ x[..., 0:m:2], x[..., 1:m:2], self.theta, self.temperature, self.hard_forward, self.hard_backward
90
+ )
91
+ if self.in_features % 2 == 1:
92
+ y = torch.cat([y, x[..., -1:]], dim=-1)
93
+ return y
94
+
95
+ def extra_repr(self):
96
+ return (f"in_features={self.in_features}, n_pairs={self.n_pairs}, "
97
+ f"temperature={self.temperature}, hard_forward={bool(self.hard_forward)}, "
98
+ f"hard_backward={bool(self.hard_backward)}")
99
+
100
+ class MinimalJointPredicateLayer(nn.Module):
101
+ """Neurons on joint circular pairs (0,1),(1,2),...,(n-2,n-1),(n-1,0)."""
102
+
103
+ def __init__(self, in_features, temperature=0.1, theta_init=0.5, hard_forward=False, hard_backward=False):
104
+ super().__init__()
105
+ if in_features < 2:
106
+ raise ValueError("MinimalJointPredicateLayer needs at least 2 input features.")
107
+ self.in_features = in_features
108
+ self.temperature = temperature
109
+ self.theta_init = theta_init
110
+ self.n_pairs = in_features
111
+ self.theta = nn.Parameter(torch.empty(self.n_pairs))
112
+ self.register_buffer("hard_forward", torch.tensor(bool(hard_forward)))
113
+ self.register_buffer("hard_backward", torch.tensor(bool(hard_backward)))
114
+ self.reset_parameters()
115
+
116
+ def reset_parameters(self):
117
+ nn.init.constant_(self.theta, self.theta_init)
118
+
119
+ def set_hard_forward(self, value):
120
+ self.hard_forward.fill_(bool(value))
121
+
122
+ def set_hard_backward(self, value):
123
+ self.hard_backward.fill_(bool(value))
124
+
125
+ def forward(self, x):
126
+ x_next = torch.cat([x[..., 1:], x[..., :1]], dim=-1)
127
+ return predicate_neuron(x, x_next, self.theta, self.temperature, self.hard_forward, self.hard_backward)
@@ -0,0 +1,151 @@
1
+ Metadata-Version: 2.5
2
+ Name: predicateneuron
3
+ Version: 0.1.0
4
+ Summary: Differentiable predicate neuron (intersection / union / symmetric difference) and predicate layers for Keras, TensorFlow and PyTorch
5
+ Project-URL: Homepage, https://github.com/IoannisKonstantoulas/predicateneuron
6
+ Project-URL: Paper, https://TODO
7
+ License: Apache 2.0
8
+ License-File: LICENSE
9
+ Requires-Python: >=3.9
10
+ Requires-Dist: numpy
11
+ Provides-Extra: all
12
+ Requires-Dist: keras>=3.0; extra == 'all'
13
+ Requires-Dist: tensorflow>=2.16; extra == 'all'
14
+ Requires-Dist: torch>=2.0; extra == 'all'
15
+ Provides-Extra: dev
16
+ Requires-Dist: pytest; extra == 'dev'
17
+ Provides-Extra: keras
18
+ Requires-Dist: keras>=3.0; extra == 'keras'
19
+ Provides-Extra: tensorflow
20
+ Requires-Dist: keras>=3.0; extra == 'tensorflow'
21
+ Requires-Dist: tensorflow>=2.16; extra == 'tensorflow'
22
+ Provides-Extra: torch
23
+ Requires-Dist: torch>=2.0; extra == 'torch'
24
+ Description-Content-Type: text/markdown
25
+
26
+ # predicateneuron
27
+
28
+ A differentiable **predicate neuron** and ready-made **predicate layers** for Keras, TensorFlow and PyTorch.
29
+
30
+ The neuron combines two inputs in [0, 1] with a fuzzy-logic operation (intersection, union or symmetric difference). A
31
+ single learnable parameter, `theta`, decides which operation is used, so the network learns which logical relation to
32
+ apply to each pair of features.
33
+
34
+ > Code accompanying the paper: **TODO: title** ([link](https://TODO)).
35
+
36
+ ## Installation
37
+
38
+ ```bash
39
+ pip install "predicateneuron[keras]" # Keras 3 (TensorFlow, PyTorch or JAX backend)
40
+ pip install "predicateneuron[tensorflow]" # TensorFlow >= 2.16
41
+ pip install "predicateneuron[torch]" # PyTorch
42
+ pip install "predicateneuron[all]" # everything
43
+ ```
44
+
45
+ Only the framework you need has to be installed. Importing `predicateneuron` itself pulls in none of them.
46
+
47
+ ## Quick start
48
+
49
+ **Keras / TensorFlow**
50
+
51
+ ```python
52
+ import keras
53
+ from predicateneuron.keras import PredicateLayer # or: from predicateneuron.tf import ...
54
+
55
+ model = keras.Sequential([
56
+ keras.Input((8,)),
57
+ PredicateLayer(
58
+ temperature=0.06, theta_initializer=keras.initializers.Constant(0.5),
59
+ hard_forward=False, hard_backward=False
60
+ ),
61
+ keras.layers.Dense(1, activation="sigmoid"),
62
+ ])
63
+ ```
64
+
65
+ **PyTorch**
66
+
67
+ ```python
68
+ import torch
69
+ from predicateneuron.torch import PredicateLayer
70
+
71
+ model = torch.nn.Sequential(
72
+ PredicateLayer(in_features=8, temperature=0.06, theta_init=0.5,
73
+ hard_forward=False, hard_backward=False,
74
+ torch.nn.Linear(28, 1), # 8 inputs -> 8*7/2 = 28 pairs
75
+ torch.nn.Sigmoid(),
76
+ )
77
+ ```
78
+
79
+ Inputs are expected to lie in [0, 1], for example sigmoid outputs or normalized features.
80
+
81
+ ## The neuron
82
+
83
+ For inputs `x1`, `x2` and a learnable `theta`:
84
+
85
+ | `theta` | operation | formula |
86
+ |----------------|----------------------|----------------------|
87
+ | `< 0.25` | intersection | `x1·x2` |
88
+ | `0.25 … 0.75` | union | `x1 + x2 − x1·x2` |
89
+ | `≥ 0.75` | symmetric difference | `x1 + x2 − 2·x1·x2` |
90
+
91
+ The function is also available directly: `from predicateneuron.keras import predicate_neuron` (or `.torch`).
92
+
93
+ ### Forward and backward modes
94
+
95
+ Two independent switches control how the neuron behaves.
96
+
97
+ | Flag | `True` | `False` (default) |
98
+ |---------------------------|------------------------------------------------------|---------------------------------------------------------------------|
99
+ | `hard_forward` | output uses the single operation selected by `theta` | output is a softmax mixture of the three operations (`temperature`) |
100
+ | `hard_backward` | input gradients from the selected operation only | input gradients from the exact derivative of the soft mixture |
101
+
102
+ The gradient with respect to `theta` always comes from the softmax surrogate, in every mode. All four combinations are
103
+ valid. The defaults are (`hard_forward=False`, `hard_backward=False`)
104
+
105
+ ## Layers
106
+
107
+ | Layer | Pairs | Output size |
108
+ |-----------------------------|----------------------------------------------------|--------------|
109
+ | `PredicateLayer` | every unique pair `(i, j)`, `i < j` | `n(n−1)/2` |
110
+ | `MinimalPredicateLayer` | disjoint pairs `(0,1), (2,3), …`; odd last input is passed through | `⌈n/2⌉` |
111
+ | `MinimalJointPredicateLayer`| overlapping circular pairs `(0,1), (1,2), …, (n−1,0)` | `n` |
112
+
113
+ Every layer owns one `theta` per pair and accepts inputs of any rank, with the features on the last axis.
114
+
115
+ ## Switching modes
116
+
117
+ Each layer keeps its own flags, so layers in one model can run in different modes.
118
+
119
+ ```python
120
+ from predicateneuron.keras import set_model_hard_forward, set_model_hard_backward
121
+
122
+ # a single layer
123
+ layer.set_hard_forward(False)
124
+ layer.set_hard_backward(False)
125
+
126
+ # every predicate layer in a model (including nested ones)
127
+ set_model_hard_forward(model, False) # e.g. soft warm-up
128
+ set_model_hard_backward(model, False)
129
+ set_model_hard_forward(model, True) # switch back to hard gates
130
+
131
+ # mixed: all soft except one layer
132
+ set_model_hard_forward(model, False)
133
+ model.get_layer("last_predicate").set_hard_forward(True)
134
+ ```
135
+
136
+ The flags are stored as variables (Keras) or buffers (PyTorch), so they can be changed during training without
137
+ rebuilding the model. In Keras they are also part of `get_config`, so saved models restore their mode.
138
+
139
+ ## Notes
140
+
141
+ - Keras support targets **Keras 3**. TensorFlow 2.15 and earlier ship Keras 2 as `tf.keras`, which is not supported.
142
+ - Both `theta` and the three candidate operations are differentiated separately by design (see *Forward and backward
143
+ modes*), so soft mode is not plain backpropagation through the mixture unless `hard_backward=False`.
144
+
145
+ ## Citation
146
+
147
+ If you use this code, please cite the paper (see `CITATION.cff`).
148
+
149
+ ## License
150
+
151
+ Apache 2.0
@@ -0,0 +1,12 @@
1
+ predicateneuron/__init__.py,sha256=QUxIbGRyK3xYdJ0254fNc_6IGTFLnKKIH72bFx_ge5U,526
2
+ predicateneuron/tf.py,sha256=7-Y-XXDvLVrYXPf2sz4sI_xCCIN7RyC5Z9h95-CqMw4,586
3
+ predicateneuron/keras/__init__.py,sha256=zzeuwhhW1YB_fJLc59DBimyTMY2XK1ntqgN-Ny7v_O8,546
4
+ predicateneuron/keras/functional.py,sha256=A60DpR3sqT0GntkVUz2yiM8GtCSeub3VA2KZsyq_9b4,1910
5
+ predicateneuron/keras/layers.py,sha256=V2DUmODpWIgj64AmXSBk_SEhvRmdYALWNdCYSasJziw,5701
6
+ predicateneuron/torch/__init__.py,sha256=b7ZBYimiMR4YwV1n0YIUmah3xGmekJcifDVrxFS7uCU,546
7
+ predicateneuron/torch/functional.py,sha256=OrZuUnnWLrI68HPET8qQTjLxHxawbJhBzjd5IMS0jPY,1945
8
+ predicateneuron/torch/layers.py,sha256=-4Ui02GUOWeQszttyZhV3R8AkqyfmTFKydMVsRYZ_60,5214
9
+ predicateneuron-0.1.0.dist-info/METADATA,sha256=6DpRPbxB4l_YdVX8wfS8Ahyly7rhg6F3UtMLuRmX0eE,6028
10
+ predicateneuron-0.1.0.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
11
+ predicateneuron-0.1.0.dist-info/licenses/LICENSE,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
12
+ predicateneuron-0.1.0.dist-info/RECORD,,
@@ -0,0 +1,4 @@
1
+ Wheel-Version: 1.0
2
+ Generator: hatchling 1.32.4
3
+ Root-Is-Purelib: true
4
+ Tag: py3-none-any
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.