nvflare.app_opt.tracking.tb.tb_receiver module

class TBAnalyticsReceiver(tb_folder='tb_events', events: List[str] | None = None)

Bases: AnalyticsReceiver

Receives analytics data to save to TensorBoard.

Parameters:

• tb_folder (str) – the folder to store tensorboard files.

• events (optional, List[str]) – A list of events to be handled by this receiver.

Folder structure

Inside run_XX folder:
  - workspace
    - run_01 (already created):
      - output_dir (default: tb_events):
        - peer_name_1:
        - peer_name_2:

    - run_02 (already created):
      - output_dir (default: tb_events):
        - peer_name_1:
        - peer_name_2:

finalize(fl_ctx: FLContext)

Finalizes the receiver.

Called after EventType.END_RUN.

Parameters:

fl_ctx (FLContext) – fl context.

initialize(fl_ctx: FLContext)

Initializes the receiver.

Called after EventType.START_RUN.

Parameters:

fl_ctx (FLContext) – fl context.

save(fl_ctx: FLContext, shareable: Shareable, record_origin)

Saves the received data.

Specific implementations of AnalyticsReceiver will implement save in their own way.

Parameters:

• fl_ctx (FLContext) – fl context.

• shareable (Shareable) – the received message.

• record_origin (str) – the sender of this message / record.