# Copyright 2020 The TensorTrade 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 abc import ABCMeta, abstractmethod
from typing import List
from tensortrade.core import Component
[docs]class Renderer(Component, metaclass=ABCMeta):
"""A component for rendering a view of the environment at each step of
an episode."""
registered_name = "renderer"
[docs] @abstractmethod
def render(self, env: 'TradingEnv', **kwargs):
"""Renders a view of the environment at the current step of an episode.
Parameters
----------
env: 'TradingEnv'
The trading environment.
kwargs : keyword arguments
Additional keyword arguments for rendering the environment.
"""
raise NotImplementedError()
[docs] def save(self) -> None:
"""Saves the rendered view of the environment."""
pass
[docs] def reset(self) -> None:
"""Resets the renderer."""
pass
[docs] def close(self) -> None:
"""Closes the renderer."""
pass
[docs]class AggregateRenderer(Renderer):
"""A renderer that aggregates compatible renderers so they can all be used
to render a view of the environment.
Parameters
----------
renderers : List[Renderer]
A list of renderers to aggregate.
Attributes
----------
renderers : List[Renderer]
A list of renderers to aggregate.
"""
def __init__(self, renderers: List[Renderer]) -> None:
super().__init__()
self.renderers = renderers
[docs] def render(self, env: 'TradingEnv', **kwargs) -> None:
for r in self.renderers:
r.render(env, **kwargs)
[docs] def save(self) -> None:
for r in self.renderers:
r.save()
[docs] def reset(self) -> None:
for r in self.renderers:
r.reset()
[docs] def close(self) -> None:
for r in self.renderers:
r.close()