Skip to content

Commit

Permalink
fixed readme formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
Jonas Rauber committed Feb 14, 2020
1 parent 6669463 commit 73aeac0
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.. raw:: html

<a href="https://jonasrauber.github.io/eagerpy/"><img src="https://raw.githubusercontent.com/jonasrauber/eagerpy/master/docs/.vuepress/public/logo_small.png" align="right" /></a>

.. image:: https://badge.fury.io/py/eagerpy.svg
Expand All @@ -20,29 +21,29 @@ EagerPy is **also great when you work with just one framework** but prefer a cle


🔥 Design goals
--------------
----------------

- **Native Performance**: EagerPy operations get directly translated into the corresponding native operations.
- **Fully Chainable**: All functionality is available as methods on the tensor objects and as EagerPy functions.
- **Type Checking**: Catch bugs before running your code thanks to EagerPy's extensive type annotations.


📖 Documentation
---------------
-----------------

Learn more about in the `documentation <https://jonasrauber.github.io/eagerpy/>`_.


🚀 Quickstart
------------
--------------

.. code-block:: bash
pip install eagerpy
🎉 Example
---------
-----------

.. code-block:: python
Expand Down Expand Up @@ -88,7 +89,7 @@ Learn more about in the `documentation <https://jonasrauber.github.io/eagerpy/>`
🗺 Use cases
-----------
------------

`Foolbox Native <https://github.com/bethgelab/foolbox>`_, the latest version of
Foolbox, a popular adversarial attacks library, has been rewritten from scratch
Expand All @@ -97,7 +98,7 @@ developed in PyTorch, TensorFlow and JAX, all with one code base.


🐍 Compatibility
---------------
-----------------

We currently test with the following versions:

Expand Down

0 comments on commit 73aeac0

Please sign in to comment.