Skip to content

Commit d2afd05

Browse files
committed
improve doc summaries (first sentence)
1 parent b418cf6 commit d2afd05

File tree

3 files changed

+6
-8
lines changed

3 files changed

+6
-8
lines changed

bayesflow/datasets/__init__.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
"""
22
A collection of `keras.utils.PyDataset <https://keras.io/api/utils/python_utils/#pydataset-class>`__\ s, which
3-
wrap your data-generating process (i.e., your :py:class:`~bayesflow.simulators.Simulator`).
4-
What type of Dataset you use determines the effective training strategy (e.g., online or offline).
3+
wrap your data-generating process (i.e., your :py:class:`~bayesflow.simulators.Simulator`) and thus determine the
4+
effective training strategy (e.g., online or offline).
55
"""
66

77
from .offline_dataset import OfflineDataset

bayesflow/experimental/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
"""
2-
Unstable or largely untested networks. Proceed with caution.
2+
Unstable or largely untested networks, proceed with caution.
33
"""
44

55
from .cif import CIF

bayesflow/simulators/__init__.py

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,7 @@
11
"""
2-
This module provides the :py:class:`~bayesflow.simulators.Simulator`, which is the base implementation of a
3-
generative mathematical model, or data generating process.
4-
Its primary function is to sample data with the :py:meth:`~bayesflow.simulators.Simulator.sample` method.
5-
The module also contains several other kinds of Simulators, as well as the function
6-
:py:func:`~bayesflow.simulators.make_simulator` to facilitate easy implementation.
2+
This module provides :py:class:`~bayesflow.simulators.Simulator`, :py:function:`~bayesflow.simulators.make_simulator`,
3+
and several other kinds of :py:class:`~bayesflow.simulators.Simulator` implementations, which serve as generative
4+
mathematical models, or data generating processes, with their primary function being to sample data.
75
"""
86

97
from .sequential_simulator import SequentialSimulator

0 commit comments

Comments
 (0)