fleqx 0.0.2__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.
- fleqx/__init__.py +12 -0
- fleqx/bijectors/__init__.py +13 -0
- fleqx/bijectors/_affine_common.py +31 -0
- fleqx/bijectors/_coupling.py +104 -0
- fleqx/bijectors/_invert.py +62 -0
- fleqx/bijectors/_masked_autoregressive.py +132 -0
- fleqx/bijectors/_masks.py +26 -0
- fleqx/bijectors/_permute.py +57 -0
- fleqx/bijectors/_planar.py +95 -0
- fleqx/flows.py +227 -0
- fleqx/py.typed +0 -0
- fleqx/train/__init__.py +4 -0
- fleqx/train/_loops.py +118 -0
- fleqx/train/_losses.py +32 -0
- fleqx/train/_train_utils.py +71 -0
- fleqx-0.0.2.dist-info/METADATA +92 -0
- fleqx-0.0.2.dist-info/RECORD +20 -0
- fleqx-0.0.2.dist-info/WHEEL +5 -0
- fleqx-0.0.2.dist-info/licenses/LICENSE +201 -0
- fleqx-0.0.2.dist-info/top_level.txt +1 -0
fleqx/__init__.py
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
"""fleqx: normalizing flows for JAX, with a distreqx-native API."""
|
|
2
|
+
|
|
3
|
+
from . import bijectors as bijectors
|
|
4
|
+
from . import flows as flows
|
|
5
|
+
from . import train as train
|
|
6
|
+
|
|
7
|
+
try: # pragma: no cover
|
|
8
|
+
import importlib.metadata
|
|
9
|
+
|
|
10
|
+
__version__ = importlib.metadata.version("fleqx")
|
|
11
|
+
except importlib.metadata.PackageNotFoundError: # pragma: no cover
|
|
12
|
+
__version__ = "0.0.1"
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
"""Bijectors used to build normalizing flows.
|
|
2
|
+
|
|
3
|
+
Every class here is a genuine `distreqx.bijectors.AbstractBijector`, implemented
|
|
4
|
+
directly against the distreqx API with no third-party flow library involved. Most
|
|
5
|
+
users should build flows with a constructor from [`fleqx.flows`][] instead; this
|
|
6
|
+
module is for composing layers by hand.
|
|
7
|
+
"""
|
|
8
|
+
|
|
9
|
+
from ._coupling import Coupling as Coupling
|
|
10
|
+
from ._invert import Invert as Invert
|
|
11
|
+
from ._masked_autoregressive import MaskedAutoregressive as MaskedAutoregressive
|
|
12
|
+
from ._permute import Permute as Permute
|
|
13
|
+
from ._planar import Planar as Planar
|
|
@@ -0,0 +1,31 @@
|
|
|
1
|
+
"""Shared helper for bijectors parameterising an elementwise affine transform."""
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
import jax.nn as jnn
|
|
6
|
+
import jax.numpy as jnp
|
|
7
|
+
from jaxtyping import Array
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
def positive_scale(raw_scale: Array, min_scale: float) -> Array:
|
|
11
|
+
"""Maps an unconstrained array to strictly positive values via `softplus`.
|
|
12
|
+
|
|
13
|
+
`min_scale` is added as a floor, both for numerical stability (avoiding
|
|
14
|
+
`log(scale)` blowing up as `scale -> 0`) and to guarantee positivity outright.
|
|
15
|
+
"""
|
|
16
|
+
return jnn.softplus(raw_scale) + min_scale
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
def identity_init_offset(min_scale: float) -> Array:
|
|
20
|
+
"""Offset added to a conditioner's raw scale output before `positive_scale`.
|
|
21
|
+
|
|
22
|
+
A freshly initialised conditioner network outputs values close to zero, and
|
|
23
|
+
`positive_scale(0, min_scale)` is around 0.7, not 1 -- so without this offset, a
|
|
24
|
+
layer starts noticeably *shrinking* its input rather than close to the identity.
|
|
25
|
+
That compounds across layers (e.g. 0.7^8 ~ 0.06), making a deep flow start far
|
|
26
|
+
from the base distribution's scale and harder to train. Adding this offset before
|
|
27
|
+
`positive_scale` makes `positive_scale(0 + offset, min_scale) == 1` exactly, so a
|
|
28
|
+
freshly initialised layer starts at (approximately) the identity.
|
|
29
|
+
"""
|
|
30
|
+
target = 1.0 - min_scale
|
|
31
|
+
return jnp.log(-jnp.expm1(-target)) + target
|
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
"""Coupling bijector."""
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
from collections.abc import Callable
|
|
6
|
+
|
|
7
|
+
import equinox as eqx
|
|
8
|
+
import jax
|
|
9
|
+
import jax.numpy as jnp
|
|
10
|
+
from distreqx.bijectors import (
|
|
11
|
+
AbstractBijector,
|
|
12
|
+
AbstractForwardInverseBijector,
|
|
13
|
+
AbstractFwdLogDetJacBijector,
|
|
14
|
+
AbstractInvLogDetJacBijector,
|
|
15
|
+
)
|
|
16
|
+
from jaxtyping import Array, PRNGKeyArray
|
|
17
|
+
|
|
18
|
+
from ._affine_common import identity_init_offset, positive_scale
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
class Coupling(
|
|
22
|
+
AbstractForwardInverseBijector,
|
|
23
|
+
AbstractFwdLogDetJacBijector,
|
|
24
|
+
AbstractInvLogDetJacBijector,
|
|
25
|
+
):
|
|
26
|
+
"""Coupling layer with an elementwise affine transform.
|
|
27
|
+
|
|
28
|
+
See [Dinh et al., 2016](https://arxiv.org/abs/1605.08803). Splits the input into
|
|
29
|
+
two parts. The first `untransformed_dim` elements are left untouched and fed
|
|
30
|
+
through an MLP conditioner to produce a per-element shift and (positive) scale,
|
|
31
|
+
which affinely transform the remaining elements.
|
|
32
|
+
"""
|
|
33
|
+
|
|
34
|
+
untransformed_dim: int
|
|
35
|
+
dim: int
|
|
36
|
+
min_scale: float
|
|
37
|
+
conditioner: eqx.nn.MLP
|
|
38
|
+
_is_constant_jacobian: bool
|
|
39
|
+
_is_constant_log_det: bool
|
|
40
|
+
|
|
41
|
+
def __init__(
|
|
42
|
+
self,
|
|
43
|
+
key: PRNGKeyArray,
|
|
44
|
+
*,
|
|
45
|
+
untransformed_dim: int,
|
|
46
|
+
dim: int,
|
|
47
|
+
nn_width: int,
|
|
48
|
+
nn_depth: int,
|
|
49
|
+
nn_activation: Callable = jax.nn.relu,
|
|
50
|
+
min_scale: float = 1e-2,
|
|
51
|
+
):
|
|
52
|
+
"""Initializes a `Coupling` bijector.
|
|
53
|
+
|
|
54
|
+
**Arguments:**
|
|
55
|
+
|
|
56
|
+
- `key`: JAX random key used to initialise the conditioner MLP.
|
|
57
|
+
- `untransformed_dim`: Number of leading elements left untouched.
|
|
58
|
+
- `dim`: Total dimension.
|
|
59
|
+
- `nn_width`: Conditioner hidden layer width.
|
|
60
|
+
- `nn_depth`: Conditioner hidden layer depth.
|
|
61
|
+
- `nn_activation`: Conditioner activation function. Defaults to
|
|
62
|
+
`jax.nn.relu`.
|
|
63
|
+
- `min_scale`: Lower bound added to the transform's scale, for numerical
|
|
64
|
+
stability (also keeps the scale strictly positive). Defaults to 0.01.
|
|
65
|
+
"""
|
|
66
|
+
self.untransformed_dim = untransformed_dim
|
|
67
|
+
self.dim = dim
|
|
68
|
+
self.min_scale = min_scale
|
|
69
|
+
transform_dim = dim - untransformed_dim
|
|
70
|
+
self.conditioner = eqx.nn.MLP(
|
|
71
|
+
in_size=untransformed_dim,
|
|
72
|
+
out_size=2 * transform_dim,
|
|
73
|
+
width_size=nn_width,
|
|
74
|
+
depth=nn_depth,
|
|
75
|
+
activation=nn_activation,
|
|
76
|
+
key=key,
|
|
77
|
+
)
|
|
78
|
+
self._is_constant_jacobian = False
|
|
79
|
+
self._is_constant_log_det = False
|
|
80
|
+
|
|
81
|
+
def _shift_and_scale(self, x_cond: Array) -> tuple[Array, Array]:
|
|
82
|
+
# Each dimension's (shift, raw_scale) pair is adjacent in the conditioner's
|
|
83
|
+
# output, not grouped by kind -- i.e. [shift_0, scale_0, shift_1, scale_1, ...].
|
|
84
|
+
shift, raw_scale = jnp.reshape(self.conditioner(x_cond), (-1, 2)).T
|
|
85
|
+
offset = identity_init_offset(self.min_scale)
|
|
86
|
+
return shift, positive_scale(raw_scale + offset, self.min_scale)
|
|
87
|
+
|
|
88
|
+
def forward_and_log_det(self, x: Array) -> tuple[Array, Array]:
|
|
89
|
+
"""Computes y = f(x) and log|det J(f)(x)|."""
|
|
90
|
+
x_cond, x_trans = x[: self.untransformed_dim], x[self.untransformed_dim :]
|
|
91
|
+
shift, scale = self._shift_and_scale(x_cond)
|
|
92
|
+
y = jnp.concatenate([x_cond, x_trans * scale + shift])
|
|
93
|
+
return y, jnp.sum(jnp.log(scale))
|
|
94
|
+
|
|
95
|
+
def inverse_and_log_det(self, y: Array) -> tuple[Array, Array]:
|
|
96
|
+
"""Computes x = f^{-1}(y) and log|det J(f^{-1})(y)|."""
|
|
97
|
+
y_cond, y_trans = y[: self.untransformed_dim], y[self.untransformed_dim :]
|
|
98
|
+
shift, scale = self._shift_and_scale(y_cond)
|
|
99
|
+
x = jnp.concatenate([y_cond, (y_trans - shift) / scale])
|
|
100
|
+
return x, -jnp.sum(jnp.log(scale))
|
|
101
|
+
|
|
102
|
+
def same_as(self, other: AbstractBijector) -> bool:
|
|
103
|
+
"""Returns True if this bijector is guaranteed to be the same as `other`."""
|
|
104
|
+
return self is other
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
"""Bijector inversion."""
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
from distreqx.bijectors import AbstractBijector
|
|
6
|
+
from jaxtyping import Array
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
class Invert(AbstractBijector):
|
|
10
|
+
"""Inverts a bijector, swapping its forward and inverse directions.
|
|
11
|
+
|
|
12
|
+
Bijectors are usually implemented with their cheaper direction as "forward". For
|
|
13
|
+
a coupling flow, the inverse transform is used by `log_prob` and the forward
|
|
14
|
+
transform by `sample`, so wrapping the flow's bijector in `Invert` swaps which of
|
|
15
|
+
the two is fast -- useful for prioritising fast maximum-likelihood training,
|
|
16
|
+
which repeatedly evaluates `log_prob`.
|
|
17
|
+
"""
|
|
18
|
+
|
|
19
|
+
bijector: AbstractBijector
|
|
20
|
+
_is_constant_jacobian: bool
|
|
21
|
+
_is_constant_log_det: bool
|
|
22
|
+
|
|
23
|
+
def __init__(self, bijector: AbstractBijector):
|
|
24
|
+
"""Initializes an `Invert` bijector.
|
|
25
|
+
|
|
26
|
+
**Arguments:**
|
|
27
|
+
|
|
28
|
+
- `bijector`: The bijector to invert.
|
|
29
|
+
"""
|
|
30
|
+
self.bijector = bijector
|
|
31
|
+
self._is_constant_jacobian = bijector.is_constant_jacobian
|
|
32
|
+
self._is_constant_log_det = bijector.is_constant_log_det
|
|
33
|
+
|
|
34
|
+
def forward(self, x: Array) -> Array:
|
|
35
|
+
"""Computes y = f(x)."""
|
|
36
|
+
return self.bijector.inverse(x)
|
|
37
|
+
|
|
38
|
+
def inverse(self, y: Array) -> Array:
|
|
39
|
+
"""Computes x = f^{-1}(y)."""
|
|
40
|
+
return self.bijector.forward(y)
|
|
41
|
+
|
|
42
|
+
def forward_log_det_jacobian(self, x: Array) -> Array:
|
|
43
|
+
"""Computes log|det J(f)(x)|."""
|
|
44
|
+
return self.bijector.inverse_log_det_jacobian(x)
|
|
45
|
+
|
|
46
|
+
def inverse_log_det_jacobian(self, y: Array) -> Array:
|
|
47
|
+
"""Computes log|det J(f^{-1})(y)|."""
|
|
48
|
+
return self.bijector.forward_log_det_jacobian(y)
|
|
49
|
+
|
|
50
|
+
def forward_and_log_det(self, x: Array) -> tuple[Array, Array]:
|
|
51
|
+
"""Computes y = f(x) and log|det J(f)(x)|."""
|
|
52
|
+
return self.bijector.inverse_and_log_det(x)
|
|
53
|
+
|
|
54
|
+
def inverse_and_log_det(self, y: Array) -> tuple[Array, Array]:
|
|
55
|
+
"""Computes x = f^{-1}(y) and log|det J(f^{-1})(y)|."""
|
|
56
|
+
return self.bijector.forward_and_log_det(y)
|
|
57
|
+
|
|
58
|
+
def same_as(self, other: AbstractBijector) -> bool:
|
|
59
|
+
"""Returns True if this bijector is guaranteed to be the same as `other`."""
|
|
60
|
+
if type(other) is Invert:
|
|
61
|
+
return self.bijector.same_as(other.bijector)
|
|
62
|
+
return False
|
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
"""Masked autoregressive bijector."""
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
from collections.abc import Callable
|
|
6
|
+
|
|
7
|
+
import equinox as eqx
|
|
8
|
+
import jax
|
|
9
|
+
import jax.numpy as jnp
|
|
10
|
+
from distreqx.bijectors import (
|
|
11
|
+
AbstractBijector,
|
|
12
|
+
AbstractForwardInverseBijector,
|
|
13
|
+
AbstractFwdLogDetJacBijector,
|
|
14
|
+
AbstractInvLogDetJacBijector,
|
|
15
|
+
)
|
|
16
|
+
from jaxtyping import Array, PRNGKeyArray
|
|
17
|
+
|
|
18
|
+
from ._affine_common import identity_init_offset, positive_scale
|
|
19
|
+
from ._masks import rank_based_mask
|
|
20
|
+
|
|
21
|
+
|
|
22
|
+
class MaskedAutoregressive(
|
|
23
|
+
AbstractForwardInverseBijector,
|
|
24
|
+
AbstractFwdLogDetJacBijector,
|
|
25
|
+
AbstractInvLogDetJacBijector,
|
|
26
|
+
):
|
|
27
|
+
"""Masked autoregressive bijector with an elementwise affine transform.
|
|
28
|
+
|
|
29
|
+
See [Papamakarios et al., 2017](https://arxiv.org/abs/1705.07057). An MLP with
|
|
30
|
+
weights masked in a MADE-style (Germain et al., 2015) pattern maps `x` to a
|
|
31
|
+
per-element shift and (positive) scale for each dimension, such that dimension
|
|
32
|
+
`i`'s transform depends only on `x[:i]`. This makes evaluating the whole forward
|
|
33
|
+
transform (and hence `log_prob`) a single parallel pass, at the cost of the
|
|
34
|
+
inverse (hence `sample`) needing a `dim`-step sequential loop, one dimension at a
|
|
35
|
+
time -- the opposite trade-off to [`fleqx.bijectors.Coupling`][].
|
|
36
|
+
"""
|
|
37
|
+
|
|
38
|
+
layers: tuple[eqx.nn.Linear, ...]
|
|
39
|
+
masks: tuple[Array, ...]
|
|
40
|
+
activation: Callable
|
|
41
|
+
dim: int
|
|
42
|
+
min_scale: float
|
|
43
|
+
_is_constant_jacobian: bool
|
|
44
|
+
_is_constant_log_det: bool
|
|
45
|
+
|
|
46
|
+
def __init__(
|
|
47
|
+
self,
|
|
48
|
+
key: PRNGKeyArray,
|
|
49
|
+
*,
|
|
50
|
+
dim: int,
|
|
51
|
+
nn_width: int,
|
|
52
|
+
nn_depth: int,
|
|
53
|
+
nn_activation: Callable = jax.nn.relu,
|
|
54
|
+
min_scale: float = 1e-2,
|
|
55
|
+
):
|
|
56
|
+
"""Initializes a `MaskedAutoregressive` bijector.
|
|
57
|
+
|
|
58
|
+
**Arguments:**
|
|
59
|
+
|
|
60
|
+
- `key`: JAX random key used to initialise the conditioner MLP.
|
|
61
|
+
- `dim`: Total dimension.
|
|
62
|
+
- `nn_width`: Conditioner hidden layer width.
|
|
63
|
+
- `nn_depth`: Conditioner hidden layer depth.
|
|
64
|
+
- `nn_activation`: Conditioner activation function. Defaults to
|
|
65
|
+
`jax.nn.relu`.
|
|
66
|
+
- `min_scale`: Lower bound added to the transform's scale, for numerical
|
|
67
|
+
stability (also keeps the scale strictly positive). Defaults to 0.01.
|
|
68
|
+
"""
|
|
69
|
+
mlp = eqx.nn.MLP(
|
|
70
|
+
in_size=dim,
|
|
71
|
+
out_size=2 * dim,
|
|
72
|
+
width_size=nn_width,
|
|
73
|
+
depth=nn_depth,
|
|
74
|
+
activation=nn_activation,
|
|
75
|
+
key=key,
|
|
76
|
+
)
|
|
77
|
+
in_ranks = jnp.arange(dim)
|
|
78
|
+
# For dim==1 this would divide by zero; MAF has nothing to condition on
|
|
79
|
+
# there regardless (all weights end up masked out below).
|
|
80
|
+
hidden_ranks = jnp.arange(nn_width) % max(dim - 1, 1)
|
|
81
|
+
out_ranks = jnp.repeat(jnp.arange(dim), 2)
|
|
82
|
+
ranks = [in_ranks, *([hidden_ranks] * nn_depth), out_ranks]
|
|
83
|
+
|
|
84
|
+
self.layers = mlp.layers
|
|
85
|
+
self.masks = tuple(
|
|
86
|
+
rank_based_mask(ranks[i], ranks[i + 1], eq=i != len(mlp.layers) - 1)
|
|
87
|
+
for i in range(len(mlp.layers))
|
|
88
|
+
)
|
|
89
|
+
self.activation = nn_activation
|
|
90
|
+
self.dim = dim
|
|
91
|
+
self.min_scale = min_scale
|
|
92
|
+
self._is_constant_jacobian = False
|
|
93
|
+
self._is_constant_log_det = False
|
|
94
|
+
|
|
95
|
+
def _conditioner(self, x: Array) -> Array:
|
|
96
|
+
h = x
|
|
97
|
+
for i, (layer, mask) in enumerate(zip(self.layers, self.masks, strict=True)):
|
|
98
|
+
h = jnp.where(mask, layer.weight, 0.0) @ h + layer.bias
|
|
99
|
+
if i < len(self.layers) - 1:
|
|
100
|
+
h = self.activation(h)
|
|
101
|
+
return h
|
|
102
|
+
|
|
103
|
+
def _shift_and_scale(self, params: Array) -> tuple[Array, Array]:
|
|
104
|
+
shift, raw_scale = jnp.reshape(params, (self.dim, 2)).T
|
|
105
|
+
offset = identity_init_offset(self.min_scale)
|
|
106
|
+
return shift, positive_scale(raw_scale + offset, self.min_scale)
|
|
107
|
+
|
|
108
|
+
def forward_and_log_det(self, x: Array) -> tuple[Array, Array]:
|
|
109
|
+
"""Computes y = f(x) and log|det J(f)(x)|."""
|
|
110
|
+
shift, scale = self._shift_and_scale(self._conditioner(x))
|
|
111
|
+
y = x * scale + shift
|
|
112
|
+
return y, jnp.sum(jnp.log(scale))
|
|
113
|
+
|
|
114
|
+
def inverse_and_log_det(self, y: Array) -> tuple[Array, Array]:
|
|
115
|
+
"""Computes x = f^{-1}(y) and log|det J(f^{-1})(y)|.
|
|
116
|
+
|
|
117
|
+
Sequential in `dim`: recovering `x[i]` needs `x[:i]`, which is only
|
|
118
|
+
available once earlier iterations have filled it in.
|
|
119
|
+
"""
|
|
120
|
+
|
|
121
|
+
def step(x: Array, i: Array) -> tuple[Array, None]:
|
|
122
|
+
shift, scale = self._shift_and_scale(self._conditioner(x))
|
|
123
|
+
x = x.at[i].set((y[i] - shift[i]) / scale[i])
|
|
124
|
+
return x, None
|
|
125
|
+
|
|
126
|
+
x, _ = jax.lax.scan(step, jnp.zeros_like(y), jnp.arange(self.dim))
|
|
127
|
+
_, scale = self._shift_and_scale(self._conditioner(x))
|
|
128
|
+
return x, -jnp.sum(jnp.log(scale))
|
|
129
|
+
|
|
130
|
+
def same_as(self, other: AbstractBijector) -> bool:
|
|
131
|
+
"""Returns True if this bijector is guaranteed to be the same as `other`."""
|
|
132
|
+
return self is other
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
"""Masks used to build autoregressive neural networks."""
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
import operator
|
|
6
|
+
|
|
7
|
+
import jax.numpy as jnp
|
|
8
|
+
from jaxtyping import Array, Bool, Int
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
def rank_based_mask(
|
|
12
|
+
in_ranks: Int[Array, " a"], out_ranks: Int[Array, " b"], *, eq: bool = False
|
|
13
|
+
) -> Bool[Array, "b a"]:
|
|
14
|
+
"""A mask with entries `out_ranks > in_ranks` (or `>=`, if `eq`).
|
|
15
|
+
|
|
16
|
+
Used to build a MADE-style masked MLP (Germain et al., 2015): zeroing a weight
|
|
17
|
+
matrix with this mask ensures the layer's output at rank `r` only depends on
|
|
18
|
+
inputs with a strictly lower rank, which is what makes the resulting network
|
|
19
|
+
autoregressive.
|
|
20
|
+
|
|
21
|
+
**Returns:**
|
|
22
|
+
|
|
23
|
+
- A boolean array of shape `(len(out_ranks), len(in_ranks))`.
|
|
24
|
+
"""
|
|
25
|
+
op = operator.ge if eq else operator.gt
|
|
26
|
+
return op(out_ranks[:, None], in_ranks)
|
|
@@ -0,0 +1,57 @@
|
|
|
1
|
+
"""Fixed-permutation bijector."""
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
import jax.numpy as jnp
|
|
6
|
+
from distreqx.bijectors import (
|
|
7
|
+
AbstractBijector,
|
|
8
|
+
AbstractForwardInverseBijector,
|
|
9
|
+
AbstractFwdLogDetJacBijector,
|
|
10
|
+
AbstractInvLogDetJacBijector,
|
|
11
|
+
)
|
|
12
|
+
from jaxtyping import Array
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
class Permute(
|
|
16
|
+
AbstractForwardInverseBijector,
|
|
17
|
+
AbstractFwdLogDetJacBijector,
|
|
18
|
+
AbstractInvLogDetJacBijector,
|
|
19
|
+
):
|
|
20
|
+
"""Reorders the elements of a vector according to a fixed permutation.
|
|
21
|
+
|
|
22
|
+
A permutation has a constant Jacobian determinant of magnitude 1, so it
|
|
23
|
+
contributes nothing to a flow's log-density -- it exists purely to let later
|
|
24
|
+
layers mix over dimensions left untouched by earlier ones.
|
|
25
|
+
"""
|
|
26
|
+
|
|
27
|
+
permutation: Array
|
|
28
|
+
inverse_permutation: Array
|
|
29
|
+
_is_constant_jacobian: bool
|
|
30
|
+
_is_constant_log_det: bool
|
|
31
|
+
|
|
32
|
+
def __init__(self, permutation: Array):
|
|
33
|
+
"""Initializes a `Permute` bijector.
|
|
34
|
+
|
|
35
|
+
**Arguments:**
|
|
36
|
+
|
|
37
|
+
- `permutation`: A 1-D integer array containing a permutation of
|
|
38
|
+
`arange(len(permutation))`.
|
|
39
|
+
"""
|
|
40
|
+
self.permutation = jnp.asarray(permutation)
|
|
41
|
+
self.inverse_permutation = jnp.argsort(self.permutation)
|
|
42
|
+
self._is_constant_jacobian = True
|
|
43
|
+
self._is_constant_log_det = True
|
|
44
|
+
|
|
45
|
+
def forward_and_log_det(self, x: Array) -> tuple[Array, Array]:
|
|
46
|
+
"""Computes y = f(x) and log|det J(f)(x)|."""
|
|
47
|
+
return x[self.permutation], jnp.zeros(())
|
|
48
|
+
|
|
49
|
+
def inverse_and_log_det(self, y: Array) -> tuple[Array, Array]:
|
|
50
|
+
"""Computes x = f^{-1}(y) and log|det J(f^{-1})(y)|."""
|
|
51
|
+
return y[self.inverse_permutation], jnp.zeros(())
|
|
52
|
+
|
|
53
|
+
def same_as(self, other: AbstractBijector) -> bool:
|
|
54
|
+
"""Returns True if this bijector is guaranteed to be the same as `other`."""
|
|
55
|
+
if type(other) is Permute:
|
|
56
|
+
return self.permutation is other.permutation
|
|
57
|
+
return False
|
|
@@ -0,0 +1,95 @@
|
|
|
1
|
+
"""Planar bijector."""
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
import jax
|
|
6
|
+
import jax.numpy as jnp
|
|
7
|
+
import jax.random as jr
|
|
8
|
+
from distreqx.bijectors import (
|
|
9
|
+
AbstractBijector,
|
|
10
|
+
AbstractForwardInverseBijector,
|
|
11
|
+
AbstractFwdLogDetJacBijector,
|
|
12
|
+
AbstractInvLogDetJacBijector,
|
|
13
|
+
)
|
|
14
|
+
from jaxtyping import Array, PRNGKeyArray
|
|
15
|
+
|
|
16
|
+
|
|
17
|
+
class Planar(
|
|
18
|
+
AbstractForwardInverseBijector,
|
|
19
|
+
AbstractFwdLogDetJacBijector,
|
|
20
|
+
AbstractInvLogDetJacBijector,
|
|
21
|
+
):
|
|
22
|
+
r"""Planar bijector: $y = x + u \cdot \text{leaky\_relu}(w^T x + b)$.
|
|
23
|
+
|
|
24
|
+
See [Rezende and Mohamed, 2015](https://arxiv.org/abs/1505.05770). The original
|
|
25
|
+
paper uses a $\tanh$ activation, but that has no closed-form inverse; this uses a
|
|
26
|
+
leaky ReLU instead (as the paper's appendix suggests), which does, at the cost of
|
|
27
|
+
slightly less smooth transformed densities.
|
|
28
|
+
"""
|
|
29
|
+
|
|
30
|
+
weight: Array
|
|
31
|
+
act_scale: Array
|
|
32
|
+
bias: Array
|
|
33
|
+
negative_slope: float
|
|
34
|
+
_is_constant_jacobian: bool
|
|
35
|
+
_is_constant_log_det: bool
|
|
36
|
+
|
|
37
|
+
def __init__(self, key: PRNGKeyArray, *, dim: int, negative_slope: float = 1e-2):
|
|
38
|
+
"""Initializes a `Planar` bijector.
|
|
39
|
+
|
|
40
|
+
**Arguments:**
|
|
41
|
+
|
|
42
|
+
- `key`: JAX random key used to initialise `w`, `u` and `b`.
|
|
43
|
+
- `dim`: Dimension of the bijection.
|
|
44
|
+
- `negative_slope`: The leaky ReLU's negative slope, in `(0, 1)`. Defaults to
|
|
45
|
+
0.01.
|
|
46
|
+
"""
|
|
47
|
+
if not 0 < negative_slope < 1:
|
|
48
|
+
raise ValueError("`negative_slope` must be in (0, 1).")
|
|
49
|
+
w_key, u_key, b_key = jr.split(key, 3)
|
|
50
|
+
self.weight = 1e-2 * jr.normal(w_key, (dim,))
|
|
51
|
+
self.act_scale = 1e-2 * jr.normal(u_key, (dim,))
|
|
52
|
+
self.bias = 1e-2 * jr.normal(b_key, ())
|
|
53
|
+
self.negative_slope = negative_slope
|
|
54
|
+
self._is_constant_jacobian = False
|
|
55
|
+
self._is_constant_log_det = False
|
|
56
|
+
|
|
57
|
+
def _invertible_act_scale(self) -> Array:
|
|
58
|
+
"""Constrains `u` so that `w^T u >= -1`, guaranteeing invertibility.
|
|
59
|
+
|
|
60
|
+
See Appendix A.1 of Rezende and Mohamed, 2015.
|
|
61
|
+
"""
|
|
62
|
+
wtu = self.act_scale @ self.weight
|
|
63
|
+
m_wtu = -1 + jnp.log1p(jax.nn.softplus(wtu))
|
|
64
|
+
return self.act_scale + (m_wtu - wtu) * self.weight / jnp.sum(self.weight**2)
|
|
65
|
+
|
|
66
|
+
def forward_and_log_det(self, x: Array) -> tuple[Array, Array]:
|
|
67
|
+
"""Computes y = f(x) and log|det J(f)(x)|."""
|
|
68
|
+
u = self._invertible_act_scale()
|
|
69
|
+
pre_act = x @ self.weight + self.bias
|
|
70
|
+
act = jax.nn.leaky_relu(pre_act, negative_slope=self.negative_slope)
|
|
71
|
+
y = x + u * act
|
|
72
|
+
slope = jnp.where(pre_act < 0, self.negative_slope, 1.0)
|
|
73
|
+
log_det = jnp.log(jnp.abs(1 + u @ (slope * self.weight)))
|
|
74
|
+
return y, log_det
|
|
75
|
+
|
|
76
|
+
def inverse_and_log_det(self, y: Array) -> tuple[Array, Array]:
|
|
77
|
+
"""Computes x = f^{-1}(y) and log|det J(f^{-1})(y)|.
|
|
78
|
+
|
|
79
|
+
Derivation: let $z = w^Tx + b$. Since $x = y - u \\cdot \\text{lrelu}(z)$,
|
|
80
|
+
substituting into $z = w^Tx + b$ and solving gives
|
|
81
|
+
$z = (w^Ty + b) / (1 + w^Tus)$, where $s$ is the leaky ReLU's slope at $z$
|
|
82
|
+
(found from the sign of $w^Ty + b$, since the denominator is positive).
|
|
83
|
+
"""
|
|
84
|
+
u = self._invertible_act_scale()
|
|
85
|
+
numerator = self.weight @ y + self.bias
|
|
86
|
+
slope = jnp.where(numerator < 0, self.negative_slope, 1.0)
|
|
87
|
+
us = u * slope
|
|
88
|
+
denominator = 1 + self.weight @ us
|
|
89
|
+
x = y - us * (numerator / denominator)
|
|
90
|
+
log_det = -jnp.log(jnp.abs(1 + us @ self.weight))
|
|
91
|
+
return x, log_det
|
|
92
|
+
|
|
93
|
+
def same_as(self, other: AbstractBijector) -> bool:
|
|
94
|
+
"""Returns True if this bijector is guaranteed to be the same as `other`."""
|
|
95
|
+
return self is other
|
fleqx/flows.py
ADDED
|
@@ -0,0 +1,227 @@
|
|
|
1
|
+
"""Constructors for normalizing-flow distributions.
|
|
2
|
+
|
|
3
|
+
Each constructor returns a plain `distreqx.distributions.Transformed` -- a base
|
|
4
|
+
distribution pushed through a bijector, no flow-specific wrapper class. As with any
|
|
5
|
+
distreqx distribution, `log_prob` and `sample` take a single event; use `jax.vmap`
|
|
6
|
+
for batches, e.g. `jax.vmap(flow.log_prob)(xs)`.
|
|
7
|
+
"""
|
|
8
|
+
|
|
9
|
+
from __future__ import annotations
|
|
10
|
+
|
|
11
|
+
from collections.abc import Callable
|
|
12
|
+
|
|
13
|
+
import jax.numpy as jnp
|
|
14
|
+
import jax.random as jr
|
|
15
|
+
from distreqx.bijectors import AbstractBijector, Chain, ScalarAffine
|
|
16
|
+
from distreqx.distributions import Independent, Normal, Transformed
|
|
17
|
+
from jax.nn import relu
|
|
18
|
+
from jaxtyping import Array, Float, PRNGKeyArray
|
|
19
|
+
|
|
20
|
+
from .bijectors import Coupling, Invert, MaskedAutoregressive, Permute, Planar
|
|
21
|
+
|
|
22
|
+
__all__ = ["coupling_flow", "masked_autoregressive_flow", "planar_flow"]
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
def _default_permute(dim: int, key: PRNGKeyArray) -> AbstractBijector | None:
|
|
26
|
+
"""A permutation to mix dimensions between layers.
|
|
27
|
+
|
|
28
|
+
`None` for `dim == 1`. For `dim == 2`, always swaps rather than drawing a random
|
|
29
|
+
permutation, since a random permutation of two elements is the identity half the
|
|
30
|
+
time.
|
|
31
|
+
"""
|
|
32
|
+
if dim == 1:
|
|
33
|
+
return None
|
|
34
|
+
if dim == 2:
|
|
35
|
+
return Permute(jnp.array([1, 0]))
|
|
36
|
+
return Permute(jr.permutation(key, dim))
|
|
37
|
+
|
|
38
|
+
|
|
39
|
+
def _standardizing_bijector(data: Float[Array, "n dim"]) -> ScalarAffine:
|
|
40
|
+
loc = jnp.mean(data, axis=0)
|
|
41
|
+
scale = jnp.std(data, axis=0)
|
|
42
|
+
return ScalarAffine(shift=loc, scale=scale)
|
|
43
|
+
|
|
44
|
+
|
|
45
|
+
def _finalize(
|
|
46
|
+
bijector: AbstractBijector, *, dim: int, data: Float[Array, "n dim"] | None
|
|
47
|
+
) -> Transformed:
|
|
48
|
+
if data is not None:
|
|
49
|
+
bijector = Chain([_standardizing_bijector(jnp.asarray(data)), bijector])
|
|
50
|
+
base = Independent(Normal(loc=jnp.zeros(dim), scale=jnp.ones(dim)))
|
|
51
|
+
return Transformed(base, bijector)
|
|
52
|
+
|
|
53
|
+
|
|
54
|
+
def _stack_layers(
|
|
55
|
+
key: PRNGKeyArray, flow_layers: int, make_layer: Callable[[PRNGKeyArray], AbstractBijector]
|
|
56
|
+
) -> AbstractBijector:
|
|
57
|
+
layer_keys = jr.split(key, flow_layers)
|
|
58
|
+
layers = [make_layer(k) for k in layer_keys]
|
|
59
|
+
return Chain(list(reversed(layers)))
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
def coupling_flow(
|
|
63
|
+
key: PRNGKeyArray,
|
|
64
|
+
*,
|
|
65
|
+
dim: int,
|
|
66
|
+
flow_layers: int = 8,
|
|
67
|
+
nn_width: int = 50,
|
|
68
|
+
nn_depth: int = 1,
|
|
69
|
+
nn_activation: Callable = relu,
|
|
70
|
+
invert: bool = True,
|
|
71
|
+
data: Float[Array, "n dim"] | None = None,
|
|
72
|
+
) -> Transformed:
|
|
73
|
+
"""Coupling flow ([Dinh et al., 2016](https://arxiv.org/abs/1605.08803)).
|
|
74
|
+
|
|
75
|
+
A stack of affine coupling layers ([`fleqx.bijectors.Coupling`][]), each followed
|
|
76
|
+
by a permutation, applied to a learnable diagonal-Gaussian base distribution.
|
|
77
|
+
|
|
78
|
+
**Arguments:**
|
|
79
|
+
|
|
80
|
+
- `key`: JAX random key.
|
|
81
|
+
- `dim`: Dimensionality of the distribution.
|
|
82
|
+
- `flow_layers`: Number of coupling layers. Defaults to 8.
|
|
83
|
+
- `nn_width`: Conditioner hidden layer width. Defaults to 50.
|
|
84
|
+
- `nn_depth`: Conditioner depth. Defaults to 1.
|
|
85
|
+
- `nn_activation`: Conditioner activation function. Defaults to `jax.nn.relu`.
|
|
86
|
+
- `invert`: If `True` (default), `log_prob` is the fast direction; if `False`,
|
|
87
|
+
`sample` is.
|
|
88
|
+
- `data`: Optional array of shape `(n, dim)`. If given, an extra affine
|
|
89
|
+
layer maps the flow's output to `data`'s mean and standard deviation
|
|
90
|
+
from the start, rather than the base distribution learning this during
|
|
91
|
+
training. Gives training a head start; useful when training for few
|
|
92
|
+
epochs. Defaults to `None`.
|
|
93
|
+
|
|
94
|
+
**Returns:**
|
|
95
|
+
|
|
96
|
+
A `distreqx.distributions.Transformed` distribution.
|
|
97
|
+
"""
|
|
98
|
+
if dim < 1:
|
|
99
|
+
raise ValueError(f"`dim` must be a positive integer, got {dim}.")
|
|
100
|
+
|
|
101
|
+
def make_layer(k: PRNGKeyArray) -> AbstractBijector:
|
|
102
|
+
bij_key, perm_key = jr.split(k)
|
|
103
|
+
coupling = Coupling(
|
|
104
|
+
bij_key,
|
|
105
|
+
untransformed_dim=dim // 2,
|
|
106
|
+
dim=dim,
|
|
107
|
+
nn_width=nn_width,
|
|
108
|
+
nn_depth=nn_depth,
|
|
109
|
+
nn_activation=nn_activation,
|
|
110
|
+
)
|
|
111
|
+
permute = _default_permute(dim, perm_key)
|
|
112
|
+
return coupling if permute is None else Chain([permute, coupling])
|
|
113
|
+
|
|
114
|
+
bijector = _stack_layers(key, flow_layers, make_layer)
|
|
115
|
+
if invert:
|
|
116
|
+
bijector = Invert(bijector)
|
|
117
|
+
return _finalize(bijector, dim=dim, data=data)
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
def masked_autoregressive_flow(
|
|
121
|
+
key: PRNGKeyArray,
|
|
122
|
+
*,
|
|
123
|
+
dim: int,
|
|
124
|
+
flow_layers: int = 8,
|
|
125
|
+
nn_width: int = 50,
|
|
126
|
+
nn_depth: int = 1,
|
|
127
|
+
nn_activation: Callable = relu,
|
|
128
|
+
invert: bool = True,
|
|
129
|
+
data: Float[Array, "n dim"] | None = None,
|
|
130
|
+
) -> Transformed:
|
|
131
|
+
"""Masked autoregressive flow ([Papamakarios et al., 2017](https://arxiv.org/abs/1705.07057)).
|
|
132
|
+
|
|
133
|
+
A stack of masked autoregressive layers ([`fleqx.bijectors.MaskedAutoregressive`][]),
|
|
134
|
+
each followed by a permutation, applied to a learnable diagonal-Gaussian base
|
|
135
|
+
distribution.
|
|
136
|
+
|
|
137
|
+
Unlike [`coupling_flow`][fleqx.flows.coupling_flow], the two transform directions
|
|
138
|
+
genuinely differ in cost: one is a single parallel pass, the other a `dim`-step
|
|
139
|
+
sequential loop. `invert` picks which direction `log_prob` gets.
|
|
140
|
+
|
|
141
|
+
**Arguments:**
|
|
142
|
+
|
|
143
|
+
- `key`: JAX random key.
|
|
144
|
+
- `dim`: Dimensionality of the distribution.
|
|
145
|
+
- `flow_layers`: Number of masked autoregressive layers. Defaults to 8.
|
|
146
|
+
- `nn_width`: Conditioner hidden layer width. Defaults to 50.
|
|
147
|
+
- `nn_depth`: Conditioner depth. Defaults to 1.
|
|
148
|
+
- `nn_activation`: Conditioner activation function. Defaults to `jax.nn.relu`.
|
|
149
|
+
- `invert`: If `True` (default), `log_prob` is the fast (parallel) direction --
|
|
150
|
+
recommended for maximum-likelihood training. If `False`, `sample` is fast
|
|
151
|
+
instead.
|
|
152
|
+
- `data`: Optional array of shape `(n, dim)`. If given, an extra affine
|
|
153
|
+
layer maps the flow's output to `data`'s mean and standard deviation
|
|
154
|
+
from the start, rather than the base distribution learning this during
|
|
155
|
+
training. Gives training a head start; useful when training for few
|
|
156
|
+
epochs. Defaults to `None`.
|
|
157
|
+
|
|
158
|
+
**Returns:**
|
|
159
|
+
|
|
160
|
+
A `distreqx.distributions.Transformed` distribution.
|
|
161
|
+
"""
|
|
162
|
+
if dim < 1:
|
|
163
|
+
raise ValueError(f"`dim` must be a positive integer, got {dim}.")
|
|
164
|
+
|
|
165
|
+
def make_layer(k: PRNGKeyArray) -> AbstractBijector:
|
|
166
|
+
bij_key, perm_key = jr.split(k)
|
|
167
|
+
maf = MaskedAutoregressive(
|
|
168
|
+
bij_key,
|
|
169
|
+
dim=dim,
|
|
170
|
+
nn_width=nn_width,
|
|
171
|
+
nn_depth=nn_depth,
|
|
172
|
+
nn_activation=nn_activation,
|
|
173
|
+
)
|
|
174
|
+
permute = _default_permute(dim, perm_key)
|
|
175
|
+
return maf if permute is None else Chain([permute, maf])
|
|
176
|
+
|
|
177
|
+
bijector = _stack_layers(key, flow_layers, make_layer)
|
|
178
|
+
if invert:
|
|
179
|
+
bijector = Invert(bijector)
|
|
180
|
+
return _finalize(bijector, dim=dim, data=data)
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
def planar_flow(
|
|
184
|
+
key: PRNGKeyArray,
|
|
185
|
+
*,
|
|
186
|
+
dim: int,
|
|
187
|
+
flow_layers: int = 8,
|
|
188
|
+
negative_slope: float = 1e-2,
|
|
189
|
+
invert: bool = True,
|
|
190
|
+
data: Float[Array, "n dim"] | None = None,
|
|
191
|
+
) -> Transformed:
|
|
192
|
+
"""Planar flow ([Rezende and Mohamed, 2015](https://arxiv.org/abs/1505.05770)).
|
|
193
|
+
|
|
194
|
+
A stack of planar layers ([`fleqx.bijectors.Planar`][]) applied to a learnable
|
|
195
|
+
diagonal-Gaussian base distribution. No permutation is needed between layers,
|
|
196
|
+
since each planar layer already depends on every dimension.
|
|
197
|
+
|
|
198
|
+
**Arguments:**
|
|
199
|
+
|
|
200
|
+
- `key`: JAX random key.
|
|
201
|
+
- `dim`: Dimensionality of the distribution.
|
|
202
|
+
- `flow_layers`: Number of planar layers. Defaults to 8.
|
|
203
|
+
- `negative_slope`: Negative slope of the leaky ReLU used within each layer (see
|
|
204
|
+
[`fleqx.bijectors.Planar`][]), in `(0, 1)`. Defaults to 0.01.
|
|
205
|
+
- `invert`: If `True` (default), `log_prob` is the fast direction; if `False`,
|
|
206
|
+
`sample` is.
|
|
207
|
+
- `data`: Optional array of shape `(n, dim)`. If given, an extra affine
|
|
208
|
+
layer maps the flow's output to `data`'s mean and standard deviation
|
|
209
|
+
from the start, rather than the base distribution learning this during
|
|
210
|
+
training. Gives training a head start; useful when training for few
|
|
211
|
+
epochs. Defaults to `None`.
|
|
212
|
+
|
|
213
|
+
**Returns:**
|
|
214
|
+
|
|
215
|
+
A `distreqx.distributions.Transformed` distribution.
|
|
216
|
+
"""
|
|
217
|
+
if dim < 1:
|
|
218
|
+
raise ValueError(f"`dim` must be a positive integer, got {dim}.")
|
|
219
|
+
|
|
220
|
+
def make_layer(k: PRNGKeyArray) -> AbstractBijector:
|
|
221
|
+
return Planar(k, dim=dim, negative_slope=negative_slope)
|
|
222
|
+
|
|
223
|
+
bijector = _stack_layers(key, flow_layers, make_layer)
|
|
224
|
+
if invert:
|
|
225
|
+
bijector = Invert(bijector)
|
|
226
|
+
return _finalize(bijector, dim=dim, data=data)
|
|
227
|
+
|
fleqx/py.typed
ADDED
|
File without changes
|
fleqx/train/__init__.py
ADDED
fleqx/train/_loops.py
ADDED
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
"""Training loops."""
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
from collections.abc import Callable
|
|
6
|
+
|
|
7
|
+
import equinox as eqx
|
|
8
|
+
import jax.numpy as jnp
|
|
9
|
+
import jax.random as jr
|
|
10
|
+
import optax
|
|
11
|
+
from distreqx.distributions import AbstractDistribution
|
|
12
|
+
from jaxtyping import Array, Float, PRNGKeyArray, Scalar
|
|
13
|
+
from tqdm import tqdm
|
|
14
|
+
|
|
15
|
+
from ._losses import MaximumLikelihoodLoss
|
|
16
|
+
from ._train_utils import count_fruitless, get_batches, step, train_val_split
|
|
17
|
+
|
|
18
|
+
|
|
19
|
+
def fit(
|
|
20
|
+
key: PRNGKeyArray,
|
|
21
|
+
dist: AbstractDistribution,
|
|
22
|
+
data: Float[Array, "n dim"],
|
|
23
|
+
*,
|
|
24
|
+
loss_fn: Callable[..., Scalar] | None = None,
|
|
25
|
+
learning_rate: float = 5e-4,
|
|
26
|
+
optimizer: optax.GradientTransformation | None = None,
|
|
27
|
+
max_epochs: int = 100,
|
|
28
|
+
max_patience: int = 5,
|
|
29
|
+
batch_size: int = 100,
|
|
30
|
+
val_prop: float = 0.1,
|
|
31
|
+
return_best: bool = True,
|
|
32
|
+
show_progress: bool = True,
|
|
33
|
+
) -> tuple[AbstractDistribution, dict[str, list[float]]]:
|
|
34
|
+
"""Fit a distribution to samples by minimising a loss (maximum likelihood by default).
|
|
35
|
+
|
|
36
|
+
A held-out validation split is used for early stopping: training stops once
|
|
37
|
+
`max_patience` consecutive epochs pass without an improvement in validation loss.
|
|
38
|
+
The last batch in each epoch is dropped if it would be truncated, to avoid
|
|
39
|
+
recompilation.
|
|
40
|
+
|
|
41
|
+
**Arguments:**
|
|
42
|
+
|
|
43
|
+
- `key`: JAX random key controlling the train/validation split, shuffling, and
|
|
44
|
+
(if applicable) any stochasticity in `loss_fn`.
|
|
45
|
+
- `dist`: The distribution to train (as returned by e.g.
|
|
46
|
+
[`fleqx.flows.coupling_flow`][]).
|
|
47
|
+
- `data`: Array of observations with shape ``(n, dim)``.
|
|
48
|
+
- `loss_fn`: Loss with signature ``(params, static, x, key)``. Defaults to
|
|
49
|
+
[`fleqx.train.MaximumLikelihoodLoss`][].
|
|
50
|
+
- `learning_rate`: Adam learning rate. Ignored if `optimizer` is given.
|
|
51
|
+
- `optimizer`: An optax optimizer. Defaults to ``optax.adam(learning_rate)``.
|
|
52
|
+
- `max_epochs`: Maximum number of passes over the data. Defaults to 100.
|
|
53
|
+
- `max_patience`: Number of consecutive epochs with no validation-loss
|
|
54
|
+
improvement after which training stops early. Defaults to 5.
|
|
55
|
+
- `batch_size`: Mini-batch size. Defaults to 100.
|
|
56
|
+
- `val_prop`: Proportion of `data` held out for validation. Defaults to 0.1.
|
|
57
|
+
- `return_best`: Whether to return the parameters from the epoch with the lowest
|
|
58
|
+
validation loss (`True`), or the parameters after the final update (`False`).
|
|
59
|
+
Defaults to `True`.
|
|
60
|
+
- `show_progress`: Whether to display a progress bar. Defaults to `True`.
|
|
61
|
+
|
|
62
|
+
**Returns:**
|
|
63
|
+
|
|
64
|
+
- A tuple ``(trained_dist, losses)``, where ``losses`` is a dict with ``"train"``
|
|
65
|
+
and ``"val"`` keys, each holding the mean loss per epoch.
|
|
66
|
+
"""
|
|
67
|
+
if loss_fn is None:
|
|
68
|
+
loss_fn = MaximumLikelihoodLoss()
|
|
69
|
+
if optimizer is None:
|
|
70
|
+
optimizer = optax.adam(learning_rate)
|
|
71
|
+
|
|
72
|
+
data = (jnp.asarray(data),)
|
|
73
|
+
params, static = eqx.partition(dist, eqx.is_inexact_array)
|
|
74
|
+
best_params = params
|
|
75
|
+
opt_state = optimizer.init(params)
|
|
76
|
+
|
|
77
|
+
key, subkey = jr.split(key)
|
|
78
|
+
train_data, val_data = train_val_split(subkey, data, val_prop=val_prop)
|
|
79
|
+
losses: dict[str, list[float]] = {"train": [], "val": []}
|
|
80
|
+
|
|
81
|
+
loop = tqdm(range(max_epochs), disable=not show_progress)
|
|
82
|
+
for _ in loop:
|
|
83
|
+
key, *subkeys = jr.split(key, 3)
|
|
84
|
+
train_data = [jr.permutation(subkeys[0], a) for a in train_data]
|
|
85
|
+
val_data = [jr.permutation(subkeys[1], a) for a in val_data]
|
|
86
|
+
|
|
87
|
+
batch_losses = []
|
|
88
|
+
for batch in zip(*get_batches(train_data, batch_size), strict=True):
|
|
89
|
+
key, subkey = jr.split(key)
|
|
90
|
+
params, opt_state, loss_i = step(
|
|
91
|
+
params,
|
|
92
|
+
static,
|
|
93
|
+
*batch,
|
|
94
|
+
optimizer=optimizer,
|
|
95
|
+
opt_state=opt_state,
|
|
96
|
+
loss_fn=loss_fn,
|
|
97
|
+
key=subkey,
|
|
98
|
+
)
|
|
99
|
+
batch_losses.append(loss_i)
|
|
100
|
+
losses["train"].append((sum(batch_losses) / len(batch_losses)).item())
|
|
101
|
+
|
|
102
|
+
batch_losses = []
|
|
103
|
+
for batch in zip(*get_batches(val_data, batch_size), strict=True):
|
|
104
|
+
key, subkey = jr.split(key)
|
|
105
|
+
loss_i = eqx.filter_jit(loss_fn)(params, static, *batch, key=subkey)
|
|
106
|
+
batch_losses.append(loss_i)
|
|
107
|
+
losses["val"].append((sum(batch_losses) / len(batch_losses)).item())
|
|
108
|
+
|
|
109
|
+
loop.set_postfix({k: v[-1] for k, v in losses.items()})
|
|
110
|
+
if losses["val"][-1] == min(losses["val"]):
|
|
111
|
+
best_params = params
|
|
112
|
+
elif count_fruitless(losses["val"]) > max_patience:
|
|
113
|
+
loop.set_postfix_str(f"{loop.postfix} (Max patience reached)")
|
|
114
|
+
break
|
|
115
|
+
|
|
116
|
+
params = best_params if return_best else params
|
|
117
|
+
trained = eqx.combine(params, static)
|
|
118
|
+
return trained, losses
|
fleqx/train/_losses.py
ADDED
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
"""Loss functions for training distributions."""
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
import equinox as eqx
|
|
6
|
+
import jax
|
|
7
|
+
from distreqx.distributions import AbstractDistribution
|
|
8
|
+
from jaxtyping import Array, Float, PRNGKeyArray, PyTree
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
class MaximumLikelihoodLoss:
|
|
12
|
+
"""Negative log-likelihood loss for fitting a distribution by maximum likelihood.
|
|
13
|
+
|
|
14
|
+
The call signature ``(params, static, x, key)`` matches what
|
|
15
|
+
[`fleqx.train.fit`][] expects: ``params`` and ``static`` are the two halves of an
|
|
16
|
+
``equinox.partition`` of the distribution, ``x`` is a batch of observations, and
|
|
17
|
+
``key`` is accepted (and ignored) for API consistency with stochastic losses.
|
|
18
|
+
"""
|
|
19
|
+
|
|
20
|
+
@eqx.filter_jit
|
|
21
|
+
def __call__(
|
|
22
|
+
self,
|
|
23
|
+
params: PyTree,
|
|
24
|
+
static: PyTree,
|
|
25
|
+
x: Float[Array, "batch dim"],
|
|
26
|
+
key: PRNGKeyArray | None = None,
|
|
27
|
+
) -> Float[Array, ""]:
|
|
28
|
+
"""Return the mean negative log-likelihood of ``x`` under the distribution."""
|
|
29
|
+
dist: AbstractDistribution = eqx.combine(params, static)
|
|
30
|
+
# `log_prob` takes a single, unbatched event -- like any distreqx
|
|
31
|
+
# distribution -- so batches of `x` must be vmapped explicitly.
|
|
32
|
+
return -jax.vmap(dist.log_prob)(x).mean()
|
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
"""Generic training utilities: batching, splitting, and an optax step.
|
|
2
|
+
|
|
3
|
+
Nothing here is specific to distreqx or to flows -- these operate on any pytree and
|
|
4
|
+
loss function.
|
|
5
|
+
"""
|
|
6
|
+
|
|
7
|
+
from __future__ import annotations
|
|
8
|
+
|
|
9
|
+
from collections.abc import Callable, Sequence
|
|
10
|
+
from functools import partial
|
|
11
|
+
|
|
12
|
+
import equinox as eqx
|
|
13
|
+
import jax.numpy as jnp
|
|
14
|
+
import jax.random as jr
|
|
15
|
+
import optax
|
|
16
|
+
from jax import jit
|
|
17
|
+
from jaxtyping import Array, PRNGKeyArray, PyTree, Scalar
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
@eqx.filter_jit
|
|
21
|
+
def step(
|
|
22
|
+
params: PyTree,
|
|
23
|
+
*args,
|
|
24
|
+
optimizer: optax.GradientTransformation,
|
|
25
|
+
opt_state: PyTree,
|
|
26
|
+
loss_fn: Callable[..., Scalar],
|
|
27
|
+
**kwargs,
|
|
28
|
+
) -> tuple[PyTree, PyTree, Scalar]:
|
|
29
|
+
"""A single optimisation step."""
|
|
30
|
+
loss_val, grads = eqx.filter_value_and_grad(loss_fn)(params, *args, **kwargs)
|
|
31
|
+
updates, opt_state = optimizer.update(grads, opt_state, params=params)
|
|
32
|
+
params = eqx.apply_updates(params, updates)
|
|
33
|
+
return params, opt_state, loss_val
|
|
34
|
+
|
|
35
|
+
|
|
36
|
+
def train_val_split(
|
|
37
|
+
key: PRNGKeyArray,
|
|
38
|
+
arrays: Sequence[Array],
|
|
39
|
+
val_prop: float = 0.1,
|
|
40
|
+
) -> tuple[list[Array], list[Array]]:
|
|
41
|
+
"""Random train/validation split for a sequence of arrays sharing axis-0 size."""
|
|
42
|
+
if not 0 <= val_prop <= 1:
|
|
43
|
+
raise ValueError("val_prop should be between 0 and 1.")
|
|
44
|
+
num_samples = arrays[0].shape[0]
|
|
45
|
+
n_train = num_samples - round(val_prop * num_samples)
|
|
46
|
+
arrays = [jr.permutation(key, a) for a in arrays]
|
|
47
|
+
train_arrays = [arr[:n_train] for arr in arrays]
|
|
48
|
+
val_arrays = [arr[n_train:] for arr in arrays]
|
|
49
|
+
return train_arrays, val_arrays
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
@partial(jit, static_argnums=1)
|
|
53
|
+
def get_batches(arrays: Sequence[Array], batch_size: int) -> tuple[Array, ...]:
|
|
54
|
+
"""Reshape arrays with shape ``(n, ...)`` to ``(n // batch_size, batch_size, ...)``.
|
|
55
|
+
|
|
56
|
+
The trailing partial batch is dropped if truncated (to avoid recompilation), and
|
|
57
|
+
`batch_size` is capped at the array length.
|
|
58
|
+
"""
|
|
59
|
+
return tuple(_add_batch(arr, batch_size) for arr in arrays)
|
|
60
|
+
|
|
61
|
+
|
|
62
|
+
def _add_batch(arr: Array, batch_size: int) -> Array:
|
|
63
|
+
batch_size = min(batch_size, arr.shape[0])
|
|
64
|
+
n_batches = arr.shape[0] // batch_size
|
|
65
|
+
return arr[: n_batches * batch_size].reshape(n_batches, batch_size, *arr.shape[1:])
|
|
66
|
+
|
|
67
|
+
|
|
68
|
+
def count_fruitless(losses: list[float]) -> int:
|
|
69
|
+
"""Number of epochs since the minimum loss in a list of losses."""
|
|
70
|
+
min_idx = jnp.argmin(jnp.array(losses)).item()
|
|
71
|
+
return len(losses) - min_idx - 1
|
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: fleqx
|
|
3
|
+
Version: 0.0.2
|
|
4
|
+
Summary: Normalizing flows for JAX, with a distreqx-native API.
|
|
5
|
+
Author: fleqx contributors
|
|
6
|
+
License: Apache-2.0
|
|
7
|
+
Project-URL: homepage, https://gvcallen.github.io/fleqx
|
|
8
|
+
Project-URL: documentation, https://gvcallen.github.io/fleqx
|
|
9
|
+
Project-URL: repository, https://github.com/gvcallen/fleqx
|
|
10
|
+
Keywords: jax,normalizing-flows,distreqx,equinox,machine-learning
|
|
11
|
+
Classifier: Development Status :: 3 - Alpha
|
|
12
|
+
Classifier: Intended Audience :: Science/Research
|
|
13
|
+
Classifier: License :: OSI Approved :: Apache Software License
|
|
14
|
+
Classifier: Programming Language :: Python :: 3
|
|
15
|
+
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
|
|
16
|
+
Classifier: Topic :: Scientific/Engineering :: Mathematics
|
|
17
|
+
Requires-Python: >=3.11
|
|
18
|
+
Description-Content-Type: text/markdown
|
|
19
|
+
License-File: LICENSE
|
|
20
|
+
Requires-Dist: jax>=0.7.0
|
|
21
|
+
Requires-Dist: equinox>=0.11
|
|
22
|
+
Requires-Dist: jaxtyping
|
|
23
|
+
Requires-Dist: optax
|
|
24
|
+
Requires-Dist: tqdm
|
|
25
|
+
Requires-Dist: distreqx>=0.0.3
|
|
26
|
+
Provides-Extra: test
|
|
27
|
+
Requires-Dist: pytest; extra == "test"
|
|
28
|
+
Requires-Dist: jax[cpu]; extra == "test"
|
|
29
|
+
Provides-Extra: docs
|
|
30
|
+
Requires-Dist: mkdocs>=1.6; extra == "docs"
|
|
31
|
+
Requires-Dist: mkdocs-material>=9.5; extra == "docs"
|
|
32
|
+
Requires-Dist: mkdocstrings[python]>=0.26; extra == "docs"
|
|
33
|
+
Requires-Dist: pymdown-extensions>=10.7; extra == "docs"
|
|
34
|
+
Dynamic: license-file
|
|
35
|
+
|
|
36
|
+
# fleqx
|
|
37
|
+
|
|
38
|
+
Normalizing flows for JAX, built directly on [distreqx](https://github.com/lockwo/distreqx).
|
|
39
|
+
|
|
40
|
+
A flow from `fleqx` is a plain `distreqx.distributions.Transformed` — there's no
|
|
41
|
+
flow-specific wrapper, so `log_prob`, `sample`, `optax` training, etc. all work
|
|
42
|
+
exactly as they would for any other distreqx distribution. As with any distreqx
|
|
43
|
+
distribution, batches are handled with `jax.vmap` rather than by passing in arrays
|
|
44
|
+
with a leading batch axis.
|
|
45
|
+
|
|
46
|
+
Three flow types are implemented so far: coupling, masked autoregressive, and planar.
|
|
47
|
+
|
|
48
|
+
## Example
|
|
49
|
+
|
|
50
|
+
```python
|
|
51
|
+
import jax.numpy as jnp
|
|
52
|
+
import jax.random as jr
|
|
53
|
+
|
|
54
|
+
import fleqx
|
|
55
|
+
|
|
56
|
+
key = jr.key(0)
|
|
57
|
+
flow = fleqx.flows.coupling_flow(key, dim=2)
|
|
58
|
+
|
|
59
|
+
sample = flow.sample(jr.key(1))
|
|
60
|
+
log_p = flow.log_prob(sample)
|
|
61
|
+
|
|
62
|
+
data = jr.normal(jr.key(2), (1000, 2))
|
|
63
|
+
flow, losses = fleqx.train.fit(jr.key(3), flow, data)
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
## Installation
|
|
67
|
+
|
|
68
|
+
```
|
|
69
|
+
pip install fleqx
|
|
70
|
+
```
|
|
71
|
+
|
|
72
|
+
See the [documentation](https://gvcallen.github.io/fleqx) for the full API.
|
|
73
|
+
|
|
74
|
+
## Acknowledgements
|
|
75
|
+
|
|
76
|
+
Built on [distreqx](https://github.com/lockwo/distreqx) (Owen Lockwood). The
|
|
77
|
+
bijectors were ported from [flowjax](https://github.com/danielward27/flowjax)
|
|
78
|
+
(Daniel Ward), a more complete flows library that's worth using directly if you don't
|
|
79
|
+
specifically need the distreqx API.
|
|
80
|
+
|
|
81
|
+
## Development
|
|
82
|
+
|
|
83
|
+
```
|
|
84
|
+
pip install -e ".[test]"
|
|
85
|
+
pytest
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
---
|
|
89
|
+
|
|
90
|
+
This library was written by Claude, porting the bijectors directly from flowjax.
|
|
91
|
+
Behaviour should be nearly identical to flowjax's, though minor differences may
|
|
92
|
+
remain, and the code hasn't yet had a full human review.
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
fleqx/__init__.py,sha256=AVibg38rRDU1xNlFZQIQuANPbvN1B3bbijueh2qaQVA,369
|
|
2
|
+
fleqx/flows.py,sha256=sVXJCl0vCOu3CQEbOCg56zDpJTB7nldERNCmfoTzO4c,8407
|
|
3
|
+
fleqx/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
|
|
4
|
+
fleqx/bijectors/__init__.py,sha256=D-fQ8bFuxSEUT83LrX5Kpi0pcBTe3NfG48tlBIbOKZI,578
|
|
5
|
+
fleqx/bijectors/_affine_common.py,sha256=IgWHBNi6JhmH5esB496JYrjzaJOLY5XAbuRMfvBMfwQ,1351
|
|
6
|
+
fleqx/bijectors/_coupling.py,sha256=WHvW8LWYebmQHcIyzBTx7RE_7vs-vVKEtSIGtoiQu7g,3812
|
|
7
|
+
fleqx/bijectors/_invert.py,sha256=2UT29cWx0qFRMW7JSurcD_nYt15fwe-67ONHUBgPhDk,2243
|
|
8
|
+
fleqx/bijectors/_masked_autoregressive.py,sha256=ivkSMGMsH3g58-PCPH9Dq1yDmG1g48OFKqjqPwXlxK0,4887
|
|
9
|
+
fleqx/bijectors/_masks.py,sha256=PxZ6QVOCj6YSuDWONsojjc3z1FqvAODVci1vxNBxh10,821
|
|
10
|
+
fleqx/bijectors/_permute.py,sha256=4cNbaz4fbVnw9UR3ZN0zwqZDS_T6SLb9hLIro1f6bOc,1889
|
|
11
|
+
fleqx/bijectors/_planar.py,sha256=HE466iWfBEm9I84NPLICVBphczZj1uTPtJrljj5qeHc,3620
|
|
12
|
+
fleqx/train/__init__.py,sha256=PKOv80KWtYiy8MjbjwCbFzSGLJRcAuHI5jqG6S95Xio,150
|
|
13
|
+
fleqx/train/_loops.py,sha256=obj6951wSvAHj_9IV0HZXec9uDKlQZmPJqcBKbRHHaQ,4720
|
|
14
|
+
fleqx/train/_losses.py,sha256=hFvgXFTVNo-_BrFj9wQDn8SIsz01GBn-3w85TyylPwQ,1231
|
|
15
|
+
fleqx/train/_train_utils.py,sha256=WOmWgDGhVMVkB0uR36QwOB1I7VLcPxglj4PQ-6OUbRc,2409
|
|
16
|
+
fleqx-0.0.2.dist-info/licenses/LICENSE,sha256=9z5yyVJQq21eh9ss3dEtU4t_x6Z9cFfE7JXB0-jYUvo,11348
|
|
17
|
+
fleqx-0.0.2.dist-info/METADATA,sha256=egzx0qh7NG6JraA9MObRc_m6dwgM7zIzWK7mJ6QQA3s,2885
|
|
18
|
+
fleqx-0.0.2.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
|
|
19
|
+
fleqx-0.0.2.dist-info/top_level.txt,sha256=OPrd8lMWcMxFUMlAtrWPASjjTfLEFMoWmF6F_xHbLJ0,6
|
|
20
|
+
fleqx-0.0.2.dist-info/RECORD,,
|
|
@@ -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 2026 fleqx contributors
|
|
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.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
fleqx
|