Stability Report#

Generated by scripts/generate_stability_report.py. Refreshed at release time as part of the verification gate; what each level promises, and how a promise is withdrawn, is in the deprecation policy.

Each public surface is tagged via @stability and registered at import time. Levels:

Level

Meaning

stable

Locked at 1.0.0 — backwards-incompatible change needs a major bump.

evolving

Settled wire format / signature, additions allowed.

experimental

May break in any minor release. Opt-in only.

deprecated

Scheduled for removal.

provisional (a synonym for evolving) and internal are deprecated since 0.4.0: they still work, and no surface carries them.

API Surface

Stability Level

maddening.api.auth.APIAuth

evolving

maddening.api.auth.is_loopback

evolving

maddening.api.auth.is_routable_peer

evolving

maddening.api.binary_encoder.BinaryStateEncoder

evolving

maddening.api.server.SimulationServer.request_shutdown

evolving

maddening.api.server.origin_is_same_site

evolving

maddening.api.server.warn_if_publicly_bound

evolving

maddening.api.server:GET /surrogate/status/{job_id}

experimental

maddening.api.server:POST /surrogate/activate/{job_id}

experimental

maddening.api.server:POST /surrogate/deactivate/{node_name}

experimental

maddening.api.server:POST /surrogate/train

experimental

maddening.api.server:WS /ws/render

experimental

maddening.api.server:WS /ws/state

experimental

maddening.api.server:WS /ws/state/binary

experimental

maddening.cloud.multigpu.halo_unstructured.UnstructuredPartitionLayout

evolving

maddening.cloud.multigpu.halo_unstructured.build_unstructured_partition

evolving

maddening.cloud.multigpu.halo_unstructured.exchange_traffic

evolving

maddening.cloud.multigpu.halo_unstructured.exchange_unstructured

evolving

maddening.cloud.multigpu.halo_unstructured.gather_value

evolving

maddening.cloud.multigpu.halo_unstructured.partition_value

evolving

maddening.cloud.multigpu.iterative_solver.SharedSolveResult

evolving

maddening.cloud.multigpu.iterative_solver.block_jacobi_preconditioner

evolving

maddening.cloud.multigpu.iterative_solver.jacobi_preconditioner

evolving

maddening.cloud.multigpu.iterative_solver.sharded_cg

stable

maddening.cloud.multigpu.iterative_solver.sharded_gmres

stable

maddening.cloud.multigpu.sharded_node.ShardedPointwiseNode

stable

maddening.cloud.multigpu.sharded_node.ShardedStencilNode

stable

maddening.cloud.multigpu.sharded_node.ShardedStencilNode.invalidate_static_cache

stable

maddening.cloud.multigpu.sharded_unstructured.ShardedUnstructuredNode

stable

maddening.cloud.multigpu.sharded_unstructured.ShardedUnstructuredNode.invalidate_static_cache

stable

maddening.cloud.providers.CloudProvider

evolving

maddening.cloud.resume.download_and_load_state

evolving

maddening.core.compliance.uq.UncertaintySpec

evolving

maddening.core.coupling.grid_mapping.MultilinearGridMapping

experimental

maddening.core.coupling.grid_mapping.multilinear_grid_mapping

experimental

maddening.core.coupling.group.CouplingGroup

evolving

maddening.core.coupling.mapping.StaticLinearMapping

evolving

maddening.core.coupling.mapping.matrix_mapping

evolving

maddening.core.coupling.mapping.nearest_neighbor_mapping

evolving

maddening.core.coupling.mapping.projection_1d_mapping

evolving

maddening.core.coupling.mapping.rbf_mapping

evolving

maddening.core.coupling.mapping.rbf_matrix

evolving

maddening.core.coupling.mapping_registry.register_mapping

experimental

maddening.core.coupling.mapping_spec.MappingSpec

evolving

maddening.core.coupling.mapping_spec.build_mapping

evolving

maddening.core.coupling.mapping_spec.make_point_resolver

evolving

maddening.core.coupling.mapping_spec.point_array_digest

evolving

maddening.core.coupling.sparse_mapping.StaticSparseMapping

experimental

maddening.core.coupling.sparse_mapping.sparse_matrix_mapping

experimental

maddening.core.coupling.sparse_mapping.sparse_nearest_neighbor_mapping

experimental

maddening.core.coupling.sparse_mapping.sparse_projection_1d_mapping

experimental

maddening.core.edge.EdgeSpec

stable

maddening.core.graph_manager.GraphManager

stable

maddening.core.graph_manager.GraphManager.check_params

evolving

maddening.core.graph_manager.GraphManager.constrain

evolving

maddening.core.graph_manager.GraphManager.coupling_report

experimental

maddening.core.graph_manager.GraphManager.format_graph

experimental

maddening.core.graph_manager.GraphManager.matmul_precision

experimental

maddening.core.graph_manager.GraphManager.memory_estimate

experimental

maddening.core.graph_manager.GraphManager.param_spec_overrides

evolving

