# Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
[docs]class RunSnapshot:
"""RunSnapshot keeps a snapshot of all the FLComponent states.
The format is:
{ component_id: component_state_dict }
"""
def __init__(self, job_id: str):
super().__init__()
self.component_states = {}
self.completed = False
self.job_id = job_id
[docs] def get_component_snapshot(self, component_id: str) -> dict:
"""Get a state snapshot of a particular FL component.
Args:
component_id: Component ID
Returns:
A component state dict.
"""
return self.component_states.get(component_id)
[docs] def set_component_snapshot(self, component_id: str, component_state: dict):
"""Set the snapshot of a particular FL component.
Args:
component_id: Component ID
component_state: component state dict
"""
self.component_states[component_id] = component_state
[docs] def get_snapshot(self) -> dict:
return self.component_states
[docs]class FLSnapshot:
"""FLSnapshot keeps a snapshot of all the current running FL application RunSnapshots.
The format is:
{ job_id: RunSnapshot }
"""
def __init__(self):
super().__init__()
self.run_snapshots = {}
[docs] def add_snapshot(self, job_id: str, snapshot: RunSnapshot):
"""Add the RunSnapshot for job_id to the FLSnapshot.
Args:
job_id: the job_id
snapshot: snapshot of the Run
Returns:
"""
self.run_snapshots[job_id] = snapshot
[docs] def get_snapshot(self, job_id: str) -> RunSnapshot:
"""Get the RunSnapshot for job_id to the FLSnapshot.
Args:
job_id: the job_id
Returns: Snapshot of the Run
"""
return self.run_snapshots.get(job_id)
[docs] def remove_snapshot(self, job_id: str):
"""Remove the RunSnapshot of job_id from the FLSnapshot.
Args:
job_id: the job_id
Returns:
"""
if job_id in self.run_snapshots.keys():
self.run_snapshots.pop(job_id)