nvflare.app_opt.tracking.wandb.wandb_receiver module

class WandBReceiver(kwargs: dict, mode: str = 'offline', events=None, process_timeout=10)[source]

Bases: AnalyticsReceiver

Receives analytic data.

Parameters:

events (optional, List[str]) – A list of event that this receiver will handle.

check_kwargs(kwargs)[source]
finalize(fl_ctx: FLContext)[source]

Called at EventType.END_RUN.

Parameters:

fl_ctx (FLContext) – the FLContext

get_job_id_tag(group_id: str) → str[source]
get_job_queue(record_origin)[source]
initialize(fl_ctx: FLContext)[source]

Initializes the receiver.

Called after EventType.START_RUN.

Parameters:

fl_ctx (FLContext) – fl context.

job(queue)[source]
save(fl_ctx: FLContext, shareable: Shareable, record_origin: str)[source]

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.

class WandBTask(task_owner, task_type, task_data, step)[source]

Bases: tuple

Create new instance of WandBTask(task_owner, task_type, task_data, step)

step: int

Alias for field number 3

task_data: dict

Alias for field number 2

task_owner: str

Alias for field number 0

task_type: str

Alias for field number 1