31 lines
1.1 KiB
Python
31 lines
1.1 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.
|
|
import torch
|
|
from torchmetrics.functional import embedding_similarity as _embedding_similarity
|
|
|
|
from pytorch_lightning.utilities.deprecation import deprecated
|
|
|
|
|
|
@deprecated(target=_embedding_similarity, ver_deprecate="1.3.0", ver_remove="1.5.0")
|
|
def embedding_similarity(
|
|
batch: torch.Tensor,
|
|
similarity: str = 'cosine',
|
|
reduction: str = 'none',
|
|
zero_diagonal: bool = True
|
|
) -> torch.Tensor:
|
|
"""
|
|
.. deprecated::
|
|
Use :func:`torchmetrics.functional.embedding_similarity`. Will be removed in v1.5.0.
|
|
"""
|