# Copyright 2020 The HuggingFace Datasets Authors and the current dataset script contributor. # # 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. """SBERT consime similarity metric.""" import evaluate import datasets import torch import torch.nn as nn _CITATION = """\ @article{Reimers2019, archivePrefix = {arXiv}, arxivId = {1908.10084}, author = {Reimers, Nils and Gurevych, Iryna}, doi = {10.18653/v1/d19-1410}, eprint = {1908.10084}, isbn = {9781950737901}, journal = {EMNLP-IJCNLP 2019 - 2019 Conference on Empirical Methods in Natural Language Processing and 9th International Joint Conference on Natural Language Processing, Proceedings of the Conference}, pages = {3982--3992}, title = {{Sentence-BERT: Sentence embeddings using siamese BERT-networks}}, year = {2019} } """ _DESCRIPTION = """\ Use SBERT to produce embedding and score the similarity by cosine similarity """ _KWARGS_DESCRIPTION = """ Calculates how semantic similarity are predictions given some references, using certain scores Args: predictions: list of predictions to score. Each predictions should be a string with tokens separated by spaces. references: list of reference for each prediction. Each reference should be a string with tokens separated by spaces. Returns: score: description of the first score, Examples: Examples should be written in doctest format, and should illustrate how to use the function. >>> sbert_cosine = evaluate.load("transZ/sbert_cosine") >>> results = my_new_module.compute(references=["Nice to meet you"], predictions=["It is my pleasure to meet you"]) >>> print(results) {'score': 0.85} """ @evaluate.utils.file_utils.add_start_docstrings(_DESCRIPTION, _KWARGS_DESCRIPTION) class sbert_cosine(evaluate.Metric): """TODO: Short description of my evaluation module.""" def _info(self): # TODO: Specifies the evaluate.EvaluationModuleInfo object return evaluate.MetricInfo( # This is the description that will appear on the modules page. module_type="metric", description=_DESCRIPTION, citation=_CITATION, inputs_description=_KWARGS_DESCRIPTION, # This defines the format of each prediction and reference features=datasets.Features({ 'predictions': datasets.Value('int64'), 'references': datasets.Value('int64'), }), # Homepage of the module for documentation homepage="http://module.homepage", # Additional links to the codebase or references codebase_urls=["http://github.com/path/to/codebase/of/new_module"], reference_urls=["http://path.to.reference.url/new_module"] ) def _download_and_prepare(self, dl_manager): """Optional: download external resources useful to compute the scores""" # TODO: Download external resources if needed pass def _compute(self, predictions, references): """Returns the scores""" # TODO: Compute the different scores of the module accuracy = sum(i == j for i, j in zip(predictions, references)) / len(predictions) return { "accuracy": accuracy, }