Skip to main content

A plotter for reinforcement learning (RL)

Project description

rl-plotter

PyPI GitHub GitHub last commit

This is a simple tool which can plot learning curves easily for reinforcement learning (RL).

Installation

from PIP

pip install rl_plotter

from source

python setup.py install

Examples

First, add our logger (compatible with OpenAI-baseline) in your code

or just use OpenAI-baseline bench.Monitor (recommended):

from baselines import bench
env = bench.Monitor(env, log_dir)

After the training or when you are training your agent, you can plot the learning curves in this way:

rl_plotter --save --show

more general ussage:

rl_plotter --save --show --avg_group --shaded_std

or

rl_plotter --save --show --avg_group --shaded_std --shaded_err

for help use:

rl_plotter --help

and you can find parameters to custom the style of your curves.

optional arguments:
-h, --help            show this help message and exit
--fig_length          matplotlib figure length (default: 6)
--fig_width           matplotlib figure width (default: 6)
--style               matplotlib figure style (default: seaborn)
--title               matplotlib figure title (default: None)
--xlabel              matplotlib figure xlabel
--xkey                x-axis key in csv file (default: l)
--ykey                y-axis key in csv file (default: r)
--smooth              smooth radius of y axis (default: 10)
--ylabel              matplotlib figure ylabel
--avg_group           average the curves in the same group and plot the mean
--shaded_std          shaded region corresponding to standard deviation of the group
--shaded_err          shaded region corresponding to error in mean estimate of the group
--legend_outside      place the legend outside of the figure
--time                enable this will set x_key to t, and activate parameters about time
--time_unit           parameters about time, x axis time unit (default: h)
--time_interval       parameters about time, x axis time interval (default: 1)
--xformat             x-axis format
--xlim                x-axis limitation (default: None)
--log_dir             log dir (default: ./)
--filename            csv filename
--show                show figure
--save                save figure
--dpi                 figure dpi (default: 400)

finally, the learning curves looks like this:

## Features - [x] custom logger, style, key, label, interval, and so on ... - [x] multi-experiment plotter - [x] x-axis formatter features - [x] compatible with [OpenAI-baseline](https://github.com/openai/baselines) monitor data style - [x] corresponding color for specific experiment

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rl_plotter-2.0.2.tar.gz (7.1 kB view hashes)

Uploaded Source

Built Distribution

rl_plotter-2.0.2-py3-none-any.whl (27.2 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page