Skip to content

Commit

Permalink
Add supert dependencies and installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
Jeremy committed Sep 10, 2023
1 parent f44ad55 commit 27d0595
Show file tree
Hide file tree
Showing 4 changed files with 542 additions and 450 deletions.
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,16 +72,27 @@ apt-get install libxml-parser-perl
```
in ubuntu systems, at least.

Finally, the `pyrouge` python package is required. This can be installed manualy
or with the `summ-eval[perl-rouge]` extra.
Finally, the `pyrouge` python package is required. This can be installed manually
or with the `summ-eval[rouge]` extra.


### S3; Sentence Mover's Similarity and Supert
These packages all require NLTK's `stopwords` corpus. This can be installed with
These metrics all require NLTK's `stopwords` corpus. This can be installed with
```bash
python -m nltk.downloader stopwords
```

### Supert
Supert requires NLTK's `punkt` tokenizer. This can be installed with
```bash
python -m nltk.downloader tokenizer
```

Additionally, this metric the `sentence_transformers` folder to be findable by importlib.
To do this, `./evaluation/summ_eval/` must be added to the python path.
This can be done either manually with `export PYTHONPATH=$PYTHONPATH:./evaluation/summ_eval/` or
will be done automatically when `summ_eval.supert_metric` is imported.

## Usage

### As a package
Expand Down
Loading

0 comments on commit 27d0595

Please sign in to comment.