models Package

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. All required parameters must be populated in order to send to Azure.
Idle	Idle Event.null It means, that no RL action was yet available for this session.
ProblemDetails	ProblemDetails. Variables are only populated by the server, and will be ignored when sending a request.
Purpose	Purpose.
PurposeTarget	PurposeTarget.
SimulatorContext	SimulatorContext.
SimulatorInterface	It contains all the registration/creation time properties of a simulator session. All required parameters must be populated in order to send to Azure.
SimulatorSessionMilestone	SimulatorSession progress milestone.
SimulatorSessionProgress	SimulatorSession progress related to train an actual brain.
SimulatorSessionResponse	SimulatorSession model, having details of one active simulator session. All required parameters must be populated in order to send to Azure.
SimulatorSessionSummary	SimulatorSessionSummary.
SimulatorState	It contains simulator state information needed by bonsai platform in response of an action. All required parameters must be populated in order to send to Azure.
Unregister	Event asking to unregister/delete simulatorSession. You can create a new session, if you want to continue training with this simulator. param reason: Reason for unregister event. Possible values include: "Unspecified", "Finished", "Error", "NotFound". type reason: str or ~microsoft_bonsai_api.simulator.generated.models.UnregisterReason param details: Detail message for unregister event. type details: str

Enums

EpisodeFinishReason	Reason for episodeFinish
EventType	Type of Event as response to advance method.
PurposeTypesAction	An enumeration.
SimulatorContextTypesDeploymentMode	An enumeration.
SimulatorSessionTypesStatus	An enumeration.
UnregisterReason	Reason for unregister event.