Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Conversation

@TamaraAtanasoska
Copy link
Contributor

This PR is a collection of small improvements to the documentation in the README file. It also introduces two new files that can help others easily set up and run the models.

Improvements made:

  • Fixed spelling and grammar erros.
  • Removed trailing quotes and other symbols.
  • Removed the summary section since Github has now an interactive one provided with every repo.
  • Edited text for clarity in multiple sections.
  • Added additional information in the sections where we needed more explanation while reproducing the code.
  • Edited commands that were not consistent with the provided data folder organisation.
  • Introduced a requirements.txt and a conda.yml file for easy environment reproduction.
  • Abstracted the config file editing information.
  • Shortened some sentences/blocks with adding hyperlinks.

We hope the changes can help students like us in the future reproduce the models and their results faster.

Co-authored-by: Galina Ryazanskaya <[email protected]>
Co-authored-by: Bhuvanesh Verma <[email protected]>
@harm-devries harm-devries merged commit 17c1d0d into GuessWhatGame:master Jul 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants