Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
GLJS authored Dec 18, 2023
1 parent dff52a2 commit 2755bc5
Showing 1 changed file with 10 additions and 2 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,17 +5,25 @@ This is the repository of Audio Captioning Evaluation on Semantics of Sound (ACE
In here you will find the instructions how to train an ACES model and calculate statistics.

## Installation
```
``` bash
pip install aces-metric
```
## Usage
The candidates can be a list, the references can be a list or a list of lists.
```
``` python
from aces import get_aces_score
candidates = ["a bunch of birds are singing"]
references = ["birds are chirping and singing loudly in the forest"]
score = get_aces_score(candidates, references, average=True)
```

### Semantics of sounds
To just clasify a caption based on the semantics of sounds (the basis of the ACES metric):
``` python
from transformers import pipeline
pipe = pipeline("token-classification", "gijs/aces-roberta-13", aggregation_strategy="simple")
pipe("Bird chirps in the tree while a car hums")
```

## Evaluation
All the code that is used to evaluate different models for the research paper can be found in the `evaluation` folder on the [github](https://github.com/GlJS/ACES). Particularly, the model evaluation can be found in `evaluation/eval.py`, and information about the FENSE experiment can be found in `evaluation/fense_experiment/main.py`.

0 comments on commit 2755bc5

Please sign in to comment.