Skip to content

RewardCallback

Full path: schola.scripts.sb3.utils.RewardCallback

schola.scripts.sb3.utils.RewardCallback

RewardCallback

RewardCallback(verbose=0, frequency=10, num_envs=1)

Bases: CallbackList

Callback for logging rewards and steps taken by each environment in a multi-env setting.

Parameters

verbose (int, default=0) : Verbosity level.

frequency (int, default=10) : The frequency at which to log the rewards and steps taken.

num_envs (int, default=1) : The number of environments to log rewards and steps for.

num_envs

num_envs

The number of environments to log rewards and steps for.

Type

  • int

callbacks

callbacks

The list of RewardLoggingCallbacks for each environment.

Type

  • List[SingleEnvRewardCallback]

summarize_every

summarize_every

The frequency at which to log the rewards and steps taken.

Type

  • int

curr_logging_interval

curr_logging_interval

The current logging interval.

Type

  • int

start_time

start_time

The time at which the callback was created.

Type

  • int

Methods

ItemDescription
init

Attributes

ItemDescription
ready_to_logReturns whether all environments are ready to log.

init

__init__(verbose=0, frequency=10, num_envs=1)

Parameters

verbose (int)

frequency (int)

num_envs (int)


ready_to_log

ready_to_log: bool

Returns whether all environments are ready to log.