nvflare.fuel.f3.stats_pool module

class CounterPool(name: str, description: str, counter_names: List[str], dynamic_counter_name=True)[source]

Bases: StatsPool

static from_dict(d: dict)[source]
get_table(mode='')[source]
increment(category: str, counter_name: str, amount=1)[source]
to_dict()[source]
class CsvRecordHandler(file_name)[source]

Bases: RecordWriter

close()[source]
static read_records(csv_file_name: str)[source]
write(pool_name: str, category: str, value: float, report_time: float)[source]
class CsvRecordReader(csv_file_name: str)[source]

Bases: object

class HistPool(name: str, description: str, marks: List[float] | Tuple, unit: str, record_writer=None)[source]

Bases: StatsPool

static from_dict(d: dict)[source]
get_table(mode='count')[source]
record_value(category: str, value: float)[source]
to_dict()[source]
class RecordWriter[source]

Bases: object

close()[source]
write(pool_name: str, category: str, value: float, report_time: float)[source]
class StatsMode[source]

Bases: object

AVERAGE = 'avg'
COUNT = 'count'
MAX = 'max'
MIN = 'min'
PERCENT = 'percent'
class StatsPool(name: str, description: str)[source]

Bases: object

static from_dict(d: dict)[source]
get_table(mode)[source]
to_dict() dict[source]
class StatsPoolManager[source]

Bases: object

classmethod add_counter_pool(name: str, description: str, counter_names: list, scope=None)[source]
classmethod add_msg_size_pool(name: str, description: str, marks=None, scope=None)[source]
classmethod add_time_hist_pool(name: str, description: str, marks=None, scope=None)[source]
classmethod close()[source]
classmethod delete_pool(name: str)[source]
classmethod dump_summary(file_name: str)[source]
classmethod from_dict(d: dict)[source]
classmethod get_pool(name: str)[source]
classmethod get_table()[source]
lock = <unlocked _thread.lock object>
pool_config = {}
pools = {}
record_writer = None
classmethod set_pool_config(config: dict)[source]
classmethod set_record_writer(record_writer: RecordWriter)[source]
classmethod to_dict()[source]
class StatsRecord(pool_name, category, report_time, value)[source]

Bases: object

format_value(v: float, n=3)[source]
new_message_size_pool(name: str, description='', marks=None, record_writer=None) HistPool[source]
new_time_pool(name: str, description='', marks=None, record_writer=None) HistPool[source]
parse_hist_mode(mode: str) str[source]