maddening.core.graph_manager.GraphManager.param_specs

evolving

maddening.core.graph_manager.GraphManager.params_table

experimental

maddening.core.graph_manager.GraphManager.print_coupling_report

experimental

maddening.core.graph_manager.GraphManager.print_graph

experimental

maddening.core.graph_manager.GraphManager.print_graph_diagram

experimental

maddening.core.graph_manager.GraphManager.print_memory_estimate

experimental

maddening.core.graph_manager.GraphManager.print_params_table

experimental

maddening.core.graph_manager.GraphManager.print_state_summary

experimental

maddening.core.graph_manager.GraphManager.set_param_spec

evolving

maddening.core.graph_manager.GraphManager.state_summary

experimental

maddening.core.graph_manager.GraphManager.to_dot

experimental

maddening.core.graph_manager.GraphManager.to_mermaid

experimental

maddening.core.graph_manager.GraphManager.trainable_mask

evolving

maddening.core.graph_manager.GraphManager.unconstrain

evolving

maddening.core.graph_manager.ShardingIssue

evolving

maddening.core.inspection.InspectionTable

experimental

maddening.core.inspection.coupling_report

experimental

maddening.core.inspection.format_graph

experimental

maddening.core.inspection.memory_estimate

experimental

maddening.core.inspection.params_table

experimental

maddening.core.inspection.print_graph

experimental

maddening.core.inspection.print_graph_diagram

experimental

maddening.core.inspection.state_summary

experimental

maddening.core.inspection.to_dot

experimental

maddening.core.inspection.to_mermaid

experimental

maddening.core.node.BoundaryFluxSpec

evolving

maddening.core.node.BoundaryInputSpec

evolving

maddening.core.node.SimulationNode

stable

maddening.core.node.SimulationNode.invalidate_static_cache

stable

maddening.core.node.SimulationNode.param_specs

evolving

maddening.core.node.SimulationNode.static_data_deps

stable

maddening.core.params.ParamSpec

evolving

maddening.core.params.check_bounds

evolving

maddening.core.params.constrain

evolving

maddening.core.params.trainable_mask

evolving

maddening.core.params.unconstrain

evolving

maddening.core.simulation.calibration.calibrate

deprecated

maddening.core.simulation.calibration.tune_coupling_params

deprecated

maddening.core.simulation.checkpoint.download_and_load_state

deprecated

maddening.core.simulation.compile_cache.enable

evolving

maddening.core.simulation.compile_cache.enable_from_env

evolving

maddening.core.simulation.compile_cache.warm_cache

evolving

maddening.core.simulation.profiler.CompileCounts

evolving

maddening.core.simulation.profiler.TraceSummary

evolving

maddening.core.simulation.profiler.compile_counts

evolving

maddening.core.simulation.profiler.count_hlo_ops

evolving

maddening.core.simulation.profiler.count_jaxpr_primitives

evolving

maddening.core.simulation.profiler.profile_graph

evolving

maddening.core.solver_utils.ift_linear_solve

experimental

maddening.core.static_data.StaticArray

stable

maddening.fmi.directional_derivatives.get_directional_derivative

evolving

maddening.fmi.fmu_state.FMUState

evolving

maddening.fmi.fmu_state.deserialize_fmu_state

evolving

maddening.fmi.fmu_state.serialize_fmu_state

evolving

maddening.fmi.model_description.build_model_description

evolving

maddening.fmi.package.build_fmu_binary

evolving

maddening.fmi.package.write_fmu

evolving

maddening.fmi.sidecar.FmuSidecar

evolving

maddening.fmi.sidecar.SidecarConfig

evolving

maddening.fmi.tcp_bridge.FmuTcpBridge

evolving

maddening.info.collect_versions

experimental

maddening.info.show_versions

experimental

maddening.nodes.adaptive.base.AdaptiveNode

evolving

maddening.nodes.adaptive.base.AdaptiveNode.blindness_ratio

deprecated

maddening.nodes.adaptive.base.AdaptiveNode.is_trapped_at

deprecated

maddening.nodes.adaptive.base.AdaptiveNodeBlindnessError

evolving

maddening.nodes.adaptive.base.adaptive_diagnostics_enabled

evolving

maddening.nodes.adaptive.base.set_adaptive_diagnostics

evolving

maddening.nodes.adaptive.wavelet.WaveletAdaptiveNode

experimental

maddening.nodes.adaptive.wavelets.cdd.cdd_select

experimental

maddening.nodes.adaptive.wavelets.cdd.cdd_select_with_iterations

experimental

maddening.nodes.adaptive.wavelets.cdd.rounding_floor

experimental

maddening.nodes.adaptive.wavelets.dirichlet.dirichlet_side

experimental

maddening.nodes.adaptive.wavelets.dirichlet.synthesis_matrix_dirichlet

experimental

maddening.nodes.adaptive.wavelets.operator.WaveletOperator

experimental

maddening.nodes.adaptive.wavelets.operator.assemble_operator

