73 lines
2.5 KiB
Python
73 lines
2.5 KiB
Python
import os
|
|
from typing import TYPE_CHECKING, Optional
|
|
|
|
from ray.rllib.utils.annotations import PublicAPI
|
|
|
|
if TYPE_CHECKING:
|
|
from ray.rllib.algorithms.algorithm_config import AlgorithmConfig
|
|
from ray.rllib.evaluation.rollout_worker import RolloutWorker
|
|
from ray.rllib.evaluation.sampler import SamplerInput
|
|
|
|
|
|
@PublicAPI
|
|
class IOContext:
|
|
"""Class containing attributes to pass to input/output class constructors.
|
|
|
|
RLlib auto-sets these attributes when constructing input/output classes,
|
|
such as InputReaders and OutputWriters.
|
|
"""
|
|
|
|
@PublicAPI
|
|
def __init__(
|
|
self,
|
|
log_dir: Optional[str] = None,
|
|
config: Optional["AlgorithmConfig"] = None,
|
|
worker_index: int = 0,
|
|
worker: Optional["RolloutWorker"] = None,
|
|
):
|
|
"""Initializes a IOContext object.
|
|
|
|
Args:
|
|
log_dir: The logging directory to read from/write to.
|
|
config: The (main) AlgorithmConfig object.
|
|
worker_index: When there are multiple workers created, this
|
|
uniquely identifies the current worker. 0 for the local
|
|
worker, >0 for any of the remote workers.
|
|
worker: The RolloutWorker object reference.
|
|
"""
|
|
from ray.rllib.algorithms.algorithm_config import AlgorithmConfig
|
|
|
|
self.log_dir = log_dir or os.getcwd()
|
|
# In case no config is provided, use the default one, but set
|
|
# `actions_in_input_normalized=True` if we don't have a worker.
|
|
# Not having a worker and/or a config should only be the case in some test
|
|
# cases, though.
|
|
self.config = config or AlgorithmConfig().offline_data(
|
|
actions_in_input_normalized=worker is None
|
|
).training(train_batch_size=1)
|
|
self.worker_index = worker_index
|
|
self.worker = worker
|
|
|
|
@PublicAPI
|
|
def default_sampler_input(self) -> Optional["SamplerInput"]:
|
|
"""Returns the RolloutWorker's SamplerInput object, if any.
|
|
|
|
Returns None if the RolloutWorker has no SamplerInput. Note that local
|
|
workers in case there are also one or more remote workers by default
|
|
do not create a SamplerInput object.
|
|
|
|
Returns:
|
|
The RolloutWorkers' SamplerInput object or None if none exists.
|
|
"""
|
|
return self.worker.sampler
|
|
|
|
@property
|
|
@PublicAPI
|
|
def input_config(self):
|
|
return self.config.get("input_config", {})
|
|
|
|
@property
|
|
@PublicAPI
|
|
def output_config(self):
|
|
return self.config.get("output_config", {})
|