From 30ff78a3d220a423640921477c7cb093e58d15e0 Mon Sep 17 00:00:00 2001 From: "Jack Y. Araz" Date: Mon, 29 Jan 2024 17:17:04 -0500 Subject: [PATCH] update docs --- docs/tutorials/gradients.md | 3 +++ src/spey/__init__.py | 2 ++ src/spey/math.py | 4 ++++ src/spey/system/webutils.py | 2 ++ 4 files changed, 11 insertions(+) diff --git a/docs/tutorials/gradients.md b/docs/tutorials/gradients.md index 4b11b06..c1e4098 100644 --- a/docs/tutorials/gradients.md +++ b/docs/tutorials/gradients.md @@ -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. ``` diff --git a/src/spey/__init__.py b/src/spey/__init__.py index e835889..7f95c8a 100644 --- a/src/spey/__init__.py +++ b/src/spey/__init__.py @@ -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. diff --git a/src/spey/math.py b/src/spey/math.py index 7eecc87..3d4080e 100644 --- a/src/spey/math.py +++ b/src/spey/math.py @@ -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 @@ -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 diff --git a/src/spey/system/webutils.py b/src/spey/system/webutils.py index 7256b76..b8e7058 100644 --- a/src/spey/system/webutils.py +++ b/src/spey/system/webutils.py @@ -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: