From e8b24283ba24b105f085a3712f7d4bb70d2c7783 Mon Sep 17 00:00:00 2001 From: Kale-ab Date: Wed, 9 Jun 2021 12:14:15 +0200 Subject: [PATCH 1/3] chore(release): Minor changes for release. --- OPTIONAL_INSTALL.md | 2 +- mava/_metadata.py | 4 ++-- setup.py | 1 + 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/OPTIONAL_INSTALL.md b/OPTIONAL_INSTALL.md index 0c4e683e6..8498e3d02 100644 --- a/OPTIONAL_INSTALL.md +++ b/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 ``` diff --git a/mava/_metadata.py b/mava/_metadata.py index 3bb2d01a1..478f3bdda 100644 --- a/mava/_metadata.py +++ b/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 = "1" # Example: '0.4.2' __version__ = ".".join([_MAJOR_VERSION, _MINOR_VERSION, _PATCH_VERSION]) diff --git a/setup.py b/setup.py index c1179617e..3f549a820 100644 --- a/setup.py +++ b/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", ], ) From a71af7ae3a44121309ee10bd37bff6b85142c4a2 Mon Sep 17 00:00:00 2001 From: Kale-ab Date: Wed, 9 Jun 2021 12:20:19 +0200 Subject: [PATCH 2/3] docs: Updated readme to split core dependencies and non-core dependencies. --- README.md | 22 +++++++++++++++++----- 1 file changed, 17 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index e4fda76bb..3b9bcdab5 100644 --- a/README.md +++ b/README.md @@ -171,15 +171,27 @@ 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. +3. To install dependencies for tensorflow agents: + ```bash + pip install id-mava[tf] + ``` +4. For distributed agent support: + ```bash + pip install id-mava[launchpad] + ``` -3. **NB**: Flatland and SMAC installations have to be done separately. Flatland can be installed using: +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 +206,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 From 4b368329e90b7f86b5c8884dfcb4a6884c7cf022 Mon Sep 17 00:00:00 2001 From: Kale-ab Date: Wed, 9 Jun 2021 13:03:06 +0200 Subject: [PATCH 3/3] docs: Updated docs to include package information. --- README.md | 8 ++++++++ mava/_metadata.py | 2 +- 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3b9bcdab5..0abe75606 100644 --- a/README.md +++ b/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 @@ -178,6 +180,12 @@ We have tested `mava` on Python 3.6, 3.7 and 3.8. pip install id-mava[reverb] ``` + Or for nightly builds: + ```bash + pip install id-mava-nightly + pip install id-mava-nightly[reverb] + ``` + 3. To install dependencies for tensorflow agents: ```bash pip install id-mava[tf] diff --git a/mava/_metadata.py b/mava/_metadata.py index 478f3bdda..4500b8043 100644 --- a/mava/_metadata.py +++ b/mava/_metadata.py @@ -21,7 +21,7 @@ # We follow Semantic Versioning (https://semver.org/) _MAJOR_VERSION = "0" _MINOR_VERSION = "0" -_PATCH_VERSION = "1" +_PATCH_VERSION = "9" # Example: '0.4.2' __version__ = ".".join([_MAJOR_VERSION, _MINOR_VERSION, _PATCH_VERSION])