Skip to content

Update README.md #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Update README.md #12

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
944a0e1
Update README.md
aflah02 Feb 5, 2022
f396a32
Update README.md
aflah02 Feb 5, 2022
3878bbe
Update README.md
aflah02 Feb 5, 2022
976c6c0
Update README.md
aflah02 Feb 6, 2022
db3c2e0
Update README.md
aflah02 Feb 6, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,11 @@ torchtext >= 0.4.0

nltk

fasttext == 0.8.3

kenlm
fasttext == 0.8.3 [Using Future Versions Can Cause Errors such as ```ValueError: /PATH/evaluator/acc_yelp.bin has wrong file format!```](https://github.com/fastnlp/style-transformer/issues/2)

kenlm This step might cause errors so might want to check this [fork](https://github.com/MarvinChung/HW5-TextStyleTransfer) which uses ```pypi-kenlm```

Since TorchText 0.9.0 some functions have become legacy and their imports need to be modified slightly else they would raise attribute not found error. Incase of such errors check out [this answer](https://stackoverflow.com/a/68278366/13858953)

## Usage

Expand Down Expand Up @@ -70,8 +70,9 @@ To evaluation the model, we used Fasttext, NLTK and KenLM toolkit to evaluate t

Because the file "ppl_yelp.binary" is too big to upload, we exclude it from the "evaluator" folder. As a result, you can not evaluate the ppl score via evaluator. To solve this problem, you can use the KenLM toolkit to train a language model by yourself or use other script to evaluate it.

If you wish to get the "ppl_yelp.binary" file you might want to check out this [issue](https://github.com/fastnlp/style-transformer/issues/11) which points to this [fork](https://github.com/MarvinChung/HW5-TextStyleTransfer) which has instructions for getting it


## Outputs

Update: You can find the outputs of our model in the "outputs" folder.
Update: You can find the outputs of our model in the "outputs" folder.