Troyfeng116/readme update

Yale-LILY / SummerTime

An open-source text summarization toolkit for non-experts. EMNLP'2021 Demo

https://arxiv.org/abs/2108.12738

Apache License 2.0

268 stars 30 forks source link

Troyfeng116/readme update #20

Closed troyfeng116 closed 3 years ago

troyfeng116 commented 3 years ago

update README with more detailed API-like documentation
update requirements.txt

troyfeng116 commented 3 years ago

As classes + architecture + functionality are updated for eval and datasets (including type hints and defaults), README will continue to be updated

niansong1996 commented 3 years ago

Other suggestions:

maybe put the jupyter notebook part into the quick start, since it's not necessary for installation and setup

niansong1996 commented 3 years ago

Also, I found something that could be helpful in creating a well-documented and well-styled codebase: https://github.com/allenai/allennlp/blob/main/STYLE.md

@troyfeng116 Can you check this out and see if you like the tools they are using?

niansong1996 commented 3 years ago

@troyfeng116 Okay, I am able to follow the README.md in this branch and run the jupyter notebook all the way till the end. The caveat is that I need to manually change the ROUGE_HOME path, of course. I am merging this PR, but please keep this branch since we will update the readme in the future as well.