API

• aac_metrics package
  • AACMetric
    • AACMetric.compute()
    • AACMetric.forward()
    • AACMetric.full_state_update
    • AACMetric.higher_is_better
    • AACMetric.is_differentiable
    • AACMetric.max_value
    • AACMetric.min_value
    • AACMetric.reset()
    • AACMetric.update()
  • BERTScoreMRefs
    • BERTScoreMRefs.compute()
    • BERTScoreMRefs.extra_repr()
    • BERTScoreMRefs.full_state_update
    • BERTScoreMRefs.get_output_names()
    • BERTScoreMRefs.higher_is_better
    • BERTScoreMRefs.is_differentiable
    • BERTScoreMRefs.max_value
    • BERTScoreMRefs.min_value
    • BERTScoreMRefs.reset()
    • BERTScoreMRefs.update()
  • BLEU
    • BLEU.compute()
    • BLEU.extra_repr()
    • BLEU.full_state_update
    • BLEU.get_output_names()
    • BLEU.higher_is_better
    • BLEU.is_differentiable
    • BLEU.max_value
    • BLEU.min_value
    • BLEU.reset()
    • BLEU.update()
  • BLEU1
  • BLEU2
  • BLEU3
  • BLEU4
  • CIDErD
    • CIDErD.compute()
    • CIDErD.extra_repr()
    • CIDErD.full_state_update
    • CIDErD.get_output_names()
    • CIDErD.higher_is_better
    • CIDErD.is_differentiable
    • CIDErD.max_value
    • CIDErD.min_value
    • CIDErD.reset()
    • CIDErD.update()
  • CLAPSim
    • CLAPSim.compute()
    • CLAPSim.extra_repr()
    • CLAPSim.full_state_update
    • CLAPSim.get_output_names()
    • CLAPSim.higher_is_better
    • CLAPSim.is_differentiable
    • CLAPSim.max_value
    • CLAPSim.min_value
    • CLAPSim.reset()
    • CLAPSim.update()
  • DCASE2023Evaluate
  • DCASE2024Evaluate
  • Evaluate
    • Evaluate.compute()
    • Evaluate.full_state_update
    • Evaluate.higher_is_better
    • Evaluate.is_differentiable
    • Evaluate.reset()
    • Evaluate.tolist()
    • Evaluate.update()
  • FENSE
    • FENSE.compute()
    • FENSE.extra_repr()
    • FENSE.full_state_update
    • FENSE.get_output_names()
    • FENSE.higher_is_better
    • FENSE.is_differentiable
    • FENSE.max_value
    • FENSE.min_value
    • FENSE.reset()
    • FENSE.update()
  • FER
    • FER.compute()
    • FER.extra_repr()
    • FER.full_state_update
    • FER.get_output_names()
    • FER.higher_is_better
    • FER.is_differentiable
    • FER.max_value
    • FER.min_value
    • FER.reset()
    • FER.update()
  • MACE
    • MACE.compute()
    • MACE.extra_repr()
    • MACE.full_state_update
    • MACE.get_output_names()
    • MACE.higher_is_better
    • MACE.is_differentiable
    • MACE.max_value
    • MACE.min_value
    • MACE.reset()
    • MACE.update()
  • METEOR
    • METEOR.compute()
    • METEOR.extra_repr()
    • METEOR.full_state_update
    • METEOR.get_output_names()
    • METEOR.higher_is_better
    • METEOR.is_differentiable
    • METEOR.max_value
    • METEOR.min_value
    • METEOR.reset()
    • METEOR.update()
  • ROUGEL
    • ROUGEL.compute()
    • ROUGEL.extra_repr()
    • ROUGEL.full_state_update
    • ROUGEL.get_output_names()
    • ROUGEL.higher_is_better
    • ROUGEL.is_differentiable
    • ROUGEL.max_value
    • ROUGEL.min_value
    • ROUGEL.reset()
    • ROUGEL.update()
  • SBERTSim
    • SBERTSim.compute()
    • SBERTSim.extra_repr()
    • SBERTSim.full_state_update
    • SBERTSim.get_output_names()
    • SBERTSim.higher_is_better
    • SBERTSim.is_differentiable
    • SBERTSim.max_value
    • SBERTSim.min_value
    • SBERTSim.reset()
    • SBERTSim.update()
  • SPICE
    • SPICE.compute()
    • SPICE.extra_repr()
    • SPICE.full_state_update
    • SPICE.get_output_names()
    • SPICE.higher_is_better
    • SPICE.is_differentiable
    • SPICE.max_value
    • SPICE.min_value
    • SPICE.reset()
    • SPICE.update()
  • SPIDEr
    • SPIDEr.compute()
    • SPIDEr.extra_repr()
    • SPIDEr.full_state_update
    • SPIDEr.get_output_names()
    • SPIDEr.higher_is_better
    • SPIDEr.is_differentiable
    • SPIDEr.max_value
    • SPIDEr.min_value
    • SPIDEr.reset()
    • SPIDEr.update()
  • SPIDErFL
    • SPIDErFL.compute()
    • SPIDErFL.extra_repr()
    • SPIDErFL.full_state_update
    • SPIDErFL.get_output_names()
    • SPIDErFL.higher_is_better
    • SPIDErFL.is_differentiable
    • SPIDErFL.max_value
    • SPIDErFL.min_value
    • SPIDErFL.reset()
    • SPIDErFL.update()
  • SPIDErMax
    • SPIDErMax.compute()
    • SPIDErMax.extra_repr()
    • SPIDErMax.full_state_update
    • SPIDErMax.get_output_names()
    • SPIDErMax.higher_is_better
    • SPIDErMax.is_differentiable
    • SPIDErMax.max_value
    • SPIDErMax.min_value
    • SPIDErMax.reset()
    • SPIDErMax.update()
  • Vocab
    • Vocab.compute()
    • Vocab.full_state_update
    • Vocab.get_output_names()
    • Vocab.higher_is_better
    • Vocab.is_differentiable
    • Vocab.max_value
    • Vocab.min_value
    • Vocab.reset()
    • Vocab.update()
  • dcase2023_evaluate()
  • dcase2024_evaluate()
  • evaluate()
  • get_default_cache_path()
  • get_default_java_path()
  • get_default_tmp_path()
  • list_metrics_available()
  • load_metric()
  • set_default_cache_path()
  • set_default_java_path()
  • set_default_tmp_path()
  • Subpackages
    • aac_metrics.classes package
      • BERTScoreMRefs
        • BERTScoreMRefs.compute()
        • BERTScoreMRefs.extra_repr()
        • BERTScoreMRefs.full_state_update
        • BERTScoreMRefs.get_output_names()
        • BERTScoreMRefs.higher_is_better
        • BERTScoreMRefs.is_differentiable
        • BERTScoreMRefs.max_value
        • BERTScoreMRefs.min_value
        • BERTScoreMRefs.reset()
        • BERTScoreMRefs.training
        • BERTScoreMRefs.update()
      • BLEU
        • BLEU.compute()
        • BLEU.extra_repr()
        • BLEU.full_state_update
        • BLEU.get_output_names()
        • BLEU.higher_is_better
        • BLEU.is_differentiable
        • BLEU.max_value
        • BLEU.min_value
        • BLEU.reset()
        • BLEU.training
        • BLEU.update()
      • BLEU1
      • BLEU2
      • BLEU3
      • BLEU4
      • CIDErD
        • CIDErD.compute()
        • CIDErD.extra_repr()
        • CIDErD.full_state_update
        • CIDErD.get_output_names()
        • CIDErD.higher_is_better
        • CIDErD.is_differentiable
        • CIDErD.max_value
        • CIDErD.min_value
        • CIDErD.reset()
        • CIDErD.training
        • CIDErD.update()
      • CLAPSim
        • CLAPSim.compute()
        • CLAPSim.extra_repr()
        • CLAPSim.full_state_update
        • CLAPSim.get_output_names()
        • CLAPSim.higher_is_better
        • CLAPSim.is_differentiable
        • CLAPSim.max_value
        • CLAPSim.min_value
        • CLAPSim.reset()
        • CLAPSim.training
        • CLAPSim.update()
      • DCASE2023Evaluate
      • DCASE2024Evaluate
      • Evaluate
        • Evaluate.compute()
        • Evaluate.full_state_update
        • Evaluate.higher_is_better
        • Evaluate.is_differentiable
        • Evaluate.reset()
        • Evaluate.tolist()
        • Evaluate.training
        • Evaluate.update()
      • FENSE
        • FENSE.compute()
        • FENSE.extra_repr()
        • FENSE.full_state_update
        • FENSE.get_output_names()
        • FENSE.higher_is_better
        • FENSE.is_differentiable
        • FENSE.max_value
        • FENSE.min_value
        • FENSE.reset()
        • FENSE.training
        • FENSE.update()
      • FER
        • FER.compute()
        • FER.extra_repr()
        • FER.full_state_update
        • FER.get_output_names()
        • FER.higher_is_better
        • FER.is_differentiable
        • FER.max_value
        • FER.min_value
        • FER.reset()
        • FER.training
        • FER.update()
      • MACE
        • MACE.compute()
        • MACE.extra_repr()
        • MACE.full_state_update
        • MACE.get_output_names()
        • MACE.higher_is_better
        • MACE.is_differentiable
        • MACE.max_value
        • MACE.min_value
        • MACE.reset()
        • MACE.training
        • MACE.update()
      • METEOR
        • METEOR.compute()
        • METEOR.extra_repr()
        • METEOR.full_state_update
        • METEOR.get_output_names()
        • METEOR.higher_is_better
        • METEOR.is_differentiable
        • METEOR.max_value
        • METEOR.min_value
        • METEOR.reset()
        • METEOR.training
        • METEOR.update()
      • ROUGEL
        • ROUGEL.compute()
        • ROUGEL.extra_repr()
        • ROUGEL.full_state_update
        • ROUGEL.get_output_names()
        • ROUGEL.higher_is_better
        • ROUGEL.is_differentiable
        • ROUGEL.max_value
        • ROUGEL.min_value
        • ROUGEL.reset()
        • ROUGEL.training
        • ROUGEL.update()
      • SBERTSim
        • SBERTSim.compute()
        • SBERTSim.extra_repr()
        • SBERTSim.full_state_update
        • SBERTSim.get_output_names()
        • SBERTSim.higher_is_better
        • SBERTSim.is_differentiable
        • SBERTSim.max_value
        • SBERTSim.min_value
        • SBERTSim.reset()
        • SBERTSim.training
        • SBERTSim.update()
      • SPICE
        • SPICE.compute()
        • SPICE.extra_repr()
        • SPICE.full_state_update
        • SPICE.get_output_names()
        • SPICE.higher_is_better
        • SPICE.is_differentiable
        • SPICE.max_value
        • SPICE.min_value
        • SPICE.reset()
        • SPICE.training
        • SPICE.update()
      • SPIDEr
        • SPIDEr.compute()
        • SPIDEr.extra_repr()
        • SPIDEr.full_state_update
        • SPIDEr.get_output_names()
        • SPIDEr.higher_is_better
        • SPIDEr.is_differentiable
        • SPIDEr.max_value
        • SPIDEr.min_value
        • SPIDEr.reset()
        • SPIDEr.training
        • SPIDEr.update()
      • SPIDErFL
        • SPIDErFL.compute()
        • SPIDErFL.extra_repr()
        • SPIDErFL.full_state_update
        • SPIDErFL.get_output_names()
        • SPIDErFL.higher_is_better
        • SPIDErFL.is_differentiable
        • SPIDErFL.max_value
        • SPIDErFL.min_value
        • SPIDErFL.reset()
        • SPIDErFL.training
        • SPIDErFL.update()
      • SPIDErMax
        • SPIDErMax.compute()
        • SPIDErMax.extra_repr()
        • SPIDErMax.full_state_update
        • SPIDErMax.get_output_names()
        • SPIDErMax.higher_is_better
        • SPIDErMax.is_differentiable
        • SPIDErMax.max_value
        • SPIDErMax.min_value
        • SPIDErMax.reset()
        • SPIDErMax.training
        • SPIDErMax.update()
      • Vocab
        • Vocab.compute()
        • Vocab.full_state_update
        • Vocab.get_output_names()
        • Vocab.higher_is_better
        • Vocab.is_differentiable
        • Vocab.max_value
        • Vocab.min_value
        • Vocab.reset()
        • Vocab.training
        • Vocab.update()
      • Submodules
        • aac_metrics.classes.base module
          • AACMetric
        • aac_metrics.classes.bert_score_mrefs module
          • BERTScoreMRefs
        • aac_metrics.classes.bleu module
          • BLEU
          • BLEU1
          • BLEU2
          • BLEU3
          • BLEU4
        • aac_metrics.classes.cider_d module
          • CIDErD
        • aac_metrics.classes.clap_sim module
          • CLAPSim
        • aac_metrics.classes.evaluate module
          • DCASE2023Evaluate
          • DCASE2024Evaluate
          • Evaluate
        • aac_metrics.classes.fense module
          • FENSE
        • aac_metrics.classes.fer module
          • FER
        • aac_metrics.classes.mace module
          • MACE
        • aac_metrics.classes.meteor module
          • METEOR
        • aac_metrics.classes.rouge_l module
          • ROUGEL
        • aac_metrics.classes.sbert_sim module
          • SBERTSim
        • aac_metrics.classes.spice module
          • SPICE
        • aac_metrics.classes.spider module
          • SPIDEr
        • aac_metrics.classes.spider_fl module
          • SPIDErFL
        • aac_metrics.classes.spider_max module
          • SPIDErMax
        • aac_metrics.classes.vocab module
          • Vocab
    • aac_metrics.functional package
      • bert_score_mrefs()
      • bleu()
      • bleu_1()
      • bleu_2()
      • bleu_3()
      • bleu_4()
      • cider_d()
      • clap_sim()
      • dcase2023_evaluate()
      • dcase2024_evaluate()
      • evaluate()
      • fense()
      • fer()
      • mace()
      • meteor()
      • rouge_l()
      • sbert_sim()
      • spice()
      • spider()
      • spider_fl()
      • spider_max()
      • vocab()
      • Submodules
        • aac_metrics.functional.bert_score_mrefs module
          • BERTScoreMRefsScores
          • bert_score_mrefs()
        • aac_metrics.functional.bleu module
          • bleu()
          • bleu_1()
          • bleu_2()
          • bleu_3()
          • bleu_4()
        • aac_metrics.functional.cider_d module
          • CIDErDScores
          • cider_d()
        • aac_metrics.functional.clap_sim module
          • CLAPScores
          • clap_sim()
        • aac_metrics.functional.evaluate module
          • dcase2023_evaluate()
          • dcase2024_evaluate()
          • evaluate()
          • get_argnames()
        • aac_metrics.functional.fense module
          • FENSEScores
          • fense()
        • aac_metrics.functional.fer module
          • BERTFlatClassifier
          • FERScores
          • fer()
        • aac_metrics.functional.mace module
          • MACEScores
          • mace()
        • aac_metrics.functional.meteor module
          • METEORScores
          • meteor()
        • aac_metrics.functional.mult_cands module
          • mult_cands_metric()
        • aac_metrics.functional.rouge_l module
          • ROUGELScores
          • rouge_l()
        • aac_metrics.functional.sbert_sim module
          • SBERTSimScores
          • sbert_sim()
        • aac_metrics.functional.spice module
          • SPICEScores
          • check_spice_install()
          • spice()
        • aac_metrics.functional.spider module
          • SPIDErScores
          • spider()
        • aac_metrics.functional.spider_fl module
          • SPIDErFLScores
          • spider_fl()
        • aac_metrics.functional.spider_max module
          • SPIDErMaxScores
          • spider_max()
        • aac_metrics.functional.vocab module
          • VocabScores
          • vocab()
    • aac_metrics.utils package
      • Submodules
        • aac_metrics.utils.checks module
          • check_java_path()
          • check_metric_inputs()
          • is_mono_sents()
          • is_mult_sents()
        • aac_metrics.utils.collections module
          • duplicate_list()
        • aac_metrics.utils.globals module
          • get_default_cache_path()
          • get_default_java_path()
          • get_default_tmp_path()
          • set_default_cache_path()
          • set_default_java_path()
          • set_default_tmp_path()
        • aac_metrics.utils.tokenization module
          • preprocess_mono_sents()
          • preprocess_mult_sents()
          • ptb_tokenize_batch()
  • Submodules
    • aac_metrics.download module
      • download_metrics()
    • aac_metrics.eval module
      • load_csv_file()
    • aac_metrics.info module
      • get_install_info()
      • get_java_version()
      • get_package_repository_path()
      • print_install_info()