Merge pull request #27 from N3PDF/add_summary

Add description to setup.py

README.md

@@ -6,4 +6,10 @@
 
 # evolutionary_keras
 
-This is a Nodal Genetic Algorithm (NGA) implementation for Keras.
+Keras is one of the most widely used Machine Learning frameworks available in the market. It is a high-level API written in Python and that can run on mulitple backends. Their goal is to be able to build and test new model as fast as possible.
+
+Keras models are trained through the usage of optimizers, all of which are Gradient Descent based. This module deals with that shortcoming of Keras implementing several Evolutionary Algorithms on top of Keras while keeping the main philosophy of the project: it must be easy to prototype.
+
+The default project library now provides support for:
+- Nodal Genetical Algorithm (NGA)
+- Covariance Matrix Adaptation Evolution Strategy (CMA-ES)

setup.py

@@ -1,18 +1,29 @@
 from setuptools import setup, find_packages
+from os import path
+
+this_directory = path.abspath(path.dirname(__file__))
+with open(path.join(this_directory, "README.md"), encoding="utf-8") as f:
+    long_description = f.read()
 
 setup(
-        name="evolutionary_keras",
-        version="1.0.0",
-        author = 'S. Carrazza, J. Cruz-Martinez, Roy Stegeman',
-        author_email = 'juan.cruz@mi.infn.it, roy.stegeman@mi.infn.it',
-        url='https://github.com/N3PDF/evolutionary_keras',
-        package_dir={'':'src'},
-        packages=find_packages('src'),
-        install_requires=[
-            'numpy',
-            'keras',
-            'sphinx_rtd_theme',
-            'recommonmark',
-            ],
-        python_requires='>=3.6'
-        )
+    name="evolutionary_keras",
+    version="1.0.1",
+    author="S. Carrazza, J. Cruz-Martinez, Roy Stegeman",
+    author_email="juan.cruz@mi.infn.it, roy.stegeman@mi.infn.it",
+    url="https://github.com/N3PDF/evolutionary_keras",
+    package_dir={"": "src"},
+    packages=find_packages("src"),
+    install_requires=["numpy", "keras", "sphinx_rtd_theme", "recommonmark",],
+    python_requires=">=3.6",
+    descriptions="An evolutionary algorithm implementation for Keras",
+    long_description=long_description,
+    long_description_content_type="text/markdown",
+    classifiers=[
+        "License :: GPL License",
+        "Programming Language :: Python",
+        "Topic :: Scientific/Engineering",
+        "Topic :: Scientific/Engineering :: Physics",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.6",
+    ],
+)