Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Debug docs #64

Merged
merged 4 commits into from
Jun 14, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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`.
Expand All @@ -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

Expand Down
7 changes: 2 additions & 5 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,8 @@ Getting Started

- `Tutorial notebooks <https://nbviewer.jupyter.org/github/prmiles/notebooks/tree/master/pymcmcstat/index.ipynb>`_
- `Documentation <http://pymcmcstat.readthedocs.io/>`_
- `Release history`_
- `Contributing guidelines`_

.. _Release history: CHANGELOG.rst
.. _Contributing guidelines: CONTRIBUTING.rst
- `Release history <https://github.com/prmiles/pymcmcstat/blob/master/CHANGELOG.rst>`_
- `Contributing guidelines <https://github.com/prmiles/pymcmcstat/blob/master/CONTRIBUTING.rst>`_

License
=======
Expand Down
4 changes: 3 additions & 1 deletion pymcmcstat/samplers/utilities.py
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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:
Expand Down Expand Up @@ -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.

Expand Down