Skip to content

Commit

Permalink
readme: update
Browse files Browse the repository at this point in the history
  • Loading branch information
mdeff committed Dec 14, 2017
1 parent b4cefed commit bf91eb9
Showing 1 changed file with 42 additions and 33 deletions.
75 changes: 42 additions & 33 deletions README.rst
@@ -1,35 +1,44 @@
=========================================
PyUNLocBoX: convex optimization in Python
=========================================

.. image:: https://readthedocs.org/projects/pyunlocbox/badge/?version=latest
:target: https://pyunlocbox.readthedocs.io/en/latest/

.. image:: https://img.shields.io/travis/epfl-lts2/pyunlocbox.svg
:target: https://travis-ci.org/epfl-lts2/pyunlocbox

.. image:: https://img.shields.io/coveralls/epfl-lts2/pyunlocbox.svg
:target: https://coveralls.io/github/epfl-lts2/pyunlocbox

.. image:: https://img.shields.io/pypi/v/pyunlocbox.svg
:target: https://pypi.python.org/pypi/pyunlocbox

.. image:: https://img.shields.io/pypi/l/pyunlocbox.svg
:target: https://pypi.python.org/pypi/pyunlocbox

.. image:: https://img.shields.io/pypi/pyversions/pyunlocbox.svg
:target: https://pypi.python.org/pypi/pyunlocbox

.. image:: https://img.shields.io/github/stars/epfl-lts2/pyunlocbox.svg?style=social
:target: https://github.com/epfl-lts2/pyunlocbox

The PyUNLocBoX is a convex optimization package based on `proximal splitting
methods <https://en.wikipedia.org/wiki/Proximal_gradient_method>`_ and
implemented in Python (a `Matlab counterpart <https://lts2.epfl.ch/unlocbox>`_
exists). It is a free software, distributed under the BSD license, and
available on `PyPI <https://pypi.python.org/pypi/pyunlocbox>`_. The
documentation is available `online <https://pyunlocbox.readthedocs.io>`_ and
development takes place on `GitHub <https://github.com/epfl-lts2/pyunlocbox>`_.
==============================================
PyUNLocBoX: Optimization by Proximal Splitting
==============================================

+--------------------------------------------------------------------------------------+
| |
| .. image:: https://readthedocs.org/projects/pyunlocbox/badge/?version=latest |
| :target: https://pyunlocbox.readthedocs.io |
| |
| .. image:: https://img.shields.io/pypi/v/pyunlocbox.svg |
| :target: https://pypi.python.org/pypi/pyunlocbox |
| |
| .. image:: https://img.shields.io/pypi/l/pyunlocbox.svg |
| :target: https://github.com/epfl-lts2/pyunlocbox/blob/master/LICENSE.txt |
| |
| .. image:: https://img.shields.io/pypi/pyversions/pyunlocbox.svg |
| :target: https://pypi.python.org/pypi/pyunlocbox |
| |
+--------------------------------------------------------------------------------------+
| |
| .. image:: https://img.shields.io/travis/epfl-lts2/pyunlocbox.svg |
| :target: https://travis-ci.org/epfl-lts2/pyunlocbox |
| |
| .. image:: https://img.shields.io/coveralls/epfl-lts2/pyunlocbox.svg |
| :target: https://coveralls.io/github/epfl-lts2/pyunlocbox |
| |
| .. image:: https://img.shields.io/github/stars/epfl-lts2/pyunlocbox.svg?style=social |
| :target: https://github.com/epfl-lts2/pyunlocbox |
| |
+--------------------------------------------------------------------------------------+

The PyUNLocBoX is a Python package which uses
`proximal splitting methods <https://en.wikipedia.org/wiki/Proximal_gradient_method>`_
to solve non-differentiable convex optimization problems.
It is a free software, distributed under the BSD license, and
available on `PyPI <https://pypi.python.org/pypi/pyunlocbox>`_.
The documentation is available on
`Read the Docs <https://pyunlocbox.readthedocs.io>`_
and development takes place on
`GitHub <https://github.com/epfl-lts2/pyunlocbox>`_.
(A `Matlab counterpart <https://lts2.epfl.ch/unlocbox>`_ exists.)

The package is designed to be easy to use while allowing any advanced tasks. It
is not meant to be a black-box optimization tool. You'll have to carefully
Expand Down Expand Up @@ -81,7 +90,7 @@ array([ 3.99990766, 4.99988458, 5.99986149, 6.99983841])
Installation
------------

The PyUnLocBox is available on PyPI::
The PyUNLocBox is available on PyPI::

$ pip install pyunlocbox

Expand Down

0 comments on commit bf91eb9

Please sign in to comment.