palaestrai package

Subpackages

• palaestrai.agent
  • Algorithms: Agent, Brain, and Muscle
    • Agent
      • Agent
    • agent.State
      • State
    • Brain
      • Brain
    • Muscle
      • Muscle
    • AgentConductor
      • AgentConductor
  • State, Action, and Rewards
    • SensorInformation
    • ActuatorInforation
      • ActuatorInformation
    • RewardInformation
      • RewardInformation
    • Objective
      • Objective
  • Example (Dummy) Implementations
    • DummyBrain
      • DummyBrain
    • DummyMuscle
      • DummyMuscle
    • DummyObjective
      • DummyObjective
• palaestrai.cli package
  • Submodules
  • palaestrai.cli.client_local module
    • get_aliases()
    • parse_id_choice()
  • palaestrai.cli.manager module
    • init_logger()
  • Module contents
• palaestrai.core package
  • Submodules
  • palaestrai.core.MDP module
    • commands
  • palaestrai.core.basic_state module
    • BasicState
      • BasicState.CANCELLED
      • BasicState.ERROR
      • BasicState.FINISHED
      • BasicState.INITIALIZED
      • BasicState.INITIALIZING
      • BasicState.PRISTINE
      • BasicState.RUNNING
      • BasicState.SIGABRT
      • BasicState.SIGINT
      • BasicState.SIGTERM
      • BasicState.STOPPING
  • palaestrai.core.major_domo_broker module
    • MajorDomoBroker
      • MajorDomoBroker.HEARTBEAT_EXPIRY
      • MajorDomoBroker.HEARTBEAT_INTERVAL
      • MajorDomoBroker.HEARTBEAT_LIVENESS
      • MajorDomoBroker.INTERNAL_SERVICE_PREFIX
      • MajorDomoBroker.STORE_SHUTDOWN_SENTINEL
      • MajorDomoBroker.bind()
      • MajorDomoBroker.dispatch()
      • MajorDomoBroker.mediate()
      • MajorDomoBroker.process_client()
      • MajorDomoBroker.purge_workers()
      • MajorDomoBroker.require_worker()
      • MajorDomoBroker.send_heartbeats()
      • MajorDomoBroker.send_to_worker()
      • MajorDomoBroker.service_internal()
      • MajorDomoBroker.worker_waiting()
    • Service
    • Worker
  • palaestrai.core.major_domo_client module
    • MajorDomoClient
      • MajorDomoClient.destroy()
      • MajorDomoClient.reconnect_to_broker()
      • MajorDomoClient.send()
  • palaestrai.core.major_domo_worker module
    • MajorDomoWorker
      • MajorDomoWorker.DEFAULT_HEARTBEAT_DELAY
      • MajorDomoWorker.HEARTBEAT_LIVENESS
      • MajorDomoWorker.disconnect()
      • MajorDomoWorker.reconnect
      • MajorDomoWorker.timeout
      • MajorDomoWorker.transceive()
  • palaestrai.core.runtime_config module
    • DebugLogFilter
    • RuntimeConfig()
  • palaestrai.core.serialisation module
    • deserialize()
    • serialize()
  • palaestrai.core.zhelpers module
    • dump()
    • pprint_message()
    • set_id()
    • socket_set_hwm()
    • zpipe()
  • Module contents
• palaestrai.entrypoints package
  • Submodules
  • palaestrai.entrypoints.palaestrai_runner module
    • execute()
    • run()
  • Module contents
• palaestrai.environment package
  • palaestrai.environment.Environment: Environment Base Class
    • Environment
      • Environment.reward
      • Environment._sensor_ids
      • Environment._actuator_ids
      • Environment.done
      • Environment.mdp_service
      • Environment.name
      • Environment.reset()
      • Environment.run()
      • Environment.setup()
      • Environment.shutdown()
      • Environment.start_environment()
      • Environment.stop()
      • Environment.uid
      • Environment.update()
  • palaestrai.environment.EnvironmentBaseline: Inital Environment Data
    • EnvironmentBaseline
      • EnvironmentBaseline.sensors_available
      • EnvironmentBaseline.actuators_available
      • EnvironmentBaseline.simtime
      • EnvironmentBaseline.static_world_model
  • palaestrai.environment.EnvironmentState: Current State of an Environment
    • EnvironmentState
      • EnvironmentState.sensor_information
      • EnvironmentState.rewards
      • EnvironmentState.done
      • EnvironmentState.world_state
      • EnvironmentState.simtime
  • palaestrai.environment.DummyEnvironment: Minimal Working Dummy Environment
    • DummyEnvironment
      • DummyEnvironment.start_environment()
      • DummyEnvironment.update()
  • palaestrai.environment.EnvironmentConductor: Environment Lifecycle Management
    • EnvironmentConductor
      • EnvironmentConductor.run()
      • EnvironmentConductor.stop()
