aac_metrics.functional.spider_max module¶

class SPIDErMaxScores¶

Bases: dict

cider_d_max : Tensor¶

spice_max : Tensor¶

spider_max : Tensor¶

spider_max(mult_candidates: list[list[str]], mult_references: list[list[str]], return_all_scores: bool = True, *, return_all_cands_scores: bool = False, n: int = 4, sigma: float = 6.0, tokenizer: ~typing.Callable[[str], list[str]] = <method 'split' of 'str' objects>, return_tfidf: bool = False, cache_path: str | ~pathlib.Path | None = None, java_path: str | ~pathlib.Path | None = None, tmp_path: str | ~pathlib.Path | None = None, n_threads: int | None = None, java_max_memory: str = '8G', timeout: None | int | ~typing.Iterable[int] = None, verbose: int = 0) → tuple[SPIDErMaxScores, SPIDErMaxScores] | Tensor[source]¶

SPIDEr-max function.

Compute the maximal SPIDEr score accross multiple candidates.

• Paper: https://dcase.community/documents/workshop2022/proceedings/DCASE2022Workshop_Labbe_46.pdf

Warning

This metric requires at least 2 candidates with 2 sets of references, otherwise it will raises a ValueError.

Parameters:¶

mult_candidates

The list of list of sentences to evaluate.

mult_references

The list of list of sentences used as target.

return_all_scores

If True, returns a tuple containing the globals and locals scores. Otherwise returns a scalar tensor containing the main global score. defaults to True.

return_all_cands_scores

If True, returns all multiple candidates scores in sents_scores outputs as tensor of shape (n_audio, n_cands_per_audio). defaults to False.

n

Maximal number of n-grams taken into account. defaults to 4.

sigma

Standard deviation parameter used for gaussian penalty. defaults to 6.0.

tokenizer

The fast tokenizer used to split sentences into words. defaults to str.split.

return_tfidf

If True, returns the list of dictionaries containing the tf-idf scores of n-grams in the sents_score output. defaults to False.

cache_path

The path to the external code directory. defaults to the value returned by get_default_cache_path().

java_path

The path to the java executable. defaults to the value returned by get_default_java_path().

tmp_path

Temporary directory path. defaults to the value returned by get_default_tmp_path().

java_max_memory

The maximal java memory used. defaults to “8G”.

n_threads

Number of threads used to compute SPICE. None value will use the default value of the java program. defaults to None.

timeout

The number of seconds before killing the java subprogram. If a list is given, it will restart the program if the i-th timeout is reached. If None, no timeout will be used. defaults to None.

verbose

The verbose level. defaults to 0.

Returns:¶

A tuple of globals and locals scores or a scalar tensor with the main global score.