ALEx v0.3.2 Alex View Source

(A)rcade (L)earning (E)nvironment for Eli(x)ir.

ALEx is an interface for the ALE in Elixir. There are two ways to interact with the ALE from ALEx: through the Alex.Interface module which mimics the ALE C Lib and provides NIFs for interacting directly with the ALE C++ Interface, or through the Alex module which is a safer wrapper of Alex.Interface.

Alex allows you to interact with the ALE without worrying about some of the lower level details of the ALE Interface. Every function in Alex returns an Alex.Interface struct which contains details about the current ALE Interface. See Alex.Interface for information about the Interface struct.

Link to this section Summary

Functions

game_over?(interface)

Checks if game is over.

load(interface, path_to_rom)

Loads the specified ROM and populates fields in %Interface{}.

new(opts \\ [])

Initializes a new ALE Interface.

reset(interface)

Resets the interface to beginning of an episode.

screenshot(interface, path \\ "")

Takes a screenshot.

set_option(interface, key, val)

Sets option for provided interface.

set_state(interface, state)

Sets interface to given state.

step(interface, action)

Performs a step with provided action and updates the interface.

Link to this section Functions

game_over?(interface)

Checks if game is over.

Returns boolean.

Parameters

interface: %Interface{}.

load(interface, path_to_rom)

Loads the specified ROM and populates fields in %Interface{}.

Returns %Interface{}.

Parameters

interface: %Interface{}.

new(opts \\ [])

Initializes a new ALE Interface.

Returns %Interface{}.

Parameters

opts: Keyword options.

Options

:display_screen: true or false to display screen. Defaults to false.
:sound: true or false to play sound. Defaults to false.
:random_seed: Integer random seed.

reset(interface)

Resets the interface to beginning of an episode.

Returns %Interface{}.

Parameters

interface: %Interface{}.

screenshot(interface, path \\ "")

Takes a screenshot.

Returns :ok.

Parameters

interface: %Interface{}.

set_option(interface, key, val)

Sets option for provided interface.

Returns %Interface{}.

Parameters

interface: %Interface{} to set option for.
key: Atom or String key.
val: String, Integer, Boolean, or Float value.

Options

:repeat_action_probability: Float probability that agent will repeat action in next frame regardless of it's choice. Defaults to 0.
:color_averaging: true or false to enable color averaging. Defaults to false.
:max_num_frames: Integer maximum frames to run. Defaults to 0 or no max.
:max_num_frames_per_episode: maximum frames to run per episode. Defaults to 0 or no max.
:frame_skip: Integer frame skipping rate. Defaults to 1 or no skip.
:difficulty: Integer game difficulty. Defaults to 0.
:mode: Integer game mode. Defaults to 0.

set_state(interface, state)

Sets interface to given state.

Returns %Interface{}.

Parameters

interface: %Interface{}.

step(interface, action)

Performs a step with provided action and updates the interface.

Returns %Interface.

Parameters

interface: %Interface{}.
action: Integer valid action.