Shortcuts

Source code for flash.core.data.io.output

# Copyright The PyTorch Lightning team.
#
# 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 typing import Any

import flash
from flash.core.data.properties import Properties


[docs]class Output(Properties): """An :class:`.Output` encapsulates a single :meth:`~flash.core.data.io.output.Output.transform` method which is used to convert the model output into the desired output format when predicting."""
[docs] @classmethod @abstractmethod def from_task(cls, task: "flash.Task", **kwargs) -> "Output": """Instantiate the output from the given :class:`~flash.core.model.Task`.""" return cls()
[docs] @staticmethod def transform(sample: Any) -> Any: """Convert the given sample into the desired output format. Args: sample: The output from the :class:`.OutputTransform`. Returns: The converted output. """ return sample
def __call__(self, sample: Any) -> Any: return self.transform(sample)

© Copyright 2020-2021, PyTorch Lightning. Revision da42a635.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: stable
Versions
latest
stable
0.8.0
0.7.5
0.7.4
0.7.3
0.7.2
0.7.1
0.7.0
0.6.0
0.5.2
0.5.1
0.5.0
0.4.0
0.3.2
0.3.1
0.3.0
0.2.3
0.2.2
0.2.1
0.2.0
0.1.0post1
Downloads
html
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.