diff --git a/README.md b/README.md index 7f62529..8a6db92 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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. \ No newline at end of file +Update: You can find the outputs of our model in the "outputs" folder.