README.rst 1.49 KB
Newer Older
valentin.emiya's avatar
valentin.emiya committed
1
skpomade
valentin.emiya's avatar
fix md    
valentin.emiya committed
2
========
valentin.emiya's avatar
valentin.emiya committed
3

valentin.emiya's avatar
valentin.emiya committed
4
skpomade: PrObabilistic MAtrix DEcompositions from Halko et al., 2011
valentin.emiya's avatar
valentin.emiya committed
5
6
7
8
9
10
11
12
13
14
15
16

Python implementation of algorithms from paper *Finding Structure
with Randomness: Probabilistic Algorithms for Constructing Approximate Matrix
Decompositions*, by N. Halko, P. G. Martinsson and J. A. Tropp, SIAM review,
53 (2), 2011.


Install
-------

Install the current release with ``pip``::

valentin.emiya's avatar
valentin.emiya committed
17
    pip install skpomade
valentin.emiya's avatar
valentin.emiya committed
18
19
20
21
22
23

For additional details, see doc/install.rst.

Usage
-----

valentin.emiya's avatar
valentin.emiya committed
24
See the `documentation <http://valentin.emiya.pages.lis-lab.fr/skpomade/>`_.
valentin.emiya's avatar
valentin.emiya committed
25
26
27
28

Bugs
----

valentin.emiya's avatar
valentin.emiya committed
29
30
Please report any bugs that you find through the `skpomade GitLab project
<https://gitlab.lis-lab.fr/valentin.emiya/skpomade/issues>`_.
valentin.emiya's avatar
valentin.emiya committed
31
32
33
34
35
36

You can also fork the repository and create a merge request.

Source code
-----------

valentin.emiya's avatar
valentin.emiya committed
37
38
The source code of skpomade is available via its `GitLab project
<https://gitlab.lis-lab.fr/valentin.emiya/skpomade>`_.
valentin.emiya's avatar
valentin.emiya committed
39
40
41

You can clone the git repository of the project using the command::

valentin.emiya's avatar
valentin.emiya committed
42
    git clone git@gitlab.lis-lab.fr:valentin.emiya/skpomade.git
valentin.emiya's avatar
valentin.emiya committed
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

Copyright © 2019-2020
---------------------

* `Laboratoire d'Informatique et Systèmes <http://www.lis-lab.fr/>`_
* `Université d'Aix-Marseille <http://www.univ-amu.fr/>`_
* `Centre National de la Recherche Scientifique <http://www.cnrs.fr/>`_
* `Université de Toulon <http://www.univ-tln.fr/>`_

Contributors
------------

* `Valentin Emiya <mailto:valentin.emiya@lis-lab.fr>`_

License
-------

Released under the GNU General Public License version 3 or later
(see `LICENSE.txt`).