Skip to content

Commit

Permalink
Small updates to documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
KX79WQ committed Apr 29, 2020
1 parent 9a35133 commit d94d890
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 7 deletions.
5 changes: 3 additions & 2 deletions CHANGES.rst
Expand Up @@ -2,7 +2,8 @@
Release notes
=============

Version 0.3.1, March 2020
Version 0.3.1, April 2020
-------------------------

Released the first open-source version op popmon.
* Released the first open-source version op popmon.
* Please see documentation for full details: https://popmon.readthedocs.io
3 changes: 2 additions & 1 deletion README.rst
Expand Up @@ -5,6 +5,7 @@ Population Shift Monitoring
* Version: 0.3.1. Released: April 2020
* Documentation: https://popmon.readthedocs.io
* Repository: https://github.com/ing-bank/popmon
* Authors: ING Wholesale Banking Advanced Analytics

.. figure:: https://github.com/ing-bank/popmon/blob/master/docs/source/assets/popmon-logo.png
:width: 300px
Expand Down Expand Up @@ -124,4 +125,4 @@ Please note that ING WBAA provides support only on a best-effort basis.

License
=======
`popmon` is completely free, open-source and licensed under the `MIT license <https://en.wikipedia.org/wiki/MIT_License>`_.
Copyright ING WBAA. `popmon` is completely free, open-source and licensed under the `MIT license <https://en.wikipedia.org/wiki/MIT_License>`_.
8 changes: 4 additions & 4 deletions docs/source/tutorials.rst
Expand Up @@ -8,8 +8,8 @@ The tutorials are available in the ``popmon/notebooks`` directory. We have:
* A basic tutorial: this covers generating a stability report from a DataFrame, as well as various simple configurations.
* Incremental data: a tutorial showing how to stitch the histograms of incremental (batch-wise) datasets and to generate reports from those.

You can open these notebooks directly:

* Run them interactively at `MyBinder <https://mybinder.org/v2/gh/ing-bank/popmon/master?filepath=popmon%2Fnotebooks>`_.
* View them statically: `detailed example tutorial <https://nbviewer.jupyter.org/github/ing-bank/popmon/blob/master/popmon/notebooks/popmon_tutorial_advanced.ipynb>`_ and `basic tutorial <https://nbviewer.jupyter.org/github/ing-bank/popmon/blob/master/popmon/notebooks/popmon_tutorial_basic.ipynb>`_ and `incremental datasets <https://nbviewer.jupyter.org/github/ing-bank/popmon/blob/master/popmon/notebooks/popmon_tutorial_incremental_data.ipynb>`_.
You can see these notebooks here:

* `detailed example <https://nbviewer.jupyter.org/github/ing-bank/popmon/blob/master/popmon/notebooks/popmon_tutorial_advanced.ipynb>`_
* `basic tutorial <https://nbviewer.jupyter.org/github/ing-bank/popmon/blob/master/popmon/notebooks/popmon_tutorial_basic.ipynb>`_
* `incremental datasets <https://nbviewer.jupyter.org/github/ing-bank/popmon/blob/master/popmon/notebooks/popmon_tutorial_incremental_data.ipynb>`_.

0 comments on commit d94d890

Please sign in to comment.