Source code for tensortrade.env.stoppers.abstract

# Copyright 2024 The TensorTrade and TensorTrade-NG Authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License
from __future__ import annotations

from abc import abstractmethod

from tensortrade.core.base import TimeIndexed
from tensortrade.core.component import Component
from tensortrade.env.mixins.scheme import SchemeMixin



[docs]
class AbstractStopper(SchemeMixin, Component, TimeIndexed):
    """A component for determining if the environment satisfies a defined
    stopping criteria.
    """

    registered_name = "stopper"


[docs]
    @abstractmethod
    def stop(self) -> bool:
        """Computes if the environment satisfies the defined stopping criteria.
        :return: If the environment should stop or continue.
        :rtype: bool
        """
        raise NotImplementedError()



[docs]
    def reset(self) -> None:
        """Resets the stopper."""
        pass