Skip to content

Commit 12968ab

Browse files
committed
fix: documentation
1 parent 05beb00 commit 12968ab

File tree

3 files changed

+5
-4
lines changed

3 files changed

+5
-4
lines changed

stonesoup/models/base.py

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -436,8 +436,7 @@ def num_samples(self) -> int:
436436

437437
class LevyModel(Model):
438438
"""
439-
Class to be derived from for Levy models.
440-
For now, we consider only conditionally Gaussian ones
439+
Class to be derived from for conditionally Gaussian Levy models.
441440
"""
442441

443442
driver: Union[ConditionallyGaussianDriver, GaussianDriver] = Property(

stonesoup/models/base_driver.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,9 @@ def characteristic_func():
5151
class ConditionallyGaussianDriver(LevyDriver):
5252
"""Conditional Gaussian Levy noise driver.
5353
54-
Noise samples are generated according to the Levy State-Space Model by Godsill et al.
54+
Noise samples are generated according to the Levy State-Space Model, which are Gaussian
55+
when conditioned on latent variables in the form of jump times and sizes. The
56+
latent variables may be non-Gaussian.
5557
"""
5658

5759
c: np.double = Property(doc="Truncation parameter, expected no. jumps per unit time.")

stonesoup/models/transition/base.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ def covar(self, **kwargs):
145145
class CombinedLevyTransitionModel(TransitionModel, LevyModel):
146146
r"""Combine multiple models into a single model by stacking them.
147147
148-
The assumption is that all models are Gaussian.
148+
The assumption is that all models are conditionally Gaussian Levy.
149149
Time Variant, and Time Invariant models can be combined together.
150150
If any of the models are time variant the keyword argument "time_interval"
151151
must be supplied to all methods

0 commit comments

Comments
 (0)