nvflare.apis.fl_snapshot module¶
- class FLSnapshot[source]¶
Bases:
object
FLSnapshot keeps a snapshot of all the current running FL application RunSnapshots.
- The format is:
{ job_id: RunSnapshot }
- add_snapshot(job_id: str, snapshot: RunSnapshot)[source]¶
Add the RunSnapshot for job_id to the FLSnapshot.
- Parameters:
job_id – the job_id
snapshot – snapshot of the Run
Returns:
- get_snapshot(job_id: str) RunSnapshot [source]¶
Get the RunSnapshot for job_id to the FLSnapshot.
- Parameters:
job_id – the job_id
Returns: Snapshot of the Run
- class RunSnapshot(job_id: str)[source]¶
Bases:
object
RunSnapshot keeps a snapshot of all the FLComponent states.
- The format is:
{ component_id: component_state_dict }