Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jackaraz committed Jan 29, 2024
1 parent d488707 commit 30ff78a
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/tutorials/gradients.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,9 @@ kernelspec:
# Gradient of a Statistical Model

````{margin}
```{versionadded} 0.1.6
```
```{note}
In previous versions gradient and Hessian was limited to internal computations only.
```
Expand Down
2 changes: 2 additions & 0 deletions src/spey/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -266,6 +266,8 @@ def get_backend_bibtex(name: Text) -> List[Text]:
of the same reference. If backend does not include an arXiv or DOI number
it will return an empty list.
.. versionadded:: 0.1.6
Args:
name (``Text``): backend identifier. This backend refers to different packages
that prescribes likelihood function.
Expand Down
4 changes: 4 additions & 0 deletions src/spey/math.py
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ def value_and_grad(
"""
Retreive function to compute negative log-likelihood and its gradient.
.. versionadded:: 0.1.6
Args:
statistical_model (~spey.StatisticalModel): statistical model to be used.
expected (~spey.ExpectationType): Sets which values the fitting algorithm should focus and
Expand Down Expand Up @@ -61,6 +63,8 @@ def hessian(
{\rm Hessian} = -\frac{\partial^2\mathcal{L}(\theta)}{\partial\theta_i\partial\theta_j}
.. versionadded:: 0.1.6
Args:
statistical_model (~spey.StatisticalModel): statistical model to be used.
expected (~spey.ExpectationType): Sets which values the fitting algorithm should focus and
Expand Down
2 changes: 2 additions & 0 deletions src/spey/system/webutils.py
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,8 @@ def check_updates() -> None:
"""
Check Spey Updates.
.. versionadded:: 0.1.6
Spey always checks updates when initialised. To disable this set the following
Option if using terminal:
Expand Down

0 comments on commit 30ff78a

Please sign in to comment.