• Stars
    star
    10,319
  • Rank 3,135 (Top 0.07 %)
  • Language
    Jupyter Notebook
  • License
    Apache License 2.0
  • Created over 5 years ago
  • Updated 4 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Dopamine is a research framework for fast prototyping of reinforcement learning algorithms.

Dopamine

Getting Started | Docs | Baseline Results | Changelist



Dopamine is a research framework for fast prototyping of reinforcement learning algorithms. It aims to fill the need for a small, easily grokked codebase in which users can freely experiment with wild ideas (speculative research).

Our design principles are:

  • Easy experimentation: Make it easy for new users to run benchmark experiments.
  • Flexible development: Make it easy for new users to try out research ideas.
  • Compact and reliable: Provide implementations for a few, battle-tested algorithms.
  • Reproducible: Facilitate reproducibility in results. In particular, our setup follows the recommendations given by Machado et al. (2018).

Dopamine supports the following agents, implemented with jax:

For more information on the available agents, see the docs.

Many of these agents also have a tensorflow (legacy) implementation, though newly added agents are likely to be jax-only.

This is not an official Google product.

Getting Started

We provide docker containers for using Dopamine. Instructions can be found here.

Alternatively, Dopamine can be installed from source (preferred) or installed with pip. For either of these methods, continue reading at prerequisites.

Prerequisites

Dopamine supports Atari environments and Mujoco environments. Install the environments you intend to use before you install Dopamine:

Atari

  1. Install the atari roms following the instructions from atari-py.
  2. pip install ale-py (we recommend using a virtual environment):
  3. unzip $ROM_DIR/ROMS.zip -d $ROM_DIR && ale-import-roms $ROM_DIR/ROMS (replace $ROM_DIR with the directory you extracted the ROMs to).

Mujoco

  1. Install Mujoco and get a license here.
  2. Run pip install mujoco-py (we recommend using a virtual environment).

Installing from Source

The most common way to use Dopamine is to install it from source and modify the source code directly:

git clone https://github.com/google/dopamine

After cloning, install dependencies:

pip install -r dopamine/requirements.txt

Dopamine supports tensorflow (legacy) and jax (actively maintained) agents. View the Tensorflow documentation for more information on installing tensorflow.

Note: We recommend using a virtual environment when working with Dopamine.

Installing with Pip

Note: We strongly recommend installing from source for most users.

Installing with pip is simple, but Dopamine is designed to be modified directly. We recommend installing from source for writing your own experiments.

pip install dopamine-rl

Running tests

You can test whether the installation was successful by running the following from the dopamine root directory.

export PYTHONPATH=$PYTHONPATH:$PWD
python -m tests.dopamine.atari_init_test

Next Steps

View the docs for more information on training agents.

We supply baselines for each Dopamine agent.

We also provide a set of Colaboratory notebooks which demonstrate how to use Dopamine.

References

Bellemare et al., The Arcade Learning Environment: An evaluation platform for general agents. Journal of Artificial Intelligence Research, 2013.

Machado et al., Revisiting the Arcade Learning Environment: Evaluation Protocols and Open Problems for General Agents, Journal of Artificial Intelligence Research, 2018.

Hessel et al., Rainbow: Combining Improvements in Deep Reinforcement Learning. Proceedings of the AAAI Conference on Artificial Intelligence, 2018.

Mnih et al., Human-level Control through Deep Reinforcement Learning. Nature, 2015.

Schaul et al., Prioritized Experience Replay. Proceedings of the International Conference on Learning Representations, 2016.

Haarnoja et al., Soft Actor-Critic Algorithms and Applications, arXiv preprint arXiv:1812.05905, 2018.

Giving credit

If you use Dopamine in your work, we ask that you cite our white paper. Here is an example BibTeX entry:

