Configuration

Relucent exposes numeric defaults and tolerances as module-level attributes on relucent.config. Library code reads these values when routines run, so you can tune behavior for your model or hardware without editing source files.

Changing settings

Import the module (or the package namespace) and assign new values:

import relucent
relucent.config.TOL_HALFSPACE_CONTAINMENT = 1e-7
relucent.config.MAX_RADIUS = 500

To set several attributes at once, use relucent.config.update_settings():

from relucent.config import update_settings
update_settings(
    TOL_HALFSPACE_CONTAINMENT=1e-7,
    DEFAULT_SEARCH_BOUND=1e7,
)

update_settings only accepts names listed under relucent.config.__all__ (excluding the helper itself). Unknown keys raise TypeError.

Defaults in function signatures: Parameters documented as “defaults to relucent.config.X” resolve that value when the function runs, not when Python first imports the package. If you pass an argument explicitly, it always overrides the module setting for that call.

Settings reference

The following tables summarize each public setting. Types and defaults match the shipped relucent.config module.

Polyhedron and halfspace geometry

Name	Type	Default	Role
QHULL_MODE	str	"IGNORE"	How Qhull warnings from HalfspaceIntersection are handled: "IGNORE", "WARN_ALL", "HIGH_PRECISION", or "JITTERED" (retry with QJ).
MAX_RADIUS	float	100	Maximum Chebyshev / interior-point search radius when solving with Gurobi.
VERTEX_TRUST_THRESHOLD	float	1e-6	Threshold for trusting vertex positions from HalfspaceIntersection.
TOL_HALFSPACE_CONTAINMENT	float	1e-6	Feasibility tolerance for halfspace containment (\(a^\top x + b \le 0\)) in checks and related geometry.
TOL_DEAD_RELU	float	1e-8	Column norm below which a ReLU is treated as dead.
TOL_SHI_HYPERPLANE	float	1e-6	Hyperplane equality tolerance in SHI computation.
TOL_HALFSPACE_NORMAL	float	1e-12	Norms below this are treated as degenerate halfspace normals.
GUROBI_SHI_BEST_OBJ_STOP / GUROBI_SHI_BEST_BD_STOP	float	1e-6 / -1e-6	Gurobi early-stop tolerances for the SHI MIP models.
TOL_NEARLY_VERTICAL	float	1e-10	2D plotting: halfspace normals with small w[1] are treated as vertical.
DEFAULT_PLOT_BOUND	float	10	Default half-width of the bounding box for polyhedron plotting and bounded vertices when not passed explicitly.
TOL_VERIFY_AB_ATOL	float	1e-6	allclose atol when verifying halfspace (A, b) against network outputs.

Complex search and parallel add

Name	Type	Default	Role
INTERIOR_POINT_RADIUS_SEQUENCE	list[float]	[0.01, 0.1, 1, 10, 100]	Radii tried in order when locating an interior point for a neighbor in get_ip().
DEFAULT_PARALLEL_ADD_BOUND	float	1e8	Default halfspace bound for parallel_add() and parallel_add().
DEFAULT_SEARCH_BOUND	float	1e8	Default halfspace bound for searcher(), hamming_astar(), and matching Complex methods.
ASTAR_BIAS_WEIGHT	float	0.9	Weight on Euclidean-distance bias in the A* heuristic.
PLOT_MARGIN_FACTOR	float	1.1	Axis margin multiplier when deriving plot extent from interior points.
PLOT_DEFAULT_MAXCOORD	float	10	Fallback axis half-extent when no interior points exist (2D complex plots).
DEFAULT_COMPLEX_PLOT_BOUND	float	10000	Default bound for plot_cells() when bound is omitted.

Utilities and visualization

Name	Type	Default	Role
BLOCKING_QUEUE_WAIT_TIMEOUT	float	0.5	Seconds to wait on Condition.wait when polling a BlockingQueue.
PIE_LABEL_DISTANCE	float	0.6	Matplotlib pie labeldistance in pyvis node thumbnails.
MAX_IMAGES_PYVIS	int	3000	Maximum node images generated in data_graph().
MAX_NUM_EXAMPLES_PYVIS	int	3	Examples per node in data_graph.
DEFAULT_PYVIS_SAVE_FILE	str	"./graph.html"	Default output path for the HTML graph.

Model and grid

Name	Type	Default	Role
DEFAULT_GRID_BOUNDS	float	2	Half-width of the default 2D input grid for get_grid() / output_grid().
DEFAULT_GRID_RES	int	100	Points per axis for that grid.

API

relucent.config.update_settings(**kwargs: Any) → None

Set one or more relucent.config attributes.

Keys must be names listed in relucent.config.__all__ (excluding update_settings itself). Values replace the current module-level constants.

Parameters:

**kwargs – NAME=value pairs matching public config attributes.

Raises:

TypeError – If any key is not a known setting name.

Valid keys for update_settings() are the names listed in relucent.config.__all__, except update_settings itself.