# 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.
import os
from typing import Dict, List, Union
import numpy as np
from nvflare.apis.dxo import DXO, DataKind
from nvflare.apis.fl_constant import FLContextKey
from nvflare.apis.fl_context import FLContext
from nvflare.app_common.abstract.model_locator import ModelLocator
from nvflare.security.logging import secure_format_exception
from .constants import NPConstants
[docs]class NPModelLocator(ModelLocator):
SERVER_MODEL_NAME = "server"
def __init__(self, model_dir="models", model_name: Union[str, Dict[str, str]] = "server.npy"):
"""The ModelLocator's job is to find the models to be included for cross site evaluation
located on server. This NPModelLocator finds and extracts "server" model that is saved during training.
Args:
model_dir (str): Directory to look for models in. Defaults to "model"
model_name (Union[str, Dict[str, str]]). Name of the model. Defaults to "server.npy", or a list of
model names and locations
"""
super().__init__()
self.model_dir = model_dir
if model_name is None:
self.model_file_name = {NPModelLocator.SERVER_MODEL_NAME: "server.npy"}
elif isinstance(model_name, str):
self.model_file_name = {NPModelLocator.SERVER_MODEL_NAME: model_name}
elif isinstance(model_name, dict):
self.model_file_name = model_name
else:
raise ValueError(f"model_name must be a str, or a Dict[str, str]. But got: {type(model_name)}")
[docs] def get_model_names(self, fl_ctx: FLContext) -> List[str]:
"""Returns the list of model names that should be included from server in cross site validation.add()
Args:
fl_ctx (FLContext): FL Context object.
Returns:
List[str]: List of model names.
"""
return list(self.model_file_name.keys())
[docs] def locate_model(self, model_name, fl_ctx: FLContext) -> DXO:
dxo = None
engine = fl_ctx.get_engine()
if model_name in list(self.model_file_name.keys()):
try:
job_id = fl_ctx.get_prop(FLContextKey.CURRENT_RUN)
run_dir = engine.get_workspace().get_run_dir(job_id)
model_path = os.path.join(run_dir, self.model_dir)
model_load_path = os.path.join(model_path, self.model_file_name[model_name])
np_data = None
try:
np_data = np.load(model_load_path, allow_pickle=False)
self.log_info(fl_ctx, f"Loaded {model_name} model from {model_load_path}.")
except Exception as e:
self.log_error(fl_ctx, f"Unable to load NP Model: {secure_format_exception(e)}.")
if np_data is not None:
weights = {NPConstants.NUMPY_KEY: np_data}
dxo = DXO(data_kind=DataKind.WEIGHTS, data=weights, meta={})
except Exception as e:
self.log_exception(
fl_ctx,
f"Exception in retrieving {NPModelLocator.SERVER_MODEL_NAME} model: {secure_format_exception(e)}.",
)
return dxo