Skip to content

Commit

Permalink
Add minor documentation changes for first release.
Browse files Browse the repository at this point in the history
  • Loading branch information
Arno Onken committed May 24, 2017
1 parent 1839cf7 commit c30ba7c
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 13 deletions.
23 changes: 15 additions & 8 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
<https://github.com/asnelt/mixedvines/>`_.


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
Expand Down
2 changes: 1 addition & 1 deletion docs/source_code.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
<https://github.com/asnelt/mixedvines/>`_.
8 changes: 4 additions & 4 deletions docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit c30ba7c

Please sign in to comment.