diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 9549fed..a225383 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -2,7 +2,7 @@ Changelog ========= v1.8.0 () ----------------------- +--------- - Added acceptance rate display feature when calling chain statistics - User can specify `skip` or `maxpoints` in pairwise correlation and chain panel plots in order to thin chain. - User can request item definitions when calling `chainstats`. @@ -21,7 +21,7 @@ v1.7.0 (April 5, 2019) - Added original covariance matrix to results structure for reference. v1.6.0 (August 31, 2018) ----------------------- +------------------------ .. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.1407136.svg :target: https://doi.org/10.5281/zenodo.1407136 diff --git a/README.rst b/README.rst index 38e2b0f..bfad7cc 100644 --- a/README.rst +++ b/README.rst @@ -37,11 +37,8 @@ Getting Started - `Tutorial notebooks `_ - `Documentation `_ -- `Release history`_ -- `Contributing guidelines`_ - -.. _Release history: CHANGELOG.rst -.. _Contributing guidelines: CONTRIBUTING.rst +- `Release history `_ +- `Contributing guidelines `_ License ======= diff --git a/pymcmcstat/samplers/utilities.py b/pymcmcstat/samplers/utilities.py index 63aba11..45fd0aa 100644 --- a/pymcmcstat/samplers/utilities.py +++ b/pymcmcstat/samplers/utilities.py @@ -105,6 +105,7 @@ def set_outside_bounds(next_set): def posterior_ratio_acceptance_test(alpha): ''' Run posterior ratio acceptance test + Args: * **alpha** (:py:class:`float`): Posterior ratio Returns: @@ -120,6 +121,7 @@ def posterior_ratio_acceptance_test(alpha): def log_posterior_ratio_acceptance_test(alpha): ''' Run log posterior ratio acceptance test + Args: * **alpha** (:py:class:`float`): Log posterior ratio Returns: @@ -149,7 +151,7 @@ def calculate_log_posterior_ratio(loglikestar, loglike, .. note:: The default behavior of the package is to use Gaussian - likelihood and prior functions (as of v1.7.0). Future releases + likelihood and prior functions (as of v1.8.0). Future releases will expand the functionality to allow for alternative likelihood and prior definitions.