57 lines
2.0 KiB
Python
57 lines
2.0 KiB
Python
# 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 typing import Any, Callable, Dict, List, Optional, Tuple, Union
|
|
|
|
from torchmetrics import Metric as _Metric
|
|
from torchmetrics.collections import MetricCollection as _MetricCollection
|
|
|
|
from pytorch_lightning.utilities.deprecation import deprecated
|
|
from pytorch_lightning.utilities.distributed import rank_zero_warn
|
|
|
|
|
|
class Metric(_Metric):
|
|
r"""
|
|
.. deprecated::
|
|
Use :class:`torchmetrics.Metric`. Will be removed in v1.5.0.
|
|
"""
|
|
|
|
def __init__(
|
|
self,
|
|
compute_on_step: bool = True,
|
|
dist_sync_on_step: bool = False,
|
|
process_group: Optional[Any] = None,
|
|
dist_sync_fn: Callable = None,
|
|
):
|
|
rank_zero_warn(
|
|
"This `Metric` was deprecated since v1.3.0 in favor of `torchmetrics.Metric`."
|
|
" It will be removed in v1.5.0", DeprecationWarning
|
|
)
|
|
super(Metric, self).__init__(
|
|
compute_on_step=compute_on_step,
|
|
dist_sync_on_step=dist_sync_on_step,
|
|
process_group=process_group,
|
|
dist_sync_fn=dist_sync_fn,
|
|
)
|
|
|
|
|
|
class MetricCollection(_MetricCollection):
|
|
"""
|
|
.. deprecated::
|
|
Use :class:`torchmetrics.MetricCollection`. Will be removed in v1.5.0.
|
|
"""
|
|
|
|
@deprecated(target=_MetricCollection, ver_deprecate="1.3.0", ver_remove="1.5.0")
|
|
def __init__(self, metrics: Union[List[Metric], Tuple[Metric], Dict[str, Metric]]):
|
|
pass
|