# 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.
from abc import ABC, abstractmethod
from typing import Tuple
from .fl_context import FLContext
[docs]class ResourceConsumerSpec(ABC):
[docs] @abstractmethod
def consume(self, resources: dict):
pass
[docs]class ResourceManagerSpec(ABC):
[docs] @abstractmethod
def check_resources(self, resource_requirement: dict, fl_ctx: FLContext) -> Tuple[bool, str]:
"""Checks whether the specified resource requirement can be satisfied.
Args:
resource_requirement: a dict that specifies resource requirement
fl_ctx: the FLContext
Returns:
A tuple of (is_resource_enough, token).
is_resource_enough is a bool indicates whether there is enough resources;
token is for resource reservation / cancellation for this check request.
"""
pass
[docs] @abstractmethod
def cancel_resources(self, resource_requirement: dict, token: str, fl_ctx: FLContext):
"""Cancels reserved resources if any.
Args:
resource_requirement: a dict that specifies resource requirement
token: a resource reservation token returned by check_resources
fl_ctx: the FLContext
Note:
If check_resource didn't return a token, then don't need to call this method
"""
pass
[docs] @abstractmethod
def allocate_resources(self, resource_requirement: dict, token: str, fl_ctx: FLContext) -> dict:
"""Allocates resources.
Note:
resource requirements and resources may be different things.
Args:
resource_requirement: a dict that specifies resource requirement
token: a resource reservation token returned by check_resources
fl_ctx: the FLContext
Returns:
A dict of allocated resources
"""
pass
[docs] @abstractmethod
def free_resources(self, resources: dict, token: str, fl_ctx: FLContext):
"""Frees resources.
Args:
resources: resources to be freed
token: a resource reservation token returned by check_resources
fl_ctx: the FLContext
"""
pass
[docs] @abstractmethod
def report_resources(self, fl_ctx) -> dict:
"""Reports resources."""
pass