• palaestrai.experiment package
  • Submodules
  • palaestrai.experiment.executor module
    • DeadMajorDomoBrokerError
    • Executor
      • Executor.cancel()
      • Executor.execute()
      • Executor.experiment_runs()
      • Executor.schedule()
      • Executor.shutdown()
    • ExecutorState
      • ExecutorState.EXITED
      • ExecutorState.INITIALIZED
      • ExecutorState.PRISTINE
      • ExecutorState.RUNNING
      • ExecutorState.SHUTDOWN
      • ExecutorState.SIGABRT
      • ExecutorState.SIGINT
      • ExecutorState.SIGTERM
    • ExperimentRunRuntimeInformation
      • ExperimentRunRuntimeInformation.experiment_run
      • ExperimentRunRuntimeInformation.experiment_run_id
      • ExperimentRunRuntimeInformation.is_running
      • ExperimentRunRuntimeInformation.run_governor_id
      • ExperimentRunRuntimeInformation.started_at
    • ExperimentRunStartError
    • InterruptSignal
  • palaestrai.experiment.experiment_run module
    • ExperimentRun
      • ExperimentRun.SCHEMA_FILE
      • ExperimentRun.agent_conductors()
      • ExperimentRun.agent_definitions()
      • ExperimentRun.canonical_config
      • ExperimentRun.check_syntax()
      • ExperimentRun.constr_randomstate()
      • ExperimentRun.create_subseed()
      • ExperimentRun.environment_conductors()
      • ExperimentRun.from_dict()
      • ExperimentRun.get_episodes()
      • ExperimentRun.get_evaluate_every()
      • ExperimentRun.get_mode()
      • ExperimentRun.get_phase_name()
      • ExperimentRun.get_worker()
      • ExperimentRun.has_next_phase()
      • ExperimentRun.hash
      • ExperimentRun.instance_uid
      • ExperimentRun.load()
      • ExperimentRun.num_phases
      • ExperimentRun.parse_mode()
      • ExperimentRun.phase_configuration()
      • ExperimentRun.repr_randomstate()
      • ExperimentRun.save()
      • ExperimentRun.setup()
      • ExperimentRun.simulation_controllers()
    • RunDefinitionError
    • update_dict()
  • palaestrai.experiment.run_governor module
    • RunGovernor
      • RunGovernor.uid
      • RunGovernor.termination_condition
      • RunGovernor.run_broker
      • RunGovernor.experiment_run_id
      • RunGovernor.tasks
      • RunGovernor.worker
      • RunGovernor.client
      • RunGovernor.shutdown
      • RunGovernor.state
      • RunGovernor.errors
      • RunGovernor.mdp_service
      • RunGovernor.run()
      • RunGovernor.setup()
      • RunGovernor.stop()
  • palaestrai.experiment.termination_condition module
    • TerminationCondition
      • TerminationCondition.brain_flow_control()
      • TerminationCondition.check_termination()
      • TerminationCondition.environment_flow_control()
      • TerminationCondition.phase_flow_control()
  • palaestrai.experiment.vanilla_rungovernor_termination_condition module
    • VanillaRunGovernorTerminationCondition
      • VanillaRunGovernorTerminationCondition.phase_flow_control()
  • Module contents
• palaestrai.simulation package
  • Submodules
  • palaestrai.simulation.vanilla_sim_controller module
    • VanillaSimController
      • VanillaSimController.advance()
  • palaestrai.simulation.vanilla_simcontroller_termination_condition module
    • VanillaSimControllerTerminationCondition
  • Module contents
