aac_metrics.download module

download_metrics(
*,
cache_path: str | Path | None = None,
tmp_path: str | Path | None = None,
clean_archives: bool = True,
ptb_tokenizer: bool = True,
meteor: bool = True,
spice: bool = True,
fense: bool = True,
bert_score: bool = True,
clap: bool = True,
force: bool = False,
verbose: int = 0,
) → None[source]

Download the code needed for SPICE, METEOR, PTB Tokenizer and FENSE.

Parameters:

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

  • tmp_path – The path to a temporary directory. defaults to the value returned by get_default_tmp_path().

  • clean_archives – If True, remove all archives files. defaults to True.

  • ptb_tokenizer – If True, downloads the PTBTokenizer code in cache directory. defaults to True.

  • meteor – If True, downloads the METEOR code in cache directory. defaults to True.

  • spice – If True, downloads the SPICE code in cache directory. defaults to True.

  • fense – If True, downloads the FENSE models. defaults to True.

  • bert_score – If True, downloads the BERTScore model. defaults to True.

  • force – If True, force to download files and extract archives again even if they are already present on disk. Works only for PTBTokenizer, METEOR and SPICE files. defaults to False.

  • verbose – The verbose level. defaults to 0.