diff --git a/README.md b/README.md index d42180a..4343705 100644 --- a/README.md +++ b/README.md @@ -13,14 +13,16 @@ The dockers do not contain any trained models. Additionally the users are recomm Compiled dockers are uploaded in docker hub, so they can be pulled with -``` docker pull lefterav/marian-nmt:1.10.0_sentencepiece_cuda-11.3.0 +``` +docker pull lefterav/marian-nmt:1.10.0_sentencepiece_cuda-11.3.0 ``` ## Starting the container ## After pulling the docker, it can be started with the following command (replace with your linux account username). -``` docker run -v /home/:/home/ -e HOME=/home/ -it lefterav/marian-nmt:1.10.0_sentencepiece_cuda-11.3.0 +``` +docker run -v /home/:/home/ -e HOME=/home/ -it lefterav/marian-nmt:1.10.0_sentencepiece_cuda-11.3.0 ``` This will provide a commandline which gives you the possibility to run `marian` coomands. Additionally, the `-v` parameter, makes the user folders accessible to the docker, so that the results of the experiments can be saved (otherwise they would be lost when the docker is unloaded). @@ -31,7 +33,8 @@ In some server installations, the administrators suggest not using the home fold The Marian command is compiled at `/marian/build/marian`. You can test if marian works by running -```/marian/build/marian --help +``` +/marian/build/marian --help ``` By starting the Marian container, the commandline is already directed in the `experiments` directory of Marian. In the subdirectories one can run the bash scripts in order to perform the experiments. It is suggested to msave the data and the models to a mounted folder @@ -52,7 +55,8 @@ You can exit the container by hitting Ctrl+D or typing `exit` We provide different dockerfiles for different versions of Ubuntu and CUDA, and these can be found in the `/dockerfiles` subdirectory. The dockers can be compiled with the following command: -``` docker build --tag /marian-nmt:1.10.0_sentencepiece_cuda-11.3.0 - < dockerfiles/marian_1.10.0_sentencepiece_cuda_11.3.0.Dockerfile +``` +docker build --tag /marian-nmt:1.10.0_sentencepiece_cuda-11.3.0 - < dockerfiles/marian_1.10.0_sentencepiece_cuda_11.3.0.Dockerfile ``` This gives the possibility to produce one containers with modified setup