Source code for tensortrade.env.utils.obs_state

# Copyright 2024 The 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

import typing

from dataclasses import dataclass

if typing.TYPE_CHECKING:
    from typing import Any, Dict, Optional, SupportsFloat

    from gymnasium.core import ObsType


[docs]
@dataclass
class ObsState:
    observation: ObsType
    info: Dict[str, Any]
    reward: Optional[SupportsFloat] = None
    terminated: bool = False