Ensure no warnings and working examples (#1)

* Ensure no warnings and working examples * Move `matplotlib` and `pandas` from extras to required dependencies to avoid warnings when using CMA and ensure that all examples work without issues. * Fix wrong links in `setup.cfg` and `README.md`. * Update description in setup.cfg * Add documentation badge and link to the landing page to README Co-authored-by: Nihat Engin Toklu <[email protected]> Co-authored-by: Timothy Atkinson <[email protected]>
nnaisense · Aug 9, 2022 · fb3c500 · fb3c500
1 parent 1691060
commit fb3c500
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 10 deletions.
diff --git a/.github/workflows/build-docs.yaml → .github/workflows/docs.yaml b/.github/workflows/build-docs.yaml → .github/workflows/docs.yaml
diff --git a/README.md b/README.md
@@ -1,19 +1,24 @@
 <p align="center">
-    <img src="https://raw.githubusercontent.com/nnaisense/evotorch/master/docs/assets/evotorch.svg" />
+    <a href="https://evotorch.ai" rel="nofollow">
+        <img src="https://raw.githubusercontent.com/nnaisense/evotorch/master/docs/assets/evotorch.svg" />
+    </a>
 </p>
 
 <div align="center">
     <a href="https://www.python.org/" rel="nofollow">
         <img src="https://img.shields.io/pypi/pyversions/evotorch" alt="Python" />
     </a>
     <a href="https://pypi.org/project/evotorch/" rel="nofollow">
-        <img src="https://img.shields.io/pypi/v/evotoch" alt="PyPI" />
+        <img src="https://img.shields.io/pypi/v/evotorch" alt="PyPI" />
     </a>
     <a href="https://github.com/nnaisense/evotorch/blob/master/LICENSE" rel="nofollow">
         <img src="https://img.shields.io/pypi/l/evotorch" alt="License" />
     </a>
+    <a href="https://docs.evotorch.ai" rel="nofollow">
+        <img src="https://github.com/nnaisense/evotorch/actions/workflows/docs.yaml/badge.svg" alt="Build" />
+    </a>
     <a href="https://github.com/nnaisense/evotorch/actions/workflows/test.yaml" rel="nofollow">
-        <img src="https://github.com/nnaisense/evotorch/actions/workflows/test.yaml/badge.svg?branch=master&event=push" alt="Test" />
+        <img src="https://github.com/nnaisense/evotorch/actions/workflows/test.yaml/badge.svg" alt="Test" />
     </a>
     <a href="https://github.com/psf/black" rel="nofollow">
         <img src="https://img.shields.io/badge/code%20style-black-000000.svg" alt="Code style: black" />

diff --git a/setup.cfg b/setup.cfg
@@ -3,8 +3,8 @@ name = evotorch
 url = https://evotorch.ai
 project_urls =
     Documentation = https://docs.evotorch.ai
-    Source Code = https://gitub.com/nnaisense/evotorch
-description = EvoTorch is an advanced evolutionary algorithm library built directly on top of PyTorch and developed by the research scientists at NNAISENSE.
+    Source Code = https://github.com/nnaisense/evotorch
+description = EvoTorch is an advanced evolutionary computation library built directly on top of PyTorch, created at NNAISENSE.
 long_description = file: README.md
 long_description_content_type = text/markdown
 license = Apache 2.0
@@ -33,11 +33,13 @@ packages = find:
 tests_require =
     evotorch[test]
 install_requires =
+    cma
+    gym
+    matplotlib
     numpy
-    torch
+    pandas
     ray>=1.0
-    gym
-    cma
+    torch
 
 [options.package_data]
 * = *.txt, *.md, *.rst
@@ -50,13 +52,11 @@ where = src
 logging =
     mlflow
     neptune-client
-    pandas
     sacred
 # Utility packages for running experiments and analyzing results
 all =
     box2d
     pymongo
-    matplotlib
     jupyterlab
     %(logging)s
 # Documentation dependencies