Skip to content

Commit 18f3a6e

Browse files
committed
[no-ci] Some docstrings
1 parent d76ca9f commit 18f3a6e

File tree

3 files changed

+8
-2
lines changed

3 files changed

+8
-2
lines changed

bayesflow/approximators/point_approximator.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,10 @@
1212
@serializable(package="bayesflow.approximators")
1313
class PointApproximator(ContinuousApproximator):
1414
"""
15-
Defines a workflow for performing fast posterior or likelihood inference.
16-
The distribution is approximated by point estimators with a feed-forward network and an optional summary network.
15+
A workflow for fast amortized point estimation of a conditional distribution.
16+
17+
The distribution is approximated by point estimators, parameterized by a feed-forward `PointInferenceNetwork`.
18+
Conditions can be compressed by an optional `SummaryNetwork` or used directly as input to the inference network.
1719
"""
1820

1921
def estimate(

bayesflow/links/ordered.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66

77
@serializable(package="links.ordered")
88
class Ordered(keras.Layer):
9+
"""Activation function to link to a tensor which is monotonously increasing along a specified axis."""
10+
911
def __init__(self, axis: int, anchor_index: int, **kwargs):
1012
super().__init__(**keras_kwargs(kwargs))
1113
self.axis = axis

bayesflow/links/positive_semi_definite.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55

66
class PositiveSemiDefinite(keras.Layer):
7+
"""Activation function to link from any square matrix to a positive semidefinite matrix."""
8+
79
def __init__(self, **kwargs):
810
super().__init__(**keras_kwargs(kwargs))
911

0 commit comments

Comments
 (0)