Skip to content

Commit 9c24246

Browse files
committed
add simulators docs
1 parent 495c602 commit 9c24246

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

bayesflow/simulators/__init__.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
"""
2+
This module provides the :py:class:`~bayesflow.simulators.Simulator`, which is the base implementation of a generative mathematical model, data generating process.
3+
Its primary function is to sample data with the :py:meth:`~bayesflow.simulators.Simulator.sample` method.
4+
The module also contains several other kinds of Simulators, as well as the function :py:func:`~bayesflow.simulators.make_simulator` to facilitate easy implementation.
5+
"""
16
from .sequential_simulator import SequentialSimulator
27
from .hierarchical_simulator import HierarchicalSimulator
38
from .lambda_simulator import LambdaSimulator

0 commit comments

Comments
 (0)