joeynmt
Minimalist NMT for educational purposes
File Explorer
Download Latest Version (.zip)- bug_report.md
- main.yml
- iwslt14_deen_bpe.yaml
- iwslt14_deen_sp.yaml
- jparacrawl_enja_sp.yaml
- jparacrawl_jaen_sp.yaml
- rnn_reverse.yaml
- rnn_small.yaml
- transformer_reverse.yaml
- transformer_small.yaml
- wmt17_ende_bpe.yaml
- wmt17_ende_sp.yaml
- attention_0.gif
- attention_iwslt.png
- attention_reverse.png
- bleu-ppl.png
- reverse_comparison.png
- tensorboard.png
- train_train_batch_loss.png
- train_train_epoch_loss.png
- valid_valid_loss.png
- valid_valid_score.png
- api.rst
- benchmarks.rst
- changelog.rst
- cli.rst
- conf.py
- faq.rst
- index.rst
- install.rst
- overview.rst
- resources.rst
- tutorial.rst
- benchmarks_v1.md
- JoeyNMT_v1.md
- JoeyNMT_v2.md
- make.bat
- Makefile
- NMT_code_quiz.pdf
- NMT_code_quiz_v2.pdf
- requirements.txt
- __init__.py
- __main__.py
- attention.py
- batch.py
- builders.py
- config.py
- data.py
- datasets.py
- decoders.py
- embeddings.py
- encoders.py
- helpers.py
- helpers_for_ddp.py
- hub_interface.py
- initialization.py
- loss.py
- metrics.py
- model.py
- plotting.py
- prediction.py
- search.py
- tokenizers.py
- training.py
- transformer_layers.py
- vocabulary.py
- joey_v1_demo.ipynb
- joey_v2_demo.ipynb
- torchhub.ipynb
- average_checkpoints.py
- build_vocab.py
- discord_joey.py
- generate_reverse_task.py
- get_iwslt14_bpe.sh
- get_iwslt15_envi.sh
- plot_validations.py
- bpe200.codes
- bpe200.txt
- dev.de
- dev.en
- dev.mt
- dev.tsv
- sp200.model
- sp200.vocab
- test._en
- test.de
- train.de
- train.en
- __init__.py
- test_attention.py
- test_batch.py
- test_data.py
- test_dataset.py
- test_decoder.py
- test_embeddings.py
- test_encoder.py
- test_loss.py
- test_metric.py
- test_model_init.py
- test_prediction.py
- test_search.py
- test_tokenizer.py
- test_transformer_decoder.py
- test_transformer_encoder.py
- test_transformer_utils.py
- test_vocabulary.py
- test_weight_tying.py
- __init__.py
- .gitattributes
- .gitignore
- .pylintrc
- .readthedocs.yml
- CODE_OF_CONDUCT.md
- hubconf.py
- joey-small.png
- joey2-small.png
- LICENSE
- Makefile
- README.md
- requirements.txt
- setup.cfg
- setup.py
# Installation Guide
git clone https://github.com/joeynmt/joeynmt
Downloads the entire project code from GitHub to your computer.
cd joeynmt
Moves into the project folder you just downloaded.
2. Python
Easy Recommended> python -m pip install --upgrade torch==2.1.2 --index-url https://download.pytorch.org/whl/cu121
Installs the Python libraries listed in requirements.txt (or similar).
python -m pip install joeynmt
Installs the Python libraries listed in requirements.txt (or similar).
python -m pip install -e . # Install Joey NMT and it's requirements
Installs the Python libraries listed in requirements.txt (or similar).
python -m unittest # Run the unit tests
Runs the Python script (or module).
python -m joeynmt train configs/transformer_small.yaml
Runs the Python script (or module).
Pulled directly from this repo's README.
3. Make
Medium- Git Needed to download the project code from GitHub.
- Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make test
Compiles the code based on the generated build configuration to produce an executable.
make check
Compiles the code based on the generated build configuration to produce an executable.
make -C docs clean html
Compiles the code based on the generated build configuration to produce an executable.
Pulled directly from this repo's README.