microsoft.bonsai.simulatorapi.models

Code generated by Microsoft (R) AutoRest Code Generator. Changes may cause incorrect behavior and will be lost if the code is regenerated.

This package contains the models classes for SimulatorAPI. This API allows simulators to provide states and receive commands from the platform.

Classes

EpisodeFinish	EpisodeFinish event signalling current episode is finished.
EpisodeStart	EpisodeStart event. It's sent when a new episode need to be started.
EpisodeStep	EpisodeStep event for stepping inthe simulation. this is sent when there is an ongoing active episode.
Event	RL action returned by bonsai platform when it got new state from simulator session.
Idle	Idle Event.null It means, that no RL action was yet available for this session.
ProblemDetails	The ProblemDetails model.
ProblemDetailsException	Exception thrown for an invalid response with ProblemDetails information.
Purpose	The purpose for existing, from the standpoint of a simulator instance or brain version.
PurposeTarget	This structure describes the "target" of the simulator; i.e., what trainable construct(s) it exists to service.
SimulatorContext	This structure is passed (as a string) to a simulator running when launched by the Socrates backend.
SimulatorInterface	It contains all the registration/creation time properties of a simulator session.
SimulatorSessionMilestone	SimulatorSession progress milestone.
SimulatorSessionProgress	SimulatorSession progress related to train an actual brain.
SimulatorSessionResponse	SimulatorSession model, having details of one active simulator session.
SimulatorSessionSummary	A summary of a SimulatorSession, returned from ListSessions.
SimulatorState	It contains simulator state information needed by bonsai platform in response of an action.
Unregister	Event asking to unregister/delete simulatorSession. You can create a new session, if you want to continue training with this simulator.

Enums

EpisodeFinishReason	Defines values for EpisodeFinishReason.
EventType	Defines values for EventType.
PurposeTypesAction	Defines values for PurposeTypesAction.
SimulatorContextTypesDeploymentMode	Defines values for SimulatorContextTypesDeploymentMode.
SimulatorSessionTypesStatus	Defines values for SimulatorSessionTypesStatus.
UnregisterReason	Defines values for UnregisterReason.