• palaestrai.store package
  • Submodules
  • palaestrai.store.database_base module
  • palaestrAI’s Object-Relational Mapper: palaestrai.store.database_model module
    • Agent
      • Agent.brain_states
      • Agent.configuration
      • Agent.experiment_run_phase
      • Agent.experiment_run_phase_id
      • Agent.id
      • Agent.muscle_actions
      • Agent.muscles
      • Agent.name
      • Agent.uid
    • BrainState
      • BrainState.agent
      • BrainState.agent_id
      • BrainState.id
      • BrainState.simtime_ticks
      • BrainState.simtime_timestamp
      • BrainState.state
      • BrainState.tag
      • BrainState.walltime
    • Environment
      • Environment.environment_conductor_uid
      • Environment.experiment_run_phase
      • Environment.experiment_run_phase_id
      • Environment.id
      • Environment.parameters
      • Environment.static_model
      • Environment.type
      • Environment.uid
      • Environment.worker_uid
      • Environment.world_states
    • Experiment
      • Experiment.document
      • Experiment.experiment_runs
      • Experiment.id
      • Experiment.name
    • ExperimentRun
      • ExperimentRun.document
      • ExperimentRun.experiment
      • ExperimentRun.experiment_id
      • ExperimentRun.experiment_run_instances
      • ExperimentRun.hash
      • ExperimentRun.id
      • ExperimentRun.uid
    • ExperimentRunInstance
      • ExperimentRunInstance.created_at
      • ExperimentRunInstance.experiment_run
      • ExperimentRunInstance.experiment_run_id
      • ExperimentRunInstance.experiment_run_phases
      • ExperimentRunInstance.id
      • ExperimentRunInstance.uid
    • ExperimentRunPhase
      • ExperimentRunPhase.agents
      • ExperimentRunPhase.configuration
      • ExperimentRunPhase.environments
      • ExperimentRunPhase.experiment_run_instance
      • ExperimentRunPhase.experiment_run_instance_id
      • ExperimentRunPhase.id
      • ExperimentRunPhase.mode
      • ExperimentRunPhase.number
      • ExperimentRunPhase.uid
    • MuscleAction
      • MuscleAction.actuator_setpoints
      • MuscleAction.agent
      • MuscleAction.agent_id
      • MuscleAction.done
      • MuscleAction.episode
      • MuscleAction.id
      • MuscleAction.mode
      • MuscleAction.objective
      • MuscleAction.rewards
      • MuscleAction.rollout_worker_uid
      • MuscleAction.sensor_readings
      • MuscleAction.simtimes
      • MuscleAction.statistics
      • MuscleAction.walltime
    • WorldState
      • WorldState.done
      • WorldState.environment
      • WorldState.environment_id
      • WorldState.episode
      • WorldState.id
      • WorldState.setpoints
      • WorldState.simtime_ticks
      • WorldState.simtime_timestamp
      • WorldState.state_dump
      • WorldState.walltime
  • palaestrai.store.database_util module
    • setup_database()
  • palaestrai.store.receiver module
    • StoreReceiver
      • StoreReceiver.MAX_RETRIES
      • StoreReceiver.SHUTDOWN_SENTINEL
      • StoreReceiver.disable()
      • StoreReceiver.run()
      • StoreReceiver.uid
      • StoreReceiver.write()
  • Module contents
• palaestrai.types package
  • Submodules
  • palaestrai.types.box module
    • Box
      • Box.from_string()
      • Box.reshape_to_space()
      • Box.scale()
      • Box.to_string()
      • Box.to_vector()
  • palaestrai.types.discrete module
    • Discrete
      • Discrete.from_string()
      • Discrete.reshape_to_space()
      • Discrete.to_string()
      • Discrete.to_vector()
  • palaestrai.types.mode module
    • Mode
      • Mode.EVALUATE
      • Mode.TEST
      • Mode.TRAIN
  • palaestrai.types.multi_binary module
    • MultiBinary
      • MultiBinary.from_string()
      • MultiBinary.reshape_to_space()
      • MultiBinary.to_string()
      • MultiBinary.to_vector()
  • palaestrai.types.multi_discrete module
    • MultiDiscrete
      • MultiDiscrete.from_string()
      • MultiDiscrete.reshape_to_space()
      • MultiDiscrete.to_string()
      • MultiDiscrete.to_vector()
  • palaestrai.types.space module
    • CanNotConvertException
    • Space
      • Space.TYPES
      • Space.contains()
      • Space.from_string()
      • Space.reshape_to_space()
      • Space.sample()
      • Space.seed()
      • Space.to_string()
      • Space.to_vector()
  • palaestrai.types.tuple module
    • Tuple
      • Tuple.from_string()
      • Tuple.reshape_to_space()
      • Tuple.to_string()
      • Tuple.to_vector()
  • Module contents
• palaestrai.util package
  • Submodules
  • palaestrai.util.dynaloader module
    • ErrorDuringImport
    • load_with_params()
    • locate()
    • safeimport()
  • palaestrai.util.exception module
    • AgentConductorFailedError
    • BrainMuscleConnectionFailedError
    • DeadChildrenRisingAsZombiesError
    • EnvConductorFailedError
    • EnvironmentHasNoUIDError
    • ExperimentAlreadyRunningError
    • ExperimentSetupFailedError
    • InitializationFailedError
    • InvalidRequestError
    • InvalidResponseError
    • NoneInputError
    • OutOfActionSpaceError
    • OutOfObservationSpaceError
    • PrematureTaskDeathError
    • ReplyIsNoneError
    • RequestIsNoneError
    • SignalInterruptError
    • SimControllerFailedError
    • SimulationSetupError
    • TasksNotFinishedError
    • UnknownModeError
  • palaestrai.util.logserver module
    • LogServer
      • LogServer.listen_port
      • LogServer.start()
      • LogServer.stop()
  • palaestrai.util.seeding module
    • create_seed()
    • hash_seed()
    • int_to_seed()
    • np_random()
  • palaestrai.util.spawn module
    • spawn_wrapper()
  • Module contents

Module contents

palaestrai.execute(*args: Any, **kwargs: Any)

palaestrai.run(*args: Any, **kwargs: Any)