Update readme, add setup.cfg and bump version (pytorch#188)

* Update readme, add setup.cfg and bump version * Update docs URL * Update README and add side-by-side compare image * Replace image with dark theme * Update package name: ignite -> pytorch-ignite
cajanond · Jun 15, 2018 · a146516 · a146516
1 parent 022f04a
commit a146516
Show file tree

Hide file tree

Showing 5 changed files with 34 additions and 5 deletions.
diff --git a/README.rst b/README.rst
@@ -10,22 +10,46 @@ Ignite
 
 Ignite is a high-level library to help with training neural networks in PyTorch.
 
-*Note: Ignite is currently in alpha, and the API is subject to change. A first release coming soon, where we will stabilize the API. Stay tuned.*
+- ignite helps you write compact but full-featured training loops in a few lines of code
+- you get a training loop with metrics, early-stopping, model checkpointing and other features without the boilerplate
+
+Below we show a side-by-side comparison of using pure pytorch and using ignite to create a training loop
+to train and validate your model with occasional checkpointing:
+
+.. image:: assets/ignite_vs_bare_pytorch.png
+
+As you can see, the code is more concise and readable with ignite. Furthermore, adding additional metrics, or
+things like early stopping is a breeze in ignite, but can start to rapidly increase the complexity of
+your code when "rolling your own" training loop.
+
 
 Installation
 ============
 
+From pip:
+
+.. code:: bash
+
+    pip install pytorch-ignite
+
+
+From conda:
+
+.. code:: bash
+
+    conda install pytorch-ignite -c pytorch
+
+
 From source:
 
 .. code:: bash
 
     python setup.py install
 
-*Anaconda & pip coming soon*
 
 Documentation
 =============
-API documentation and an overview of the library coming soon.
+API documentation and an overview of the library can be found `here <https://pytorch.org/ignite/index.html>`_.
 
 Examples
 ========

diff --git a/assets/ignite_vs_bare_pytorch.png b/assets/ignite_vs_bare_pytorch.png
diff --git a/ignite/__init__.py b/ignite/__init__.py
@@ -1,4 +1,4 @@
 import ignite.engine
 import ignite.handlers
 
-__version__ = '0.1.0a1'
+__version__ = '0.1.0'
diff --git a/setup.cfg b/setup.cfg
@@ -0,0 +1,5 @@
+[bdist_wheel]
+universal=1
+
+[metadata]
+license_file = LICENSE
diff --git a/setup.py b/setup.py
@@ -26,7 +26,7 @@ def find_version(*file_paths):
 
 setup(
     # Metadata
-    name='ignite',
+    name='pytorch-ignite',
     version=VERSION,
     author='PyTorch Core Team',
     author_email='soumith@pytorch.org',