• Stars
    star
    977
  • Rank 46,866 (Top 1.0 %)
  • Language
    Python
  • License
    Apache License 2.0
  • Created over 3 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

RL research on Android devices.

AndroidEnv - The Android Learning Environment

AndroidEnv is a Python library that exposes an Android device as a Reinforcement Learning (RL) environment. The library provides a flexible platform for defining custom tasks on top of the Android Operating System, including any Android application. Agents interact with the device through a universal action interface - the touchscreen - by sending localized touch and lift events to the system. The library processes these events and returns pixel observations and rewards as provided by specific task definitions. For example, rewards might be given for events such as successfully scrolling down a page, sending an email, or achieving some score in a game, depending on the research purpose and how the user configures the task.

tests PyPI version Downloads

Index

Environment features

There are a number of aspects that make AndroidEnv a challenging yet suitable environment for Reinforcement Learning research:

  • Allowing agents to interact with a system used daily by billions of users around the world, AndroidEnv offers a platform for RL agents to navigate, learn tasks and have direct impact in real-world contexts. The environment wraps a simulated Android device, which runs independently from the environment, completely unaltered, and works in exactly the same way as the devices that humans use, exposing exactly the same features and services.

  • The platform offers a virtually infinite range of possible tasks, all sharing a common action interface. The library facilitates the design of Reinforcement Learning tasks for any existing or custom built Android application. For example, it exposes the broad world of Android games, ranging from card games, puzzle games, time reactive games, all requiring a diverse set of action combinations and interaction types.

  • The environment runs on top of a real-time simulation of an Android device. In other words, the environment dynamics does not wait for the agent to deliberate, and the speed of the simulation cannot be increased.

  • The observation is a collection of RGB values corresponding to the displayed pixels on the screen. The exact screen resolution depends on the simulated device, but in general it will be considered relatively large in an RL context. However, users have the option of downsampling each observation.

  • The learning environment has an interesting, complex action space unique to the touchscreen interface of Android.

    • The raw, hybrid action space consists of a continuous tuple signifying the action location, and a discrete signal determining whether the agent wants to touch the screen or lift its virtual finger.
    • Raw actions are highly composable: the Android UI and most applications were designed so that they could be intuitively navigated via common touchscreen gestures such as tapping, scrolling, swiping, pinching, drag & drop etc. This is still the case in AndroidEnv: to trigger meaningful changes in the environment, the agent often has to perform carefully timed and positioned sequences of raw actions. For example, in order to navigate to the next image in a photo gallery, the agent would have to perform a swipe, touching the screen multiple times, gradually shifting the actions' positions to the right. Thus, in most contexts raw actions do not trigger changes in the state of the environment unless correctly chained together to make up a human gesture.
    • The action interface is closely related to the observation space, as meaningful touch and lift events are often either co-localized or strongly correlated to the location or movement of salient objects in the observation. For example, the position of a button on the screen aligns with the location of the actions that trigger the button press.
    • The library provides tools for flexibly altering the action interface if needed for particular studies, such as discretization or hard-coding gesture skills. Still, we believe that the real challenge remains in devising agents that are capable of dealing with a large suite of diverse tasks, through acting and learning in the complex unifying action interface.

Getting started

Installation

The easiest way to get AndroidEnv is with pip:

$ python3 -m pip install android-env

Please note that /examples are not included in this package.

Alternatively, you can clone the repository from git's main branch:

$ git clone https://github.com/deepmind/android_env/
$ cd android_env
$ python3 setup.py install

Update: the environment now runs on Windows, but please keep in mind that this option is not well-maintained or widely supported, as Unix-based systems are the primary target platforms of this project.

Create a simulator

Before running the environment, you will need access to an emulated Android device. For instructions on creating a virtual Android device, see the Emulator guide.

Define a task

Then, you will want to define what the agent's task is. At this point, the agent will be able to communicate with the emulated device, but it will not yet have an objective, or access to signals such as rewards or RL episode ends. Learn how to define an RL task of your own, or use one of the existing task definitions for training.

Load and run

To find out how to run and train agents on AndroidEnv, see these detailed instructions. Here you can also find example scripts demonstrating how to run a random agent, an acme agent, or a human agent on AndroidEnv.

About

This library is developed and maintained by DeepMind.
You can find the technical report on Arxiv, as well as an introductory blog post on DeepMind's website.

If you use AndroidEnv in your research, you can cite the paper using the following BibTeX:

