Skip to content

docs: improve README with notes for new contributors and legacy setup #46

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
divyanshu-iitian wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: improve README with notes for new contributors and legacy setup #46

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,3 +122,15 @@ perl scripts/multi-bleu.perl $reference-file < $hypothesis-file
* [An Actor-Critic Algorithm for Sequence Prediction](https://arxiv.org/pdf/1607.07086)
* [Europarl](http://www.statmt.org/europarl/)
* [Moses](https://github.com/moses-smt/mosesdecoder)

## Notes for New Contributors (Important)

This project was originally developed as part of Google Summer of Code 2018 and relies on software versions that are now deprecated (e.g., Python 2.7, older PyTorch releases, and HPC-specific setups).

New contributors should note the following:

- **Python 2.7 is no longer officially supported.** Updating the codebase to Python 3.x would be a valuable improvement.
- **Dependency versions may require revision** to work with modern PyTorch and TensorFlow releases.
- **The CASE HPC setup described above is environment-specific**; contributors working on local machines or cloud platforms may need alternative setup steps.

These limitations also make this repository a good candidate for future work focused on modernization, reproducibility, and improved usability.