Source code for nvflare.app_common.abstract.formatter

# Copyright (c) 2021, 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 abstractmethod

from nvflare.apis.fl_component import FLComponent
from nvflare.apis.fl_context import FLContext


[docs]class Formatter(FLComponent):
[docs]    @abstractmethod
    def format(self, fl_ctx: FLContext) -> str:
        """Format the data into human readable string.

        Args:
            fl_ctx (FLContext): FL Context object.

        Returns:
            str: Human readable string.
        """
        pass