Skip to content

Commit 32983bb

Browse files
authored
Update README.md
1 parent 70e39ad commit 32983bb

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,16 @@ python train_summary_loop.py --experiment wikinews_test --dataset_file data/wiki
2626

2727
## Scorer Models
2828

29-
The Coverage and Fluency model scores can be used separately for analysis, evaluation, etc.
30-
They are respectively in `coverage.py` and `fluency.py`, each model is implemented as a class with a `score(document, summary)` function.
29+
The Coverage and Fluency model and Guardrails scores can be used separately for analysis, evaluation, etc.
30+
They are respectively in `model_coverage.py` and `model_guardrails.py`, each model is implemented as a class with a `score(document, summary)` function.
31+
The Fluency model is a Language model, which is also the generator (in `model_generator.py`).
3132
Examples of how to run each model are included in the class files, at the bottom of the files.
3233

34+
## Bringing in your own data
35+
36+
Want to test out the Summary Loop on a different language/type of text?
37+
A [Jupyter Notebook](https://github.com/CannyLab/summary_loop/blob/master/Dataset%20SQLite3%20Example.ipynb) can help you bring your own data into the SQLite format we use in the pre-training scripts. Otherwise you can modify the scripts' data loading (`DataLoader`) and collate function (`collate_fn`).
38+
3339
## Cite the work
3440

3541
If you make use of the code, models, or algorithm, please cite our paper:

0 commit comments

Comments
 (0)