• Stars
    star
    327
  • Rank 128,686 (Top 3 %)
  • Language
    C++
  • License
    Apache License 2.0
  • Created over 6 years ago
  • Updated about 5 years ago

Reviews

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

Repository Details

We provide a pre-trained model for unconditional 19-step generation of CelebA-HQ images

SPIRAL

Overview

This repository contains agents and environments described in the ICML'18 paper "Synthesizing Programs for Images using Reinforced Adversarial Learning". For the time being, we are providing two simulators: one based on libmypaint and one based on Fluid Paint (NOTE: our implementation is written in C++ whereas the original is in javascript). Additionally, we supply a Sonnet module for the unconditional agent as well as pre-trained model snapshots (9 agents from a single population for libmypaint and 1 agent for Fluid Paint) available from TF-Hub.

If you feel an immediate urge to dive into the code the most relevant files are:

Path Description
spiral/agents/default.py The architecture of the agent
spiral/environments/libmypaint.py The libmypaint-based environment
spiral/environments/fluid.py The Fluid Paint-based environment

Reference

If this repository is helpful for your research please cite the following publication:

@inproceedings{ganin2018synthesizing,
  title={Synthesizing Programs for Images using Reinforced Adversarial Learning},
  author={Ganin, Yaroslav and Kulkarni, Tejas and Babuschkin, Igor and Eslami, SM Ali and Vinyals, Oriol},
  booktitle={ICML},
  year={2018}
}

Quickstart with Docker

The easiest way to get SPIRAL up and running on your machine is to use a pre-built Docker image.

Installation

This section describes how to build and install the package on Ubuntu (16.04 or newer). The following instructions (with slight modifications) might also work for other Linux distributions.

Clone this repository and fetch the external submodules:

git clone https://github.com/deepmind/spiral.git
cd spiral
git submodule update --init --recursive

Install required packages:

apt-get install cmake pkg-config protobuf-compiler libjson-c-dev intltool libpython3-dev python3-pip
pip3 install six setuptools numpy scipy tensorflow==1.14 tensorflow-hub dm-sonnet==1.35

WARNING: Make sure that you have cmake 3.14 or later since we rely on its capability to find numpy libraries. If your package manager doesn't provide it follow the installation instructions from here. You can check the version by running cmake --version .

Finally, run the following command to install the SPIRAL package itself:

python3 setup.py develop --user

You will also need to obtain the brush files for the libmypaint environment to work properly. These can be found here. For example, you can place them in third_party folder like this:

wget -c https://github.com/mypaint/mypaint-brushes/archive/v1.3.0.tar.gz -O - | tar -xz -C third_party

Finally, the Fluid Paint environment depends on the shaders from the original javascript implementation. You can obtain them by running the following commands:

git clone https://github.com/dli/paint third_party/paint
patch third_party/paint/shaders/setbristles.frag third_party/paint-setbristles.patch

Optionally, in order to be able to try out the package in the provided jupyter notebook, you’ll need to install the following packages:

pip3 install matplotlib jupyter

Usage

For a basic example of how to use the package please follow this notebook.

Sampling from a pre-trained model

We provide pre-trained models for unconditional 19-step generation of CelebA-HQ images. Here is an example of how you can sample from an agent interacting with the libmypaint environment:

import matplotlib.pyplot as plt

import spiral.agents.default as default_agent
import spiral.agents.utils as agent_utils
import spiral.environments.libmypaint as libmypaint


# The path to a TF-Hub module.
MODULE_PATH = "https://tfhub.dev/deepmind/spiral/default-wgangp-celebahq64-gen-19steps/agent4/1"
# The folder containing `libmypaint` brushes.
BRUSHES_PATH = "the/path/to/libmypaint-brushes"

# Here, we create an environment.
env = libmypaint.LibMyPaint(episode_length=20,
                            canvas_width=64,
                            grid_width=32,
                            brush_type="classic/dry_brush",
                            brush_sizes=[1, 2, 4, 8, 12, 24],
                            use_color=True,
                            use_pressure=True,
                            use_alpha=False,
                            background="white",
                            brushes_basedir=BRUSHES_PATH)


# Now we load the agent from a snapshot.
initial_state, step = agent_utils.get_module_wrappers(MODULE_PATH)

# Everything is ready for sampling.
state = initial_state()
noise_sample = np.random.normal(size=(10,)).astype(np.float32)

time_step = env.reset()
for t in range(19):
    time_step.observation["noise_sample"] = noise_sample
    action, state = step(time_step.step_type, time_step.observation, state)
    time_step = env.step(action)

# Show the sample.
plt.close("all")
plt.imshow(time_step.observation["canvas"], interpolation="nearest")

Converting a trained agent into a TF-Hub module

import spiral.agents.default as default_agent
import spiral.agents.utils as agent_utils
import spiral.environments.libmypaint as libmypaint


# This where we're going to put our TF-Hub module.
TARGET_PATH = ...
# A path to a checkpoint of the trained model.
CHECKPOINT_PATH = ...

# We will need to create an environment in order to obtain the specifications
# for the agent's action and the observation.
env = libmypaint.LibMyPaint(...)

# Here, we wrap a Sonnet module constructor for our agent in a function.
# This is to avoid contaminating the default tensorflow graph.
def agent_ctor():
  return default_agent.Agent(action_spec=env.action_spec(),
                             input_shape=(64, 64),
                             grid_shape=(32, 32),
                             action_order="libmypaint")

# Finally, export a TF-Hub module. We need to specify which checkpoint to use
# to extract the weights for the agent. Since the variable names in the
# checkpoint may differ from the names in the Sonnet module produced by
# `agent_ctor`, we may also want to provide an appropriate name mapping
# function.
agent_utils.export_hub_module(agent_ctor=agent_ctor,
                              observation_spec=env.observation_spec(),
                              noise_dim=10,
                              module_path=TARGET_PATH,
                              checkpoint_path=CHECKPOINT_PATH,
                              name_transform_fn=lambda name: ...)

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

android_env

RL research on Android devices.
Python
977
star
34

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
35

mujoco_mpc

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

dramatron

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

tree

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

materials_discovery

Jupyter Notebook
866
star
39

xmanager

A platform for managing machine learning experiments
Python
815
star
40

open_x_embodiment

Jupyter Notebook
785
star
41

chex

Python
751
star
42

ferminet

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

reverb

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

funsearch

Jupyter Notebook
699
star
45

alphadev

Python
688
star
46

pycolab

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

concordia

A library for generative social simulation
Python
634
star
48

hanabi-learning-environment

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

recurrentgemma

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

ai-safety-gridworlds

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

meltingpot

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

ithaca

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

dqn

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

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
55

distrax

Python
527
star
56

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
57

surface-distance

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

tracr

Python
496
star
59

alphamissense

Python
494
star
60

dsprites-dataset

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

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
62

clrs

Jupyter Notebook
444
star
63

lab2d

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

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
65

alphastar

Python
403
star
66

dm_pix

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

opro

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

mathematics_conjectures

Jupyter Notebook
367
star
69

spriteworld

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

torax

TORAX: Tokamak transport simulation in JAX
Python
361
star
71

dm_env

A Python interface for reinforcement learning environments
Python
343
star
72

dm_robotics

Libraries, tools and tasks created and used at DeepMind Robotics.
Python
341
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