Skip to content

Commit

Permalink
Correct README for PyPi [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
grzr authored and ottonemo committed Dec 21, 2017
1 parent 085f258 commit cca761f
Showing 1 changed file with 14 additions and 9 deletions.
23 changes: 14 additions & 9 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
.. image:: https://github.com/dnouri/skorch/blob/master/assets/skorch.svg
:width: 30%
======

------------

|build| |coverage| |docs| |powered|

Expand All @@ -25,13 +26,16 @@ A scikit-learn compatible neural network library that wraps PyTorch.
:scale: 100%
:target: https://github.com/ottogroup/

Resources:
=========
Resources
=========

- `Documentation <https://skorch.readthedocs.io/en/latest/?badge=latest>`_
- `Source Code <https://github.com/dnouri/skorch/>`_

=======
Example
-------
=======

To see a more elaborate example, look `here
<https://github.com/dnouri/skorch/tree/master/notebooks/README.md>`__.
Expand Down Expand Up @@ -111,11 +115,12 @@ With grid search
gs.fit(X, y)
print(gs.best_score_, gs.best_params_)
============
Installation
------------
============

pip installation
~~~~~~~~~~~~~~~~
================

To install with pip, run:

Expand All @@ -126,13 +131,13 @@ To install with pip, run:
We recommend to use a virtual environment for this.

From source
~~~~~~~~~~~
===========

If you would like to use the must recent additions to skorch or
help development, you should install skorch from source.

Using conda
^^^^^^^^^^^
===========

You need a working conda installation. Get the correct miniconda for
your system from `here <https://conda.io/miniconda.html>`__.
Expand Down Expand Up @@ -164,7 +169,7 @@ If you want to help developing, run:
pylint skorch # static code checks
Using pip
^^^^^^^^^
=========

If you just want to use skorch, use:

Expand Down Expand Up @@ -193,7 +198,7 @@ If you want to help developing, run:
pylint skorch # static code checks
PyTorch
~~~~~~~
=======

PyTorch is not covered by the dependencies, since the PyTorch
version you need is dependent on your system. For installation
Expand Down

0 comments on commit cca761f

Please sign in to comment.