Moving Symbols API

Entry Point

The moving_symbols package provides the MovingSymbolsEnvironment class, which is the one you should be using to generate Moving Symbols videos.

Tiny Example

The following code snippet puts the frames of one Moving Symbols video into a list:

from moving_symbols import MovingSymbolsEnvironment

env = MovingSymbolsEnvironment(params, seed)

all_frames = []
for _ in xrange(num_frames):
    frame = env.next()
    all_frames.append(np.array(frame))

MovingSymbolsEnvironment as a Publisher

A MovingSymbolsEnvironment instance publishes messages corresponding to the initialization and state of each symbol at all time steps. The following code snippet shows an example where a subscriber collects all the published messages:

from moving_symbols import MovingSymbolsEnvironment

class Subscriber:
    def process_message(self, message):
        print(message)

env = MovingSymbolsEnvironment(params, seed)
sub = Subscriber()
env.add_subscriber(sub)

all_frames = []
for _ in xrange(num_frames):
    frame = env.next()
    all_frames.append(np.array(frame))

Messages start getting published as soon as env.next() is first called.