From c30ba7cb6e88ae9338334f8e24a87947cea70867 Mon Sep 17 00:00:00 2001 From: Arno Onken Date: Wed, 24 May 2017 12:08:25 +0200 Subject: [PATCH] Add minor documentation changes for first release. --- README.rst | 23 +++++++++++++++-------- docs/source_code.rst | 2 +- docs/usage.rst | 8 ++++---- 3 files changed, 20 insertions(+), 13 deletions(-) diff --git a/README.rst b/README.rst index ae89eb8..c383bc6 100644 --- a/README.rst +++ b/README.rst @@ -56,10 +56,9 @@ Usage ----- Suppose that data are given in a NumPy array ``samples`` with shape ``(n, d)``, -where ``n`` is the number of samples and ``d`` is the number of elements. -First, specify which of the elements are continuous. If, for instance, the -distribution has three elements and the first and last element are continuous -whereas the second element is discrete: +where ``n`` is the number of samples and ``d`` is the number of elements per +sample. First, specify which of the elements are continuous. If, for instance, +the distribution has three elements and the first and last element are continuous whereas the second element is discrete: .. code-block:: python @@ -149,13 +148,21 @@ To manually construct and visualize a simple mixed vine model: This code shows the 2d marginals and 100 samples of a 3d mixed vine. +Source code +----------- + +The source code of the mixedvines package is hosted on +`GitHub +`_. + + References ---------- -.. [ONKEN2016] A. Onken and S. Panzeri (2016). Mixed vine copulas as joint models - of spike counts and local field potentials. In D. D. Lee, M. Sugiyama, - U. V. Luxburg, I. Guyon and R. Garnett, editors, Advances in Neural - Information Processing Systems 29 (NIPS 2016), pages 1325-1333. +.. [ONKEN2016] A. Onken and S. Panzeri (2016). Mixed vine copulas as joint + models of spike counts and local field potentials. In D. D. Lee, + M. Sugiyama, U. V. Luxburg, I. Guyon and R. Garnett, editors, Advances in + Neural Information Processing Systems 29 (NIPS 2016), pages 1325-1333. License diff --git a/docs/source_code.rst b/docs/source_code.rst index b94f85b..7f7a938 100644 --- a/docs/source_code.rst +++ b/docs/source_code.rst @@ -2,6 +2,6 @@ Source code =========== -The source code of the mixedvines package is hosted at +The source code of the mixedvines package is hosted on `GitHub `_. diff --git a/docs/usage.rst b/docs/usage.rst index db9b1a0..604d8d1 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -3,10 +3,10 @@ Usage Suppose that data are given in a NumPy array ``samples`` with shape ``(n, d)``, -where ``n`` is the number of samples and ``d`` is the number of elements. -First, specify which of the elements are continuous. If, for instance, the -distribution has three elements and the first and last element are continuous -whereas the second element is discrete: +where ``n`` is the number of samples and ``d`` is the number of elements per +sample. First, specify which of the elements are continuous. If, for instance, +the distribution has three elements and the first and last element are +continuous whereas the second element is discrete: .. code-block:: python