@article{castro18dopamine,
  author    = {Pablo Samuel Castro and
               Subhodeep Moitra and
               Carles Gelada and
               Saurabh Kumar and
               Marc G. Bellemare},
  title     = {Dopamine: {A} {R}esearch {F}ramework for {D}eep {R}einforcement {L}earning},
  year      = {2018},
  url       = {http://arxiv.org/abs/1812.06110},
  archivePrefix = {arXiv}
}

More Repositories

1

material-design-icons

Material Design icons by Google
49,605
star
2

guava

Google core libraries for Java
Java
48,313
star
3

zx

A tool for writing better scripts
JavaScript
37,928
star
4

styleguide

Style guides for Google-originated open-source projects
HTML
36,377
star
5

leveldb

LevelDB is a fast key-value storage library written at Google that provides an ordered mapping from string keys to string values.
C++
33,564
star
6

material-design-lite

Material Design Components in HTML/CSS/JS
HTML
32,276
star
7

googletest

GoogleTest - Google Testing and Mocking Framework
C++
32,215
star
8

jax

Composable transformations of Python+NumPy programs: differentiate, vectorize, JIT to GPU/TPU, and more
Python
27,471
star
9

python-fire

Python Fire is a library for automatically generating command line interfaces (CLIs) from absolutely any Python object.
Python
26,112
star
10

mediapipe

Cross-platform, customizable ML solutions for live and streaming media.
C++
25,107
star
11

comprehensive-rust

This is the Rust course used by the Android team at Google. It provides you the material to quickly teach Rust.
Rust
24,867
star
12

gson

A Java serialization/deserialization library to convert Java Objects into JSON and back
Java
22,856
star
13

flatbuffers

FlatBuffers: Memory Efficient Serialization Library
C++
21,883
star
14

iosched

The Google I/O Android App
Kotlin
21,801
star
15

ExoPlayer

An extensible media player for Android
Java
21,309
star
16

eng-practices

Google's Engineering Practices documentation
19,715
star
17

web-starter-kit

Web Starter Kit - a workflow for multi-device websites
HTML
18,426
star
18

flexbox-layout

Flexbox for Android
Kotlin
18,141
star
19

fonts

Font files available from Google Fonts, and a public issue tracker for all things Google Fonts
HTML
17,389
star
20

filament

Filament is a real-time physically based rendering engine for Android, iOS, Windows, Linux, macOS, and WebGL2
C++
16,946
star
21

cadvisor

Analyzes resource usage and performance characteristics of running containers.
Go
16,184
star
22

libphonenumber

Google's common Java, C++ and JavaScript library for parsing, formatting, and validating international phone numbers.
C++
15,728
star
23

gvisor

Application Kernel for Containers
Go
14,646
star
24

WebFundamentals

Former git repo for WebFundamentals on developers.google.com
JavaScript
13,848
star
25

yapf

A formatter for Python files
Python
13,560
star
26

tink

Tink is a multi-language, cross-platform, open source library that provides cryptographic APIs that are secure, easy to use correctly, and hard(er) to misuse.
Java
13,318
star
27

deepdream

13,212
star
28

brotli

Brotli compression format
TypeScript
12,921
star
29

guetzli

Perceptual JPEG encoder
C++
12,863
star
30

guice

Guice (pronounced 'juice') is a lightweight dependency injection framework for Java 8 and above, brought to you by Google.
Java
12,324
star
31

wire

Compile-time Dependency Injection for Go
Go
12,131
star
32

blockly

The web-based visual programming editor.
TypeScript
12,033
star
33

grumpy

Grumpy is a Python to Go source code transcompiler and runtime.
Go
10,464
star
34

sanitizers

AddressSanitizer, ThreadSanitizer, MemorySanitizer
C
10,437
star
35

or-tools

Google's Operations Research tools:
C++
10,299
star
36

auto

A collection of source code generators for Java.
Java
10,234
star
37

go-github

Go library for accessing the GitHub v3 API
Go
9,941
star
38

oss-fuzz

OSS-Fuzz - continuous fuzzing for open source software.
Shell
9,324
star
39

go-cloud

The Go Cloud Development Kit (Go CDK): A library and tools for open cloud development in Go.
Go
9,314
star
40

sentencepiece

Unsupervised text tokenizer for Neural Network-based text generation.
C++
8,657
star
41

re2

RE2 is a fast, safe, thread-friendly alternative to backtracking regular expression engines like those used in PCRE, Perl, and Python. It is a C++ library.
C++
8,190
star
42

traceur-compiler

Traceur is a JavaScript.next-to-JavaScript-of-today compiler
JavaScript
8,178
star
43

tsunami-security-scanner

Tsunami is a general purpose network security scanner with an extensible plugin system for detecting high severity vulnerabilities with high confidence.
Java
8,036
star
44

trax

Trax — Deep Learning with Clear Code and Speed
Python
7,917
star
45

skia

Skia is a complete 2D graphic library for drawing Text, Geometries, and Images.
C++
7,874
star
46

benchmark

A microbenchmark support library
C++
7,812
star
47

android-classyshark

Android and Java bytecode viewer
Java
7,440
star
48

pprof

pprof is a tool for visualization and analysis of profiling data
Go
7,235
star
49

agera

Reactive Programming for Android
Java
7,227
star
50

closure-compiler

A JavaScript checker and optimizer.
Java
7,195
star
51

magika

Detect file content types with deep learning
Python
7,171
star
52

accompanist

A collection of extension libraries for Jetpack Compose
Kotlin
7,157
star
53

flutter-desktop-embedding

Experimental plugins for Flutter for Desktop
C++
7,108
star
54

diff-match-patch

Diff Match Patch is a high-performance library in multiple languages that manipulates plain text.
Python
6,918
star
55

lovefield

Lovefield is a relational database for web apps. Written in JavaScript, works cross-browser. Provides SQL-like APIs that are fast, safe, and easy to use.
JavaScript
6,847
star
56

glog

C++ implementation of the Google logging module
C++
6,748
star
57

jsonnet

Jsonnet - The data templating language
Jsonnet
6,711
star
58

latexify_py

A library to generate LaTeX expression from Python code.
Python
6,708
star
59

error-prone

Catch common Java mistakes as compile-time errors
Java
6,690
star
60

model-viewer

Easily display interactive 3D models on the web and in AR!
TypeScript
6,390
star
61

gops

A tool to list and diagnose Go processes currently running on your system
Go
6,375
star
62

automl

Google Brain AutoML
Jupyter Notebook
6,113
star
63

gopacket

Provides packet processing capabilities for Go
Go
6,067
star
64

physical-web

The Physical Web: walk up and use anything
Java
6,017
star
65

j2objc

A Java to iOS Objective-C translation tool and runtime.
Java
5,975
star
66

grafika

Grafika test app
Java
5,964
star
67

draco

Draco is a library for compressing and decompressing 3D geometric meshes and point clouds. It is intended to improve the storage and transmission of 3D graphics.
C++
5,947
star
68

snappy

A fast compressor/decompressor
C++
5,940
star
69

ios-webkit-debug-proxy

A DevTools proxy (Chrome Remote Debugging Protocol) for iOS devices (Safari Remote Web Inspector).
C
5,848
star
70

osv-scanner

Vulnerability scanner written in Go which uses the data provided by https://osv.dev
Go
5,763
star
71

seesaw

Seesaw v2 is a Linux Virtual Server (LVS) based load balancing platform.
Go
5,586
star
72

seq2seq

A general-purpose encoder-decoder framework for Tensorflow
Python
5,577
star
73

EarlGrey

🍵 iOS UI Automation Test Framework
Objective-C
5,570
star
74

google-java-format

Reformats Java source code to comply with Google Java Style.
Java
5,366
star
75

flax

Flax is a neural network library for JAX that is designed for flexibility.
Python
5,358
star
76

wireit

Wireit upgrades your npm/pnpm/yarn scripts to make them smarter and more efficient.
TypeScript
5,280
star
77

battery-historian

Battery Historian is a tool to analyze battery consumers using Android "bugreport" files.
Go
5,249
star
78

clusterfuzz

Scalable fuzzing infrastructure.
Python
5,170
star
79

bbr

5,156
star
80

gumbo-parser

An HTML5 parsing library in pure C99
HTML
5,141
star
81

git-appraise

Distributed code review system for Git repos
Go
5,090
star
82

google-authenticator

Open source version of Google Authenticator (except the Android app)
Java
5,077
star
83

gemma.cpp

lightweight, standalone C++ inference engine for Google's Gemma models.
C++
5,076
star
84

syzkaller

syzkaller is an unsupervised coverage-guided kernel fuzzer
Go
5,063
star
85

uuid

Go package for UUIDs based on RFC 4122 and DCE 1.1: Authentication and Security Services.
Go
4,942
star
86

gts

☂️ TypeScript style guide, formatter, and linter.
TypeScript
4,890
star
87

closure-library

Google's common JavaScript library
JavaScript
4,832
star
88

cameraview

[DEPRECATED] Easily integrate Camera features into your Android app
Java
4,734
star
89

grr

GRR Rapid Response: remote live forensics for incident response
Python
4,627
star
90

liquidfun

2D physics engine for games
C++
4,559
star
91

pytype

A static type analyzer for Python code
Python
4,454
star
92

gxui

An experimental Go cross platform UI library.
Go
4,450
star
93

bloaty

Bloaty: a size profiler for binaries
C++
4,386
star
94

clasp

🔗 Command Line Apps Script Projects
TypeScript
4,336
star
95

ko

Build and deploy Go applications on Kubernetes
Go
4,329
star
96

santa

A binary authorization and monitoring system for macOS
Objective-C
4,288
star
97

google-ctf

Google CTF
Go
4,237
star
98

tamperchrome

Tamper Dev is an extension that allows you to intercept and edit HTTP/HTTPS requests and responses as they happen without the need of a proxy. Works across all operating systems (including Chrome OS).
TypeScript
4,137
star
99

end-to-end

End-To-End is a crypto library to encrypt, decrypt, digital sign, and verify signed messages (implementing OpenPGP)
JavaScript
4,126
star
100

orbit

C/C++ Performance Profiler
C++
3,981
star