Skip to content

Commit

Permalink
Mod: Update README.
Browse files Browse the repository at this point in the history
  • Loading branch information
Labbeti committed Jan 3, 2024
1 parent 5d710f9 commit e4a2ed7
Showing 1 changed file with 3 additions and 5 deletions.
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ Each metrics also exists as a python class version, like `aac_metrics.classes.ci
### Other metrics
| Metric name | Python Class | Origin | Range | Short description |
|:---|:---|:---|:---|:---|
| Vocabulary | `Vocab` | text generation | [0, +$\infty$[ | Number of unique words in candidates. |
| Vocabulary | `Vocab` | text generation | [0, +∞[ | Number of unique words in candidates. |

### Future directions
This package currently does not include all metrics dedicated to audio captioning. Feel free to do a pull request / or ask to me by email if you want to include them. Those metrics not included are listed here:
Expand All @@ -146,15 +146,13 @@ numpy >= 1.21.2
pyyaml >= 6.0
tqdm >= 4.64.0
sentence-transformers >= 2.2.2
transformers < 4.31.0
transformers
torchmetrics >= 0.11.4
```

### External requirements
- `java` **>= 1.8 and <= 1.13** is required to compute METEOR, SPICE and use the PTBTokenizer.
Most of these functions can specify a java executable path with `java_path` argument.

- `unzip` command to extract SPICE zipped files.
Most of these functions can specify a java executable path with `java_path` argument or by overriding `AAC_METRICS_JAVA_PATH` environment variable.

## Additional notes
### CIDEr or CIDEr-D?
Expand Down

0 comments on commit e4a2ed7

Please sign in to comment.