OpenELM API Reference

Subpackages

class openelm.elm.ELM(config, env=None)[source]

Bases: object

__init__(config, env=None)[source]

The main class of ELM.

This class will load a diff model, an environment, and a QD algorithm from the passed config.

Parameters:

config (ELMConfig) – The config containing the diff model, environment, and QD algorithm.
env (Optional) – An optional environment to pass in. Defaults to None.

run(init_steps=None, total_steps=None)[source]

Run the ELM algorithm to evolve the population in the environment.

Parameters:

init_steps (Optional[int]) – The number of steps to run the initialisation phase.
total_steps (Optional[int]) – The number of steps to run the QD algorithm in total,
init_steps. (including) –

Returns:

A string representing the maximum fitness genotype. The qd_algorithm class attribute will be updated.

Return type:

str

openelm.elm.load_algorithm(algorithm_name)[source]

openelm.elm.load_env(env_name)[source]