diff --git a/bayesflow/adapters/__init__.py b/bayesflow/adapters/__init__.py index 1fbd0d81a..bb6c60b37 100644 --- a/bayesflow/adapters/__init__.py +++ b/bayesflow/adapters/__init__.py @@ -1,3 +1,8 @@ +""" +A collection of :py:class:`~bayesflow.adapters.Adapter` transforms, which tell BayesFlow how to interpret your +:py:class:`~bayesflow.simulators.Simulator` output and plug it into neural networks for training and inference. +""" + from . import transforms from .adapter import Adapter diff --git a/bayesflow/approximators/__init__.py b/bayesflow/approximators/__init__.py index 737336dc0..41099a8d1 100644 --- a/bayesflow/approximators/__init__.py +++ b/bayesflow/approximators/__init__.py @@ -1,3 +1,8 @@ +""" +A collection of :py:class:`~bayesflow.approximators.Approximator`\ s, which embody the inference task and the +neural network components used to perform it. +""" + from .approximator import Approximator from .continuous_approximator import ContinuousApproximator from .point_approximator import PointApproximator diff --git a/bayesflow/datasets/__init__.py b/bayesflow/datasets/__init__.py index b540c0c65..2f4d21a69 100644 --- a/bayesflow/datasets/__init__.py +++ b/bayesflow/datasets/__init__.py @@ -1,3 +1,9 @@ +""" +A collection of `keras.utils.PyDataset `__\ s, which +wrap your data-generating process (i.e., your :py:class:`~bayesflow.simulators.Simulator`) and thus determine the +effective training strategy (e.g., online or offline). +""" + from .offline_dataset import OfflineDataset from .online_dataset import OnlineDataset from .disk_dataset import DiskDataset diff --git a/bayesflow/diagnostics/__init__.py b/bayesflow/diagnostics/__init__.py index c0e0efc6d..1e13e11f2 100644 --- a/bayesflow/diagnostics/__init__.py +++ b/bayesflow/diagnostics/__init__.py @@ -1,3 +1,7 @@ +""" +A collection of plotting utilities and metrics for evaluating trained :py:class:`~bayesflow.workflows.Workflow`\ s. +""" + from .metrics import root_mean_squared_error, calibration_error, posterior_contraction from .plots import ( diff --git a/bayesflow/distributions/__init__.py b/bayesflow/distributions/__init__.py index afe63b3a0..d56bd00fd 100644 --- a/bayesflow/distributions/__init__.py +++ b/bayesflow/distributions/__init__.py @@ -1,3 +1,9 @@ +""" +A collection of :py:class:`~bayesflow.distributions.Distribution`\ s, +which represent the latent space for :py:class:`~bayesflow.networks.InferenceNetwork`\ s +or the summary space of :py:class:`~bayesflow.networks.SummaryNetwork`\ s. +""" + from .distribution import Distribution from .diagonal_normal import DiagonalNormal from .diagonal_student_t import DiagonalStudentT diff --git a/bayesflow/experimental/__init__.py b/bayesflow/experimental/__init__.py index 8364aab92..4c6f80848 100644 --- a/bayesflow/experimental/__init__.py +++ b/bayesflow/experimental/__init__.py @@ -1,3 +1,7 @@ +""" +Unstable or largely untested networks, proceed with caution. +""" + from .cif import CIF from .continuous_time_consistency_model import ContinuousTimeConsistencyModel from .free_form_flow import FreeFormFlow diff --git a/bayesflow/metrics/__init__.py b/bayesflow/metrics/__init__.py index 41954ab02..81c37bc40 100644 --- a/bayesflow/metrics/__init__.py +++ b/bayesflow/metrics/__init__.py @@ -1,3 +1,8 @@ +""" +A collection of `keras.Metric `__\ s for evaluating the +performance of models. +""" + from . import functional from .maximum_mean_discrepancy import MaximumMeanDiscrepancy from .root_mean_squard_error import RootMeanSquaredError diff --git a/bayesflow/networks/__init__.py b/bayesflow/networks/__init__.py index 573351e1d..aba5ddc27 100644 --- a/bayesflow/networks/__init__.py +++ b/bayesflow/networks/__init__.py @@ -1,3 +1,7 @@ +""" +A rich collection of neural network architectures for use in :py:class:`~bayesflow.approximators.Approximator`\ s. +""" + from .consistency_models import ConsistencyModel from .coupling_flow import CouplingFlow from .deep_set import DeepSet diff --git a/bayesflow/simulators/__init__.py b/bayesflow/simulators/__init__.py index a9eee4fa7..3b4c40050 100644 --- a/bayesflow/simulators/__init__.py +++ b/bayesflow/simulators/__init__.py @@ -1,3 +1,9 @@ +""" +This module provides :py:class:`~bayesflow.simulators.Simulator`, :py:function:`~bayesflow.simulators.make_simulator`, +and several other kinds of :py:class:`~bayesflow.simulators.Simulator` implementations, which serve as generative +mathematical models, or data generating processes, with their primary function being to sample data. +""" + from .sequential_simulator import SequentialSimulator from .hierarchical_simulator import HierarchicalSimulator from .lambda_simulator import LambdaSimulator diff --git a/bayesflow/types/__init__.py b/bayesflow/types/__init__.py index 49398163e..881956bfc 100644 --- a/bayesflow/types/__init__.py +++ b/bayesflow/types/__init__.py @@ -1,5 +1,5 @@ """ -Custom types. +Custom types used for type annotations. .. currentmodule:: bayesflow.types diff --git a/bayesflow/utils/__init__.py b/bayesflow/utils/__init__.py index ecb546eae..3f5e4acbc 100644 --- a/bayesflow/utils/__init__.py +++ b/bayesflow/utils/__init__.py @@ -1,3 +1,7 @@ +""" +A collection of utility functions, mostly used for internal purposes. +""" + from . import ( keras_utils, logging, diff --git a/bayesflow/workflows/__init__.py b/bayesflow/workflows/__init__.py index 63fc49c9c..f50c7b1b6 100644 --- a/bayesflow/workflows/__init__.py +++ b/bayesflow/workflows/__init__.py @@ -1,3 +1,8 @@ +""" +Provides :py:class:`~bayesflow.workflows.BasicWorkflow`, a high-level interface for working on typical BayesFlow +applications without having to worry about the internals. +""" + from .basic_workflow import BasicWorkflow from ..utils._docs import _add_imports_to_all