Skip to content

Commit fa3a3be

Browse files
authored
Update README.md
1 parent f870022 commit fa3a3be

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

README.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,16 @@ Given two files with the same number of lines, `files2rouge` calculates the aver
55

66
You may also be interested in a Python implementation (instead of a wrapper): <https://github.com/pltrdy/rouge>.
77

8-
```shell
8+
```bash
99
$ files2rouge --help
10-
usage: files2rouge [-h] [-v] [-a ARGS] [-s SAVETO] [-e EOS] summary reference
10+
usage: files2rouge [-h] [-v] [-a ARGS] [-s SAVETO] [-e EOS] [-m] [-i]
11+
reference summary
1112

1213
Calculating ROUGE score between two files (line-by-line)
1314

1415
positional arguments:
15-
summary Path of summary file
1616
reference Path of references file
17+
summary Path of summary file
1718

1819
optional arguments:
1920
-h, --help show this help message and exit
@@ -23,6 +24,8 @@ optional arguments:
2324
File to save scores
2425
-e EOS, --eos EOS End of sentence separator (for multisentence).
2526
Default: "."
27+
-m, --stemming
28+
-i, --ignore_empty
2629
```
2730

2831
## Getting Started
@@ -44,7 +47,7 @@ python setup.py install
4447

4548
**2) Run `files2rouge.py`**
4649
```bash
47-
files2rouge summaries.txt references.txt
50+
files2rouge references.txt summaries.txt
4851
```
4952

5053
**Outputs:**
@@ -80,7 +83,7 @@ files2rouge.run(hyp_path, ref_path)
8083
One can specify which ROUGE args to use using the flag `--args` (or `-a`).
8184
The default behavior is equivalent to:
8285
```
83-
files2rouge summary.txt reference.txt -a "-c 95 -r 1000 -n 2 -a" # be sure to write args betwen double-quotes
86+
files2rouge reference.txt summary.txt -a "-c 95 -r 1000 -n 2 -a" # be sure to write args betwen double-quotes
8487
```
8588
You can find more informations about these arguments [here](./files2rouge/RELEASE-1.5.5/README.txt)
8689

0 commit comments

Comments
 (0)