Merge pull request #231 from instadeepai/feature/release-prep

Feature/release prep

OPTIONAL_INSTALL.md

@@ -1,5 +1,5 @@
 ### Optional Installs
-1. **Optional**: To install ROM files for Atari-Py using AutoROM (https://github.com/PettingZoo-Team/AutoROM).
+1. **Optional**: To install ROM files for Atari-Py using [AutoROM](https://github.com/PettingZoo-Team/AutoROM).
    ```
    pip install autorom && AutoROM
    ```

README.md

@@ -2,6 +2,8 @@
 
 # Mava: a research framework for distributed multi-agent reinforcement learning
 
+![PyPI Python Version](https://img.shields.io/pypi/pyversions/id-mava)
+![PyPI version](https://badge.fury.io/py/id-mava.svg)
 ![pytest](https://github.com/arnupretorius/mava/workflows/format_and_test/badge.svg)
 
 # Table of Contents
@@ -171,15 +173,33 @@ We have tested `mava` on Python 3.6, 3.7 and 3.8.
     pip install --upgrade pip setuptools
     ```
 
-2.  To install the core libraries with dependencies from source (from root directory):
+2.  To install the core libraries, including [Reverb](https://github.com/deepmind/reverb) - our storage dataset :
 
     ```bash
-    pip install -e ".[tf,envs,reverb,launchpad]"
+    pip install id-mava
+    pip install id-mava[reverb]
     ```
 
-    Note that the dependencies may be installed selectively by adding and removing their identifiers. Additional optional dependencies include `record_episode` for installing packages required to make video recordings of evaluation runs and `testing_formatting` for running tests and code formatting checks. Extra information on optional installs are given below.
+    Or for nightly builds:
+    ```bash
+    pip install id-mava-nightly
+    pip install id-mava-nightly[reverb]
+    ```
 
-3.  **NB**: Flatland and SMAC installations have to be done separately. Flatland can be installed using:
+3. To install dependencies for tensorflow agents:
+    ```bash
+    pip install id-mava[tf]
+    ```
+4. For distributed agent support:
+    ```bash
+    pip install id-mava[launchpad]
+    ```
+
+5. To install example environments, such as [PettingZoo](https://github.com/PettingZoo-Team/PettingZoo):
+    ```bash
+    pip install id-mava[envs]
+    ```
+6.  **NB**: For Flatland and SMAC environments, installations have to be done separately. Flatland can be installed using:
 
     ```bash
     pip install .[flatland]
@@ -194,7 +214,7 @@ We have tested `mava` on Python 3.6, 3.7 and 3.8.
     pip install pysc2
     pip install git+https://github.com/oxwhirl/smac.git
     ```
-3.  For the 2D RoboCup environment, a local install has only been tested using the Ubuntu 18.04 operating system.
+7.  For the 2D RoboCup environment, a local install has only been tested using the Ubuntu 18.04 operating system.
     The installation can be performed by running the RoboCup bash script while inside the Mava
     python virtual environment.
     ```bash

mava/_metadata.py

@@ -20,8 +20,8 @@
 
 # We follow Semantic Versioning (https://semver.org/)
 _MAJOR_VERSION = "0"
-_MINOR_VERSION = "1"
-_PATCH_VERSION = "0"
+_MINOR_VERSION = "0"
+_PATCH_VERSION = "9"
 
 # Example: '0.4.2'
 __version__ = ".".join([_MAJOR_VERSION, _MINOR_VERSION, _PATCH_VERSION])

setup.py

@@ -118,6 +118,7 @@
         "Programming Language :: Python :: 3",
         "Programming Language :: Python :: 3.6",
         "Programming Language :: Python :: 3.7",
+        "Programming Language :: Python :: 3.8",
         "Topic :: Scientific/Engineering :: Artificial Intelligence",
     ],
 )