experimental

maddening.nodes.adaptive.wavelets.operator.condition_estimate

experimental

maddening.nodes.adaptive.wavelets.operator.gather_solve

experimental

maddening.nodes.adaptive.wavelets.operator.make_masked_operator

experimental

maddening.nodes.adaptive.wavelets.operator.physical_condition_number

experimental

maddening.nodes.adaptive.wavelets.precond.diagonal_scaling

experimental

maddening.nodes.adaptive.wavelets.transform.analysis

experimental

maddening.nodes.adaptive.wavelets.transform.level_labels

experimental

maddening.nodes.adaptive.wavelets.transform.n_dofs

experimental

maddening.nodes.adaptive.wavelets.transform.side_length

experimental

maddening.nodes.adaptive.wavelets.transform.synthesis

experimental

maddening.nodes.adaptive.wavelets.transform.synthesis_matrix

experimental

maddening.nodes.ball.BallNode

stable

maddening.nodes.health_check.HealthCheckNode

experimental

maddening.nodes.heart_pump.HeartPumpNode

experimental

maddening.nodes.heat.HeatNode

stable

maddening.nodes.lbm.LBMNode

experimental

maddening.nodes.lbm_pipe.LBMPipeNode

experimental

maddening.nodes.rigid_body.RigidBodyNode

experimental

maddening.nodes.rigid_body_2d.RigidBody2DNode

deprecated

maddening.nodes.spring.SpringDamperNode

stable

maddening.nodes.table.TableNode

stable

maddening.serialization.json_codec.decode_non_finite

evolving

maddening.serialization.json_codec.dumps

evolving

maddening.serialization.json_codec.dumps_encoded

evolving

maddening.serialization.json_codec.encode_non_finite

evolving

maddening.serialization.json_codec.loads

evolving

maddening.surrogates.architecture.SurrogateArchitecture

experimental

maddening.surrogates.dataset.DatasetGenerator

experimental

maddening.surrogates.node.SurrogateNode

experimental

maddening.surrogates.training.trainer.SurrogateTrainer

experimental

maddening.sysid.FIMCore

experimental

maddening.sysid.FIMReport

evolving

maddening.sysid.FitResult

evolving

maddening.sysid.fim

evolving

maddening.sysid.fim_core

experimental

maddening.sysid.fit

evolving

maddening.sysid.fit_lm

evolving

maddening.sysid.fit_multiple_shooting

evolving

maddening.sysid.init_window_states

evolving

maddening.sysid.observations_from_history

evolving

maddening.sysid.windowed_loss

evolving

maddening.testing.coupled.IterationErrorBound

experimental

maddening.testing.coupled.assert_graph_gci_verified

experimental

maddening.testing.coupled.assert_graph_order_verified

experimental

maddening.testing.coupled.coupling_iteration_bound

experimental

maddening.testing.coupled.verify_graph_gci

experimental

maddening.testing.coupled.verify_graph_order

experimental

maddening.testing.mapping.assert_mapping_verified

experimental

maddening.testing.mapping.verify_mapping

experimental

maddening.testing.mms.ApparentOrder

experimental

maddening.testing.mms.ConvergenceRegime

experimental

maddening.testing.mms.GridConvergenceStudy

experimental

maddening.testing.mms.InconclusiveStudyError

experimental

maddening.testing.mms.ManufacturedSolution

experimental

maddening.testing.mms.OrderMeasurement

experimental

maddening.testing.mms.RefinementAxis

experimental

maddening.testing.mms.UndeclaredOrderError

experimental

maddening.testing.mms.apparent_order

experimental

maddening.testing.mms.assert_node_gci_verified

experimental

maddening.testing.mms.assert_node_order_verified

experimental

maddening.testing.mms.check_gci

experimental

maddening.testing.mms.check_order

experimental

maddening.testing.mms.declared_order

experimental

maddening.testing.mms.diffusion_operator

experimental

maddening.testing.mms.manufactured_acceleration

experimental

maddening.testing.mms.measure_gci

experimental

maddening.testing.mms.measure_order

experimental

maddening.testing.mms.richardson_study

experimental

maddening.testing.mms.verify_node_gci

experimental

maddening.testing.mms.verify_node_order

experimental

maddening.testing.strategies.boundary_inputs_for

experimental

maddening.testing.strategies.bounded_dt

experimental

maddening.testing.strategies.node_states

experimental

maddening.testing.verification.VerificationResult

experimental

maddening.testing.verification.assert_node_verified

experimental

maddening.testing.verification.make_inputs

experimental

maddening.testing.verification.verify_node

experimental

maddening.transport_auth.TransportAuth

evolving

maddening.transport_auth.TransportAuthError

evolving

maddening.transport_auth.address_is_loopback

evolving

maddening.transport_auth.address_requires_security

evolving

maddening.transport_auth.resolve_security

evolving

maddening.usd.live_stage.LiveStage

evolving

maddening.viz.relay.StateRelay

experimental

220 API surfaces registered.