Skip to content

Commit

Permalink
edited markdown for clarity and notational consistency
Browse files Browse the repository at this point in the history
  • Loading branch information
connor-krill committed Aug 16, 2023
1 parent b74b418 commit 770256b
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 6 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@
# With everything defined we are ready to run the inverse first-order reliability method and print the results.
# The solution to this problem given by Du is :math:`\textbf{U}^*=(1.7367, 0.16376)` with a reliability index of
# :math:`\beta_{HL}=||\textbf{U}^*||=1.7444` and probability of failure of
# :math:`p_{fail} = \Phi(-\beta_{HL})=\Phi(-1.7444)=0.04054`. We expect this problem to converge in 4 iterations.
# :math:`p_{fail} = \Phi(-\beta_{HL})=0.04054`. We expect this problem to converge in 4 iterations.
# We confirm our design point matches this length, and therefore has a probability of failure specified by our input.

# %%
Expand Down
13 changes: 8 additions & 5 deletions docs/source/reliability/inverse_form.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@ The feasibility criteria :math:`||\textbf{U}||=\beta` may be equivalently define
:math:`\beta = -\Phi^{-1}(p_{fail})`, where :math:`\Phi^{-1}(\cdot)` is the inverse standard normal CDF.

Algorithm
-----------------
---------
This method implements a gradient descent algorithm to solve the optimization problem within the tolerances specified by
:math:`\text{tolerance}_{\textbf{U}}` (:code:`tolerance_u`) and :math:`\text{tolerance}_{\nabla G(\textbf{U})}` (:code:`tolerance_gradient`).
:code:`tolerance_u` and :code:`tolerance_gradient`.

0. Define :math:`u_0` and :math:`\beta` directly or :math:`\beta=-\Phi^{-1}(p_\text{fail})`
1. Set :math:`u=u_0` and :math:`\text{converged}=False`
Expand All @@ -50,12 +50,14 @@ The :class:`.InverseFORM` class is imported using the following command:
>>> from UQpy.reliability.taylor_series import InverseFORM

Methods
-----------------
-------

.. autoclass:: UQpy.reliability.taylor_series.InverseFORM
:members: run

Attributes
-----------------
----------

.. autoattribute:: UQpy.reliability.taylor_series.InverseFORM.alpha
.. autoattribute:: UQpy.reliability.taylor_series.InverseFORM.alpha_record
.. autoattribute:: UQpy.reliability.taylor_series.InverseFORM.beta
Expand All @@ -68,7 +70,8 @@ Attributes


Examples
""""""""""
--------

.. toctree::

InverseFORM Examples <../auto_examples/reliability/inverse_form/index>

0 comments on commit 770256b

Please sign in to comment.