@article{ToyamaEtAl2021AndroidEnv,
  title     = {{AndroidEnv}: A Reinforcement Learning Platform for Android},
  author    = {Daniel Toyama and Philippe Hamel and Anita Gergely and
               Gheorghe Comanici and Amelia Glaese and Zafarali Ahmed and Tyler
               Jackson and Shibl Mourad and Doina Precup},
  year      = {2021},
  eprint    = {2105.13231},
  archivePrefix = {arXiv},
  primaryClass = {cs.LG},
  volume    = {abs/2105.13231},
  url       = {http://arxiv.org/abs/2105.13231},
}

Disclaimer: This is not an official Google product.

More Repositories

1

deepmind-research

This repository contains implementations and illustrative code to accompany DeepMind publications
Jupyter Notebook
13,132
star
2

alphafold

Open source code for AlphaFold.
Python
12,602
star
3

sonnet

TensorFlow-based neural network library
Python
9,769
star
4

mujoco

Multi-Joint dynamics with Contact. A general purpose physics simulator.
Jupyter Notebook
8,113
star
5

pysc2

StarCraft II Learning Environment
Python
8,001
star
6

lab

A customisable 3D platform for agent-based AI research
C
7,101
star
7

graph_nets

Build Graph Nets in Tensorflow
Python
5,352
star
8

graphcast

Python
4,517
star
9

open_spiel

OpenSpiel is a collection of environments and algorithms for research in general reinforcement learning and search/planning in games.
C++
4,231
star
10

alphageometry

Python
4,079
star
11

learning-to-learn

Learning to Learn in TensorFlow
Python
4,064
star
12

dm_control

Google DeepMind's software stack for physics-based simulation and Reinforcement Learning environments, using MuJoCo.
Python
3,793
star
13

acme

A library of reinforcement learning components and agents
Python
3,466
star
14

trfl

TensorFlow Reinforcement Learning
Python
3,136
star
15

dm-haiku

JAX-based neural network library
Python
2,848
star
16

alphatensor

Python
2,670
star
17

dnc

A TensorFlow implementation of the Differentiable Neural Computer.
Python
2,478
star
18

gemma

Open weights LLM from Google DeepMind.
Python
2,421
star
19

mctx

Monte Carlo tree search in JAX
Python
2,313
star
20

code_contests

C++
2,064
star
21

optax

Optax is a gradient processing and optimization library for JAX.
Python
1,670
star
22

kinetics-i3d

Convolutional neural network model for video classification trained on the Kinetics dataset.
Python
1,639
star
23

penzai

A JAX research toolkit for building, editing, and visualizing neural networks.
Python
1,639
star
24

mathematics_dataset

This dataset code generates mathematical question and answer pairs, from a range of question types at roughly school-level difficulty.
Python
1,621
star
25

bsuite

bsuite is a collection of carefully-designed experiments that investigate core capabilities of a reinforcement learning (RL) agent
Python
1,497
star
26

educational

Jupyter Notebook
1,398
star
27

jraph

A Graph Neural Network Library in Jax
Python
1,349
star
28

rc-data

Question answering dataset featured in "Teaching Machines to Read and Comprehend
Python
1,285
star
29

mujoco_menagerie

A collection of high-quality models for the MuJoCo physics engine, curated by Google DeepMind.
Jupyter Notebook
1,278
star
30

tapnet

Tracking Any Point (TAP)
Jupyter Notebook
1,266
star
31

rlax

Python
1,223
star
32

scalable_agent

A TensorFlow implementation of Scalable Distributed Deep-RL with Importance Weighted Actor-Learner Architectures.
Python
981
star
33

neural-processes

This repository contains notebook implementations of the following Neural Process variants: Conditional Neural Processes (CNPs), Neural Processes (NPs), Attentive Neural Processes (ANPs).
Jupyter Notebook
969
star
34

mujoco_mpc

Real-time behaviour synthesis with MuJoCo, using Predictive Control
C++
959
star
35

dramatron

Dramatron uses large language models to generate coherent scripts and screenplays.
Jupyter Notebook
947
star
36

tree

tree is a library for working with nested data structures
Python
925
star
37

materials_discovery

Jupyter Notebook
866
star
38

xmanager

A platform for managing machine learning experiments
Python
815
star
39

open_x_embodiment

Jupyter Notebook
785
star
40

chex

Python
751
star
41

ferminet

An implementation of the Fermionic Neural Network for ab-initio electronic structure calculations
Python
707
star
42

reverb

Reverb is an efficient and easy-to-use data storage and transport system designed for machine learning research
C++
700
star
43

funsearch

Jupyter Notebook
699
star
44

alphadev

Python
688
star
45

pycolab

A highly-customisable gridworld game engine with some batteries included. Make your own gridworld games to test reinforcement learning agents!
Python
659
star
46

concordia

A library for generative social simulation
Python
634
star
47

hanabi-learning-environment

hanabi_learning_environment is a research platform for Hanabi experiments.
Python
614
star
48

recurrentgemma

Open weights language model from Google DeepMind, based on Griffin.
Python
603
star
49

ai-safety-gridworlds

This is a suite of reinforcement learning environments illustrating various safety properties of intelligent agents.
Python
577
star
50

meltingpot

A suite of test scenarios for multi-agent reinforcement learning.
Python
576
star
51

ithaca

Restoring and attributing ancient texts using deep neural networks
Jupyter Notebook
547
star
52

dqn

Lua/Torch implementation of DQN (Nature, 2015)
Lua
546
star
53

uncertain_ground_truth

Dermatology ddx dataset, Jax implementations of Monte Carlo conformal prediction, plausibility regions and statistical annotation aggregation from our recent work on uncertain ground truth (TMLR'23 and ArXiv pre-print).
Python
534
star
54

distrax

Python
527
star
55

long-form-factuality

Benchmarking long-form factuality in large language models. Original code for our paper "Long-form factuality in large language models".
Python
526
star
56

surface-distance

Library to compute surface distance based performance metrics for segmentation tasks.
Python
526
star
57

tracr

Python
496
star
58

alphamissense

Python
494
star
59

dsprites-dataset

Dataset to assess the disentanglement properties of unsupervised learning methods
Jupyter Notebook
476
star
60

narrativeqa

This repository contains the NarrativeQA dataset. It includes the list of documents with Wikipedia summaries, links to full stories, and questions and answers.
Shell
452
star
61

clrs

Jupyter Notebook
444
star
62

lab2d

A customisable 2D platform for agent-based AI research
C++
420
star
63

dqn_zoo

DQN Zoo is a collection of reference implementations of reinforcement learning agents developed at DeepMind based on the Deep Q-Network (DQN) agent.
Python
406
star
64

alphastar

Python
403
star
65

dm_pix

PIX is an image processing library in JAX, for JAX.
Python
386
star
66

opro

official code for "Large Language Models as Optimizers"
Python
383
star
67

mathematics_conjectures

Jupyter Notebook
367
star
68

spriteworld

Spriteworld: a flexible, configurable python-based reinforcement learning environment
Python
367
star
69

torax

TORAX: Tokamak transport simulation in JAX
Python
361
star
70

dm_env

A Python interface for reinforcement learning environments
Python
343
star
71

dm_robotics

Libraries, tools and tasks created and used at DeepMind Robotics.
Python
341
star
72

spiral

We provide a pre-trained model for unconditional 19-step generation of CelebA-HQ images
C++
327
star
73

launchpad

Python
310
star
74

leo

Implementation of Meta-Learning with Latent Embedding Optimization
Python
302
star
75

enn

Python
291
star
76

streetlearn

A C++/Python implementation of the StreetLearn environment based on images from Street View, as well as a TensorFlow implementation of goal-driven navigation agents solving the task published in “Learning to Navigate in Cities Without a Map”, NeurIPS 2018
C++
285
star
77

gqn-datasets

Datasets used to train Generative Query Networks (GQNs) in the ‘Neural Scene Representation and Rendering’ paper.
Python
269
star
78

treescope

An interactive HTML pretty-printer for machine learning research in IPython notebooks.
Python
256
star
79

multi_object_datasets

Multi-object image datasets with ground-truth segmentation masks and generative factors.
Python
254
star
80

AQuA

A algebraic word problem dataset, with multiple choice questions annotated with rationales.
238
star
81

synjax

Python
238
star
82

grid-cells

Implementation of the supervised learning experiments in Vector-based navigation using grid-like representations in artificial agents, as published at https://www.nature.com/articles/s41586-018-0102-6
Python
236
star
83

card2code

A code generation dataset for generating the code that implements Hearthstone and Magic The Gathering card effects.
236
star
84

arnheim

Jupyter Notebook
235
star
85

torch-hdf5

Torch interface to HDF5 library
Lua
234
star
86

kfac-jax

Second Order Optimization and Curvature Estimation with K-FAC in JAX.
Python
231
star
87

dm_memorytasks

A set of 13 diverse machine-learning tasks that require memory to solve.
Python
221
star
88

Temporal-3D-Pose-Kinetics

Exploiting temporal context for 3D human pose estimation in the wild: 3D poses for the Kinetics dataset
Python
218
star
89

dm_alchemy

DeepMind Alchemy task environment: a meta-reinforcement learning benchmark
Python
197
star
90

neural_testbed

Jupyter Notebook
191
star
91

perception_test

Jupyter Notebook
184
star
92

jmp

JMP is a Mixed Precision library for JAX.
Python
183
star
93

neural_networks_chomsky_hierarchy

Neural Networks and the Chomsky Hierarchy
Python
183
star
94

xquad

180
star
95

nanodo

Python
180
star
96

pg19

179
star
97

spectral_inference_networks

Implementation of Spectral Inference Networks, ICLR 2019
Python
165
star
98

barkour_robot

Barkour Robot: Agile Quadruped Robots by Google DeepMind
C++
165
star
99

onetwo

Python
164
star
100

abstract-reasoning-matrices

Progressive matrices dataset, as described in: Measuring abstract reasoning in neural networks (Barrett*, Hill*, Santoro*, Morcos, Lillicrap), ICML2018
162
star