Merge pull request #381 from bayesflow-org/populate-api-reference-landing-page

Populate API Reference landing page

Author: vpratz

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
 

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

bayesflow/datasets/__init__.py

@@ -1,3 +1,9 @@
+"""
+A collection of `keras.utils.PyDataset <https://keras.io/api/utils/python_utils/#pydataset-class>`__\ 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

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 (

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

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

bayesflow/metrics/__init__.py

@@ -1,3 +1,8 @@
+"""
+A collection of `keras.Metric <https://keras.io/api/metrics/base_metric/#metric-class>`__\ s for evaluating the
+performance of models.
+"""
+
 from . import functional
 from .maximum_mean_discrepancy import MaximumMeanDiscrepancy
 from .root_mean_squard_error import RootMeanSquaredError

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

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

bayesflow/types/__init__.py

@@ -1,5 +1,5 @@
 """
-Custom types.
+Custom types used for type annotations.
 
 .. currentmodule:: bayesflow.types