Skip to content

Commit

Permalink
fixed documentation formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
connor-krill committed Sep 10, 2024
1 parent 3d1b0f8 commit 2641ca2
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions src/UQpy/scientific_machine_learning/baseclass/NeuralNetwork.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,8 @@ def count_parameters(self):
def sample(self, mode: bool = True):
"""Set sampling mode.
Note: This method and ``self.sampling`` only affects UQpy's Bayesian layers
.. note::
This method and ``self.sampling`` only affects UQpy's Bayesian layers
:param mode: If ``True`` sample from distributions, otherwise use distribution means.
:return: ``self``
Expand All @@ -54,7 +55,8 @@ def __set_sampling(self, m):
def drop(self, mode: bool = True):
"""Set dropping mode.
Note: This method and ``self.dropping`` only affects UQpy's dropout layers
.. note::
This method and ``self.dropping`` only affects UQpy's dropout layers
:param mode: If ``True`` perform dropout, otherwise act as the identity function.
"""
Expand All @@ -70,8 +72,9 @@ def __set_dropping(self, m):
def is_deterministic(self) -> bool:
"""Check if neural network is behaving deterministically or probabilistically.
Note: This flag may be incorrect if the model has sources of randomness that do not depend on
``training``, ``dropping``, or ``sampling``.
.. note::
This flag may be incorrect if the model has sources of randomness that do not depend on the attributes
``training``, ``dropping``, or ``sampling``.
:return: ``True`` if ``sampling``, ``dropping``, and ``training`` are all ``False``.
Otherwise, returns ``False``.
Expand Down

0 comments on commit 2641ca2

Please sign in to comment.