Mod: Update CHANGELOG, README and try to override tmp_path in workflow.

Labbeti · Dec 4, 2023 · c3904d5 · c3904d5
1 parent 9e54e2b
commit c3904d5
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 3 deletions.
diff --git a/.github/workflows/python-package-pip.yaml b/.github/workflows/python-package-pip.yaml
@@ -10,7 +10,7 @@ on:
 
 env:
   CACHE_NUMBER: 0  # increase to reset cache manually
-  TMPDIR: '/tmp'
+  AAC_METRICS_TMP_PATH: '/tmp'
 
 # Cancel workflow if a new push occurs
 concurrency:

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,8 +5,8 @@ All notable changes to this project will be documented in this file.
 ## [0.5.0] UNRELEASED
 ### Added
 - New `Vocab` metric to compute vocabulary size and vocabulary ratio.
-- New `BERTScoreMRefs` metric to compute BERTScore with multiple references.
-  
+- New `BERTScoreMRefs` metric wrapper to compute BERTScore with multiple references.
+
 ### Changed
 - Rename metric `FluErr` to `FER`.
 

diff --git a/README.md b/README.md
@@ -32,6 +32,7 @@ Metrics for evaluating Automated Audio Captioning systems, designed for PyTorch.
     - FER [[9]](#fense)
     - FENSE [[9]](#fense)
     - SPIDEr-FL [[10]](#spider-fl)
+    - Vocab
 
 ## Installation
 Install the pip package: