An open API service indexing awesome lists of open source software.

https://github.com/frgfm/drlnd-p3-collaboration-competition

Collaboration and competition project of Udacity Deep Reinforcement Learning Nanodegree
https://github.com/frgfm/drlnd-p3-collaboration-competition

actor-critic ddpg-algorithm deep-reinforcement-learning experience-replay pytorch unity

Last synced: 2 months ago
JSON representation

Collaboration and competition project of Udacity Deep Reinforcement Learning Nanodegree

Awesome Lists containing this project

README

        

# Tennis coach
[![License](https://img.shields.io/badge/License-MIT-brightgreen.svg)](LICENSE) [![Codacy Badge](https://api.codacy.com/project/badge/Grade/0689fca92f594fe88299d1e95d7e4c48)](https://www.codacy.com/manual/fg/drlnd-p3-collaboration-competition?utm_source=github.com&utm_medium=referral&utm_content=frgfm/drlnd-p3-collaboration-competition&utm_campaign=Badge_Grade) [![CircleCI](https://circleci.com/gh/frgfm/drlnd-p3-collaboration-competition.svg?style=shield)](https://circleci.com/gh/frgfm/drlnd-p3-collaboration-competition)

This repository is an implementation of DDPG agents for the collaboration and competition project of Udacity Deep Reinforcement Learning nanodegree, in the tennis game provided by unity.

![tennis](https://video.udacity-data.com/topher/2018/May/5af7955a_tennis/tennis.png)

## Table of Contents

- [Environment](#environment)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Credits](#credits)
- [License](#license)

## Environment

In this environment, two agents control rackets to bounce a ball over a net. If an agent hits the ball over the net, it receives a reward of +0.1. If an agent lets a ball hit the ground or hits the ball out of bounds, it receives a reward of -0.01. Thus, the goal of each agent is to keep the ball in play.

The observation space consists of 8 variables corresponding to the position and velocity of the ball and racket. Each agent receives its own, local observation. Two continuous actions are available, corresponding to movement toward (or away from) the net, and jumping.

The task is episodic, and in order to solve the environment, your agents must get an average score of +0.5 (over 100 consecutive episodes, after taking the maximum over both agents). Specifically,

- After each episode, we add up the rewards that each agent received (without discounting), to get a score for each agent. This yields 2 (potentially different) scores. We then take the maximum of these 2 scores.
- This yields a single **score** for each episode.

The environment is considered solved, when the average (over 100 episodes) of those **scores** is at least +0.5.

## Getting started

### Prerequisites

- Python 3.6 (or more recent)
- [pip](https://pip.pypa.io/en/stable/)
- [ml-agents](https://github.com/Unity-Technologies/ml-agents) v0.4 (check this [release](https://github.com/Unity-Technologies/ml-agents/releases/tag/0.4.0b) if you encounter issues)

### Installation

You can install the project requirements as follows:

```shell
git clone https://github.com/frgfm/drlnd-p3-collaboration-competition.git
cd drlnd-p3-collaboration-competition
pip install -r requirements.txt
```

Download the environment build corresponding to your OS

- Linux: [here](https://s3-us-west-1.amazonaws.com/udacity-drlnd/P3/Tennis/Tennis_Linux.zip)
- Mac OSX: [here](https://s3-us-west-1.amazonaws.com/udacity-drlnd/P3/Tennis/Tennis.app.zip)
- Windows (32-bit): [here](https://s3-us-west-1.amazonaws.com/udacity-drlnd/P3/Tennis/Tennis_Windows_x86.zip)
- Windows (64-bit): [here](https://s3-us-west-1.amazonaws.com/udacity-drlnd/P3/Tennis/Tennis_Windows_x86_64.zip)

Then extract the archive in the project folder.

If you wish to use the agent trained by repo owner, you can download the model parameters as follows:

```shell
wget https://github.com/frgfm/drlnd-p3-collaboration-competition/releases/download/v0.1.0/maddpg_actor.pt
```

## Usage

### Training

All training arguments can be found using the `--help` flag:

```shell
python train.py --help
```

Below you can find an example to train your agent:

```shell
python train.py --deterministic --no-graphics
```

### Evaluation

You can use an existing model's checkpoint to evaluate your agent as follows:

```shell
python evaluate.py --checkpoint ./maddpg_actor.pt
```

## Credits

This implementation is vastly based on the following papers:

- [Asynchronous Actor Critic](https://arxiv.org/pdf/1602.01783.pdf)
- [Proximal Policy Optimization](https://arxiv.org/pdf/1707.06347.pdf)
- [DDPG](https://openreview.net/pdf?id=SyZipzbCb)

## License

Distributed under the MIT License. See `LICENSE` for more information.