Explore the polyhedral complexes of ReLU neural networks.
Project description
Relucent
Explore the polyhedral complexes of ReLU neural networks
This package differs from existing software (for example, check out the amazing SplineCam by Ahmed Imtiaz Humayun) because it avoids computing vertices of the complex. This tradeoff changes which computations are efficient, in particular speeding up local search of the complex in higher dimensions.
If you run into any problems or have any feature requests, please create an issue on the project's Github.
Environment Setup
- Install Python 3.13
- Install PyTorch
- Run
pip install relucent
Getting Started
To see if the installation has been successful, try plotting the complex of a randomly initialized network in 2 dimensions like this:
from relucent import Complex, get_mlp_model
network = get_mlp_model(widths=[2, 10, 5, 1])
cplx = Complex(network)
cplx.bfs()
fig = cplx.plot(bound=10000)
fig.show()
The "NN" object returned by get_mlp_model inherits from torch.nn.Module, so you can train and manipulate it just like you're used to :)
Given some input point, you could get a minimal H-representation of the polyhedron containing it like this:
import numpy as np
input_point = np.random.random(network.input_shape)
p = cplx.point2poly(input_point)
print(p.halfspaces[p.shis, :])
You could also check the average number of faces of all polyhedrons with:
sum(len(p.shis) for p in cplx) / len(cplx)
Or, get the adjacency graph of top-dimensional cells in the complex as a NetworkX Graph with:
print(cplx.get_dual_graph())
You can view the full documentation for this library at https://bl-ake.github.io/relucent/
Obtaining a Gurobi License
Without a license, Gurobi will only work with a limited feature set. This includes a limit on the number of decision variables in the models it can solve, which limits the size of the networks this code is able to analyze. There are multiple ways to install the software, but we recommend the following steps to those eligible for an academic license:
- Install the Gurobi Python library, for example using
pip install gurobipy - Obtain a Gurobi license (Note: a WLS license will limit the number of concurrent sessions across multiple devices, which can result in slowdowns when using this library on different machines simultaneously.)
- In your Conda environment, run
grbgetkeyfollowed by your license key
Bibliography
This package was made possible by the following works:
- Fukuda, K. (2004, August 26). Frequently Asked Questions in Polyhedral Computation. https://people.inf.ethz.ch/~fukudak/polyfaq/
- Grigsby, J. E., & Lindsey, K. (2022). On Transversality of Bent Hyperplane Arrangements and the Topological Expressiveness of ReLU Neural Networks. SIAM Journal on Applied Algebra and Geometry, 6(2), 216–242. https://doi.org/10.1137/20M1368902
- Liu, Y., Caglar, T., Peterson, C., & Kirby, M. (2023). Integrating geometries of ReLU feedforward neural networks. Frontiers in Big Data, 6, 1274831. https://doi.org/10.3389/fdata.2023.1274831
- Masden, M. (2025). Algorithmic Determination of the Combinatorial Structure of the Linear Regions of ReLU Neural Networks. SIAM Journal on Applied Algebra and Geometry, 9(2), 374–404. https://doi.org/10.1137/24M1646996
- Xu, S., Vaughan, J., Chen, J., Zhang, A., & Sudjianto, A. (2022). Traversing the Local Polytopes of ReLU Neural Networks. The AAAI-22 Workshop on Adversarial Machine Learning and Beyond. https://openreview.net/forum?id=EQjwT2-Vaba
- Yajing Liu, Christina M Cole, Chris Peterson, & Michael Kirby. (2023). ReLU Neural Networks, Polyhedral Decompositions, and Persistent Homolog. TAG-ML.
- Zhang, X., & Wu, D. (2019, September 25). Empirical Studies on the Properties of Linear Regions in Deep Neural Networks. International Conference on Learning Representations. https://openreview.net/forum?id=SkeFl1HKwr
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file relucent-0.4.1.tar.gz.
File metadata
- Download URL: relucent-0.4.1.tar.gz
- Upload date:
- Size: 36.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
afadbda34ea52d0b4b3a97895f5fbf4e0675cb236ac989ea027a7ac7c6610388
|
|
| MD5 |
7f1fe9c8f099b9e398fdfbbe236e1731
|
|
| BLAKE2b-256 |
add46f16a61582e40dbe9fad1a7048ca46937af252c4ce3f50cdd22500ca182d
|
Provenance
The following attestation bundles were made for relucent-0.4.1.tar.gz:
Publisher:
publish.yml on bl-ake/relucent
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
relucent-0.4.1.tar.gz -
Subject digest:
afadbda34ea52d0b4b3a97895f5fbf4e0675cb236ac989ea027a7ac7c6610388 - Sigstore transparency entry: 907267381
- Sigstore integration time:
-
Permalink:
bl-ake/relucent@b8e32dbdd2cf4bac3e3c1e664629f7050c2a32c6 -
Branch / Tag:
refs/tags/v0.4.1 - Owner: https://github.com/bl-ake
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@b8e32dbdd2cf4bac3e3c1e664629f7050c2a32c6 -
Trigger Event:
release
-
Statement type:
File details
Details for the file relucent-0.4.1-py3-none-any.whl.
File metadata
- Download URL: relucent-0.4.1-py3-none-any.whl
- Upload date:
- Size: 39.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b7644b12d3d7d2150543b74c25b1ab44a207105e07b3ef587e7d05e450c959b8
|
|
| MD5 |
d39d3aa4fa3247dca2e15cbf90941381
|
|
| BLAKE2b-256 |
0ab2d85efc9709c95e7a72163e7e55f74457dd75d6b27a96ddf454f380478158
|
Provenance
The following attestation bundles were made for relucent-0.4.1-py3-none-any.whl:
Publisher:
publish.yml on bl-ake/relucent
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
relucent-0.4.1-py3-none-any.whl -
Subject digest:
b7644b12d3d7d2150543b74c25b1ab44a207105e07b3ef587e7d05e450c959b8 - Sigstore transparency entry: 907267398
- Sigstore integration time:
-
Permalink:
bl-ake/relucent@b8e32dbdd2cf4bac3e3c1e664629f7050c2a32c6 -
Branch / Tag:
refs/tags/v0.4.1 - Owner: https://github.com/bl-ake
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@b8e32dbdd2cf4bac3e3c1e664629f7050c2a32c6 -
Trigger Event:
release
-
Statement type: