From 3d478d7602fd01b3c4abdebfa1853f7f235758de Mon Sep 17 00:00:00 2001 From: Joerg Tiedemann Date: Thu, 3 Feb 2022 22:34:54 +0200 Subject: [PATCH] a note about setting up some environment specifications --- README.md | 3 +++ doc/Setup.md | 10 ++++++++++ 2 files changed, 13 insertions(+) diff --git a/README.md b/README.md index 0425399f..7f275b5c 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,9 @@ git submodule update --init --recursive --remote make install ``` +Look into `lib/env.mk` and adust any settings that you need in your environment. +For CSC-users: adjust `lib/env/puhti.mk` and `lib/env/puhti.mk` to match yoursetup (especially the locations where Marian-NMT and other tools are installed and the CSC project that you are using). + Training a multilingual NMT model (Finnish and Estonian to Danish, Swedish and English): ``` diff --git a/doc/Setup.md b/doc/Setup.md index 430009e2..c03455cb 100644 --- a/doc/Setup.md +++ b/doc/Setup.md @@ -35,6 +35,16 @@ Optional (recommended) software: * [fast_align](https://github.com/clab/fast_align) +## Adjust environment setup + +Environment variables are mostly specified in `lib/env.mk`. Adjust the settings to match your environment! You maye have to re-run `make install` after the adjustments or compile/install tools manually. + + +## CSC users + +OPUS-MT-train is developed to run on the CSC HPC infrastructure and supports `puhti` and `mahti`. There are some hard-coded settings that match our particular environment in our CSC project. You need to adjust those settings in `lib/env/puhti.mk` and `lib/env/puhti.mk`. This includes at least the paths to important tools such as Marian-NMT and others. You also need to set the CSC project identifier (`CSCPROJECT`) to match the project that you use for requestion billing units! + + ## Mac OSX