tensortrade.env.actions.abstract module¶

class tensortrade.env.actions.abstract.AbstractActionScheme(*args, **kwargs)[source]¶

Bases: SchemeMixin, Component, TimeIndexed

An abstract base class for any ActionScheme that wants to be compatible with the built-in OMS.

The structure of the action scheme is built to make sure that action space can be used with the system, provided that the user defines the methods to interpret that action.

abstract property action_space: Space¶

The action space of the TradingEnv.

Returns:: The gymnasium action space of the TradingEnv.
Return type:: Space

abstract get_orders(action: ActType) → List[Order][source]¶

Gets the list of orders to be submitted for the given action.

Parameters:: action (gymnasium.core.ActType) – The action to be interpreted.
Returns:: A list of orders to be submitted to the broker.
Return type:: List[Order]

perform_action(action: ActType) → None[source]¶

Performs the action on the given environment.

Parameters:: action (ActType) – The action selected by the agent to perform on the environment.

registered_name = 'action_scheme'¶

reset() → None[source]¶: Performs a reset on the action scheme. Will be called when TradingEnv is reset.