nvflare.fuel.f3.stats_pool module

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

Bases: StatsPool

static from_dict(d: dict)

get_table(mode='')

increment(category: str, counter_name: str, amount=1)

to_dict()

class CsvRecordHandler(file_name)

Bases: RecordWriter

close()

static read_records(csv_file_name: str)

write(pool_name: str, category: str, value: float, report_time: float)

class CsvRecordReader(csv_file_name: str)

Bases: object

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

Bases: StatsPool

static from_dict(d: dict)

get_table(mode='count')

record_value(category: str, value: float)

to_dict()

class RecordWriter

Bases: object

close()

write(pool_name: str, category: str, value: float, report_time: float)

class StatsMode

Bases: object

AVERAGE = 'avg'

COUNT = 'count'

MAX = 'max'

MIN = 'min'

PERCENT = 'percent'

class StatsPool(name: str, description: str)

Bases: object

static from_dict(d: dict)

get_table(mode)

to_dict() → dict

class StatsPoolManager

Bases: object

classmethod add_counter_pool(name: str, description: str, counter_names: list, scope=None)

classmethod add_msg_size_pool(name: str, description: str, marks=None, scope=None)

classmethod add_time_hist_pool(name: str, description: str, marks=None, scope=None)

classmethod close()

classmethod delete_pool(name: str)

classmethod dump_summary(file_name: str)

classmethod from_dict(d: dict)

classmethod get_pool(name: str)

classmethod get_table()

lock = <unlocked _thread.lock object>

pool_config = {}

pools = {'received_stream_counters': <nvflare.fuel.f3.stats_pool.CounterPool object>, 'received_stream_sizes': <nvflare.fuel.f3.stats_pool.HistPool object>, 'sent_stream_counters': <nvflare.fuel.f3.stats_pool.CounterPool object>, 'sent_stream_sizes': <nvflare.fuel.f3.stats_pool.HistPool object>}

record_writer = None

classmethod set_pool_config(config: dict)

classmethod set_record_writer(record_writer: RecordWriter)

classmethod to_dict()

class StatsRecord(pool_name, category, report_time, value)

Bases: object

format_value(v: float, n=3)

new_message_size_pool(name: str, description='', marks=None, record_writer=None) → HistPool

new_time_pool(name: str, description='', marks=None, record_writer=None) → HistPool

parse_hist_mode(mode: str) → str