relucent 0.2.0

No project description provided

Relucent

Explore polyhedral complexes associated with the activation states of ReLU neural networks

Environment Setup

1. Install Python 3.13
2. Install PyTorch >= 2.3.0
3. 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())

View the documentation for this library at (https://bl-ake.github.io/relucent/)[https://bl-ake.github.io/relucent/]

Source Code Structure

• model.py: PyTorch Module that acts as an interface between the model and the rest of the code
• poly.py: Class for calculations involving individual polyhedrons (e.g. computing boundaries, neighbors, volume)
• complex.py: Class for calculations involving the polyhedral cplx (e.g. polyhedron search, connectivity graph calculation)
• convert_model.py: Utilities for converting various PyTorch.nn layers to Linear layers
• bvs.py: Data structures for storing large numbers of sign vectors

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:

1. Install the Gurobi Python library, for example using pip install gurobipy
2. 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.)
3. In your Conda environment, run grbgetkey followed by your license key