Class StatsRecorder

Add stats (key-value pairs) for reporting. These values will sent these to a StatsReporter instance, which means the values will appear in the TensorBoard summary, as well as trainer gauges. You can nest stats in TensorBoard by adding "/" in the name (e.g. "Agent/Health" and "Agent/Wallet"). Note that stats are only written to TensorBoard each summary_frequency steps (a trainer configuration). If a stat is received multiple times, within that period then the values will be aggregated using the StatAggregationMethod provided.

Inheritance

Object

StatsRecorder

Namespace: Unity.MLAgents

Syntax

public sealed class StatsRecorder : object

Methods

Add(String, Single, StatAggregationMethod)

Add a stat value for reporting.

Declaration

public void Add(string key, float value, StatAggregationMethod aggregationMethod = default(StatAggregationMethod))

Parameters

Type	Name	Description
String	key	The stat name.
Single	value	The stat value. You can nest stats in TensorBoard by using "/".
StatAggregationMethod	aggregationMethod	How multiple values sent in the same summary window should be treated.