Core API¶
The pyrox._core subpackage owns the Equinox-to-NumPyro bridge that every other subpackage composes on top of.
Public surface¶
Core: Equinox-to-NumPyro bridge primitives.
Public surface:
- :class:
PyroxModule— Equinox module with pyrox_param / pyrox_sample - :class:
PyroxParam— declarative parameter descriptor - :class:
PyroxSample— declarative sample descriptor - :class:
Parameterized— param registry with priors, guides, and modes - :func:
pyrox_method— decorator that activates the per-call context
Parameterized
¶
Bases: PyroxModule
Shared base for modules with priors, constraints, and mode switching.
Subclasses typically declare parameters inside :meth:setup, which is
invoked automatically after __init__ completes. Use
:meth:register_param to declare a parameter, :meth:set_prior to
attach a prior, :meth:autoguide to pick a guide type, and
:meth:set_mode to switch between sampling from the prior and
sampling from the guide.
Per-instance state (params, priors, guides, mode) lives in a
class-level registry keyed by id(self). Cleanup happens via
:mod:weakref.finalize when the instance is collected; call
:meth:_teardown for explicit cleanup.
Source code in src/pyrox/_core/parameterized.py
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 | |
PyroxModule
¶
Bases: Module
Equinox module with NumPyro site registration and per-call caching.
Subclasses register deterministic parameters via :meth:pyrox_param
and random variables via :meth:pyrox_sample. Wrap the method that
drives registration (typically __call__) with :func:pyrox_method
so the per-call _Context is active for the duration of the call.
Without the decorator the cache is inactive and duplicate references to the same site within one trace will hit NumPyro's uniqueness check.
Source code in src/pyrox/_core/pyrox_module.py
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 | |
PyroxParam
¶
Bases: NamedTuple
Lightweight metadata container for a parameter site.
Bundles init value, constraint, and optional event dimension as a
single descriptor. This type is a plain value object — higher-level
APIs that consume it (for example a future declarative registration
helper) live elsewhere; :meth:PyroxModule.pyrox_param takes the
fields individually as keyword arguments.
Attributes:
| Name | Type | Description |
|---|---|---|
init_value |
Any
|
Initial value, lazy callable, or |
constraint |
Any
|
NumPyro constraint on the parameter domain; |
event_dim |
int | None
|
Number of rightmost event dimensions, or |
Source code in src/pyrox/_core/descriptors.py
PyroxSample
dataclass
¶
Lightweight metadata container for a random sample site.
Wraps the prior — either a :class:numpyro.distributions.Distribution
or a callable (self) -> Distribution for dependent priors that
reference other sampled values on the same module. Like
:class:PyroxParam, this is a plain value object; call
:meth:PyroxModule.pyrox_sample with the underlying prior directly.
Source code in src/pyrox/_core/descriptors.py
pyrox_method(fn)
¶
Wrap a method so its body runs inside the module's per-call context.
Apply to __call__ (and any other method that registers pyrox sites)
so the _Context cache is active for the duration of the call. The
cache is cleared when the outermost decorated call returns.
Source code in src/pyrox/_core/pyrox_module.py
PyroxModule¶
pyrox._core.PyroxModule
¶
Bases: Module
Equinox module with NumPyro site registration and per-call caching.
Subclasses register deterministic parameters via :meth:pyrox_param
and random variables via :meth:pyrox_sample. Wrap the method that
drives registration (typically __call__) with :func:pyrox_method
so the per-call _Context is active for the duration of the call.
Without the decorator the cache is inactive and duplicate references to the same site within one trace will hit NumPyro's uniqueness check.
Source code in src/pyrox/_core/pyrox_module.py
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 | |
pyrox_method¶
pyrox._core.pyrox_method(fn)
¶
Wrap a method so its body runs inside the module's per-call context.
Apply to __call__ (and any other method that registers pyrox sites)
so the _Context cache is active for the duration of the call. The
cache is cleared when the outermost decorated call returns.
Source code in src/pyrox/_core/pyrox_module.py
PyroxParam¶
pyrox._core.PyroxParam
¶
Bases: NamedTuple
Lightweight metadata container for a parameter site.
Bundles init value, constraint, and optional event dimension as a
single descriptor. This type is a plain value object — higher-level
APIs that consume it (for example a future declarative registration
helper) live elsewhere; :meth:PyroxModule.pyrox_param takes the
fields individually as keyword arguments.
Attributes:
| Name | Type | Description |
|---|---|---|
init_value |
Any
|
Initial value, lazy callable, or |
constraint |
Any
|
NumPyro constraint on the parameter domain; |
event_dim |
int | None
|
Number of rightmost event dimensions, or |
Source code in src/pyrox/_core/descriptors.py
PyroxSample¶
pyrox._core.PyroxSample
dataclass
¶
Lightweight metadata container for a random sample site.
Wraps the prior — either a :class:numpyro.distributions.Distribution
or a callable (self) -> Distribution for dependent priors that
reference other sampled values on the same module. Like
:class:PyroxParam, this is a plain value object; call
:meth:PyroxModule.pyrox_sample with the underlying prior directly.
Source code in src/pyrox/_core/descriptors.py
Parameterized¶
pyrox._core.Parameterized
¶
Bases: PyroxModule
Shared base for modules with priors, constraints, and mode switching.
Subclasses typically declare parameters inside :meth:setup, which is
invoked automatically after __init__ completes. Use
:meth:register_param to declare a parameter, :meth:set_prior to
attach a prior, :meth:autoguide to pick a guide type, and
:meth:set_mode to switch between sampling from the prior and
sampling from the guide.
Per-instance state (params, priors, guides, mode) lives in a
class-level registry keyed by id(self). Cleanup happens via
:mod:weakref.finalize when the instance is collected; call
:meth:_teardown for explicit cleanup.
Source code in src/pyrox/_core/parameterized.py
57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 | |