palaestrai.store package

Submodules

palaestrai.store.database_base module

palaestrAI’s Object-Relational Mapper: palaestrai.store.database_model module

class palaestrai.store.database_model.Agent(**kwargs)

Bases: Base

brain_states

configuration

experiment_run_phase

experiment_run_phase_id

id

muscle_actions

muscles

name

uid

class palaestrai.store.database_model.BrainState(**kwargs)

Bases: Base

agent

agent_id

id

simtime_ticks

simtime_timestamp

state

tag

walltime

class palaestrai.store.database_model.Environment(**kwargs)

Bases: Base

environment_conductor_uid

experiment_run_phase

experiment_run_phase_id

id

parameters

type

uid

world_states

class palaestrai.store.database_model.Experiment(**kwargs)

Bases: Base

A whole experiment, including Design of Experiments

Experiments are the master objects of the palaestrAI store. Experiments define a study. This includes variations over parameters as the user wishes. An experiment spawns any number of concrete ::ExperimentRun objects.

document

experiment_runs

id

name

class palaestrai.store.database_model.ExperimentRun(**kwargs)

Bases: Base

A concrete experiment run created from an experiment

An experiment run is a concrete instance of an experiment. In it, any parameter variation is replaced by actual parameter settings. An experiment can spawn as many experiment runs as the user wishes. I.e., an experiment run is a concrete configuration.

document

experiment

experiment_id

experiment_run_instances

id

uid

class palaestrai.store.database_model.ExperimentRunInstance(**kwargs)

Bases: Base

An execution of an experiment run

Each experiment run can be executed as many times as a user wishes. This does not change its outcome, but for reproducibility, such re-runs are sensible. When an experiment run is actually executed - the experiment run being the blue print of an actual execution -, an experiment run instance is created.

created_at

experiment_run

experiment_run_id

experiment_run_phases

id

uid

class palaestrai.store.database_model.ExperimentRunPhase(**kwargs)

Bases: Base

agents

configuration

environments

experiment_run_instance

experiment_run_instance_id

id

mode

number

uid

class palaestrai.store.database_model.MuscleAction(**kwargs)

Bases: Base

actuator_setpoints

agent

agent_id

id

objective

rewards

sensor_readings

simtimes

statistics

walltime

class palaestrai.store.database_model.WorldState(**kwargs)

Bases: Base

done

environment

environment_id

id

simtime_ticks

simtime_timestamp

state_dump

walltime

palaestrai.store.database_util module

palaestrai.store.database_util.setup_database(uri)

Creates the database from the current model in one go.

Parameters:

uri (str) – The complete database connection URI.

palaestrai.store.database_util.setup_database_v2(store_uri, time_series_uri)

Creates the database from the current model in one go.

Parameters:

• store_uri – The complete database connection URI.

• time_series_uri – The complete database connection URI.

palaestrai.store.database_util.setup_elasticsearch(store_uri)

Creates the database from the current model in one go.

Parameters:

store_uri – The complete database connection URI.

palaestrai.store.database_util.setup_influxdb(time_series_uri)

Creates the database from the current model in one go.

Parameters:

time_series_uri – The complete database connection URI.

palaestrai.store.receiver module

class palaestrai.store.receiver.StoreReceiver(queue, *args, **kwargs)

Bases: Thread

The message receiver of the palaestrAI store.

The store hooks into the global communication, reading every message that is being exchanged between Executor, RunGovernor, AgentConductor, Environment, Brain, and Muscle instances. From these messages, it reads all relevant status information in order to relay them to the store database for later analysis of experiments.

disable()

Disables the store completely.

run()

Run the store.

shutdown()

property uid

write(message)

Main method called to write a message to the buffer.

Module contents