memorax.loggers.DashboardLogger

memorax.loggers.DashboardLogger#

class memorax.loggers.DashboardLogger[source]#

Bases: BaseLogger[DashboardLoggerState]

DashboardLogger(title: Optional[str], name: Optional[str] = None, total_timesteps: int = 0, refresh_per_second: int = 10, env_id: Optional[str] = None)

title: str | None#
name: str | None = None#
total_timesteps: int = 0#
refresh_per_second: int = 10#
env_id: str | None = None#
init(**kwargs)[source]#
Return type:

DashboardLoggerState

log(state, data, step)[source]#
Return type:

DashboardLoggerState

Parameters:

  • state (DashboardLoggerState)

  • data (Any)

  • step (int)

emit(state)[source]#
Return type:

DashboardLoggerState

Parameters:

state (DashboardLoggerState)

finish(state)[source]#
Return type:

None

Parameters:

state (DashboardLoggerState)

get_dashboard(stats, progress, task)[source]#
Return type:

Table

Parameters:
classmethod __class_getitem__(params)#

Parameterizes a generic class.

At least, parameterizing a generic class is the main thing this method does. For example, for some generic class Foo, this is called when we do Foo[int] - there, with cls=Foo and params=int.

However, note that this method is also called when defining generic classes in the first place with class Foo(Generic[T]): ….

__init__(title, name=None, total_timesteps=0, refresh_per_second=10, env_id=None)#
Parameters:

  • title (str | None)

  • name (str | None)

  • total_timesteps (int)

  • refresh_per_second (int)

  • env_id (str | None)

Return type:

None

replace(**updates)#

Returns a new object replacing the specified fields with new values.

Contents