Difference between revisions of "Eosc/easybuild/modules"

From Nordic Language Processing Laboratory
Jump to: navigation, search
(List of modules)
(Others)
 
(25 intermediate revisions by the same user not shown)
Line 2: Line 2:
  
 
The laboratory is a reproducible custom-built set of NLP software.  
 
The laboratory is a reproducible custom-built set of NLP software.  
It is currently installed on Saga and Puhti HPC clusters.
+
It is currently installed on ''Saga'', ''Fox'', and ''Puhti'' HPC clusters.
  
To use on Saga: run the following command on (can be put in the ''~/.bashrc'' file to be run automatically at login):
+
- To use on ''Saga'': run the following command (can be put in the ''~/.bashrc'' file to be run automatically at login):
  
 
''module use -a /cluster/shared/nlpl/software/eb/etc/all/''
 
''module use -a /cluster/shared/nlpl/software/eb/etc/all/''
 +
 +
- To use on ''Fox'': run the following command (can be put in the ''~/.bashrc'' file to be run automatically at login):
 +
 +
''module use -a /fp/projects01/ec30/software/easybuild/modules/all/''
  
 
After that, the "nlpl"-branded modules will be available via ''module avail'', ''module load'', etc.
 
After that, the "nlpl"-branded modules will be available via ''module avail'', ''module load'', etc.
 +
 +
It is highly recommended to use them, instead of installing a copy in one's own home directory.
  
 
== List of modules ==
 
== List of modules ==
 +
From time to time, updated modules with newer software versions will be added,
 +
but the older modules will never be removed (for reproducibility).
 +
 
Note that the modules which have "gomkl" in their names are built using
 
Note that the modules which have "gomkl" in their names are built using
 
Intel Math Kernel Library, making them significantly faster in CPU tasks
 
Intel Math Kernel Library, making them significantly faster in CPU tasks
with Intel processors.
+
with Intel processors (for example, on ''Saga'').
 +
 
 +
Those with "foss" instead of "gomkl" are CPU-agnostic and will run on machines with AMD CPUs (for example, on ''Fox'').
 +
 
 +
The next element in the module name after "foss" or "gomkl" is the virtual laboratory (stack) version: for example, "2019b" or "2021a".
 +
Modules from different stack versions are incompatible  with each other: you cannot load a module from "foss-2019b" and a module from "foss-2021a" simultaneously.
 +
Currently, "2021a" version is the recommended one, with the most up-to-date software built with the most up-to-date compilers.
 +
 
 +
Further on, we just use the placeholder '''ARCH''', replace it with "gomkl" or "foss" and "2019b" or "2021a", depending on which machine you are working on and what stack version you want to use.
 +
Some modules also have the Python version specified in their names (for example, "''nlpl-numpy-1.23.1-foss-2021a-Python-3.9.5''").
 +
For stack version "2019b" it is usually Python 3.7.4, for stack version "2021a" it is usually Python 3.9.5.
 +
Check the output of the '''module avail''' command for the exact module names.
  
 
=== "Bundle" modules ===
 
=== "Bundle" modules ===
 
These are the modules with the most cryptic names. Each of them contains a bunch of software pieces (Python packages, as a rule).
 
These are the modules with the most cryptic names. Each of them contains a bunch of software pieces (Python packages, as a rule).
 +
Many of these modules will be loaded automatically as dependencies of the regular modules, but sometimes they can be useful themselves.
 +
They have their own bundle versions: "2021.01", "2022.01", etc (further specified as '''VERS''').
 
Here are the details:
 
Here are the details:
  
* nlpl-python-candy/2021.01-gomkl-2019b-Python-3.7.4
+
* '''nlpl-python-candy/VERS-ARCH''': various utility packages not directly related to NLP
* nlpl-nlptools/2021.01-gomkl-2019b-Python-3.7.4
+
** tqdm
* nlpl-scikit-bundle/0.22.2.post1-gomkl-2019b-Python-3.7.4
+
** pydot
* nlpl-scipy-ecosystem/2021.01-gomkl-2019b-Python-3.7.4
+
** smart_open
 +
** cached-property
 +
** filelock
 +
** regex
 +
** sacremoses
 +
** mpi4py
 +
** jsonlines
 +
** typing_extensions
 +
** packaging
 +
* '''nlpl-nlptools/VERS-ARCH''': various utility packages related to NLP
 +
** conllu
 +
** seqeval
 +
** langdetect
 +
** leven
 +
* '''nlpl-scipy-ecosystem/VERS-ARCH''': everything that constitutes the [https://scipy.org/ SciPy ecosystem]. Too many packages to enumerate them all, but the most important are:
 +
** scipy
 +
** pandas
 +
** matplotlib
 +
** ipython
 +
** jupyter_core
 +
** jupyter_client
 +
** networkx
 +
** sympy
  
 
=== "Regular" modules ===
 
=== "Regular" modules ===
 
These are more obvious modules, each one gives you one software piece:
 
These are more obvious modules, each one gives you one software piece:
  
* nlpl-cython/0.29.21-gomkl-2019b-Python-3.7.4
+
==== Most important ====
* nlpl-dllogger/0.1.0-gomkl-2019b-Python-3.7.4
+
* '''nlpl-pytorch/1.6.0-ARCH-cuda-10.1.243-Python-3.7.4''': [https://pytorch.org/ PyTorch] 1.6.0 (for CUDA 10)
* nlpl-gensim/3.8.3-gomkl-2019b-Python-3.7.4
+
* '''nlpl-pytorch/1.7.1-ARCH-cuda-10.1.243-Python-3.7.4''': [https://pytorch.org/ PyTorch] 1.7.1 (for CUDA 10)
* nlpl-horovod/0.20.3-gomkl-2019b-tensorflow-1.15.2-Python-3.7.4
+
* '''nlpl-pytorch/1.7.1-ARCH-cuda-11.1.1-Python-3.7.4''': [https://pytorch.org/ PyTorch] 1.7.1 (for CUDA 11)
* nlpl-nltk/3.5-gomkl-2019b-Python-3.7.4
+
* '''nlpl-pytorch/1.11.0-ARCH-cuda-11.3.1-Python-3.9.5''': [https://pytorch.org/ PyTorch] 1.11.0 (for CUDA 11)
* nlpl-numpy/1.18.1-gomkl-2019b-Python-3.7.4
+
 
* nlpl-nvidia-bert/20.06.8-gomkl-2019b-tensorflow-1.15.2-Python-3.7.4
+
* '''nlpl-tensorflow/1.15.2-ARCH-cuda-10.1.243-Python-3.7.4''': [https://www.tensorflow.org/ TensorFlow] 1.15.2 (for CUDA 10)
* nlpl-pytorch/1.6.0-gomkl-2019b-cuda-10.1.243-Python-3.7.4
+
* '''nlpl-tensorflow/2.3.2-ARCH-cuda-10.1.243-Python-3.7.4''': [https://www.tensorflow.org/ TensorFlow] 2.3.2 (for CUDA 10)
* nlpl-simple_elmo/0.6.0-gomkl-2019b-Python-3.7.4
+
* '''nlpl-tensorflow/2.6.2-ARCH-cuda-11.1.1-Python-3.7.4''': [https://www.tensorflow.org/ TensorFlow] 2.6.2 (for CUDA 11)
* nlpl-stanza/1.1.1-gomkl-2019b-Python-3.7.4
+
* '''nlpl-tensorflow/2.6.5-ARCH-cuda-11.3.1-Python-3.9.5''': [https://www.tensorflow.org/ TensorFlow] 2.6.5 (for CUDA 11)
* nlpl-tensorflow/1.15.2-gomkl-2019b-cuda-10.1.243-Python-3.7.4
+
 
* nlpl-tensorflow/2.3.2-gomkl-2019b-cuda-10.1.243-Python-3.7.4
+
==== Others ====
* nlpl-tokenizers/0.10.2-gomkl-2019b-Python-3.7.4
+
* '''nlpl-cython/VERS-ARCH''': [http://cython.org/ Cython]
* nlpl-transformers/4.5.1-gomkl-2019b-Python-3.7.4
+
* '''nlpl-datasets/VERS-ARCH''': [https://github.com/huggingface/datasets HuggingFace Datasets]
* nlpl-wandb/0.12.6-gomkl-2019b-Python-3.7.4
+
* '''nlpl-gensim/VERS-ARCH''': [https://github.com/RaRe-Technologies/gensim Gensim]
* sentencepiece/0.1.94-gomkl-2019b-Python-3.7.4
+
* '''nlpl-horovod/VERS-ARCH''': [https://github.com/horovod/horovod Horovod]
 +
* '''nlpl-huggingface-hub/VERS-ARCH-2019b-Python-3.7.4''': [https://pypi.org/project/huggingface-hub/ HuggingFace Hub]
 +
* '''nlpl-nltk/VERS-ARCH''': [https://www.nltk.org/ NLTK], together with '''all''' the corpora and datasets (no need to download them separately!)
 +
* '''nlpl-numpy/VERS-ARCH''': [https://numpy.org/ NumPy]
 +
* '''nlpl-pytorch-lightning/VERS-ARCH-cuda-11.3.1''': [https://www.pytorchlightning.ai/ PyTorch Lightning]
 +
* '''nlpl-scikit-bundle/VERS-ARCH''': [https://scikit-learn.org/ Scikit-Learn]
 +
* '''nlpl-sentencepiece/VERS-ARCH''': [https://github.com/google/sentencepiece SentencePiece]
 +
* '''nlpl-simple_elmo/VERS-ARCH''': [https://pypi.org/project/simple-elmo/ Simple_elmo]
 +
* '''nlpl-stanza/VERS-ARCH''': [https://stanfordnlp.github.io/stanza/ Stanza]
 +
* '''nlpl-tensorboard/VERS-ARCH''': [https://github.com/tensorflow/tensorboard TensorBoard]
 +
* '''nlpl-tokenizers/VERS-ARCH''': [https://github.com/huggingface/tokenizers HuggingFace Tokenizers]
 +
* '''nlpl-torchmetrics/VERS-ARCH''': [https://pypi.org/project/torchmetrics/ TorchMetrics]
 +
* '''nlpl-torchtext/VERS-ARCH''': [https://pypi.org/project/torchtext/ TorchText]
 +
* '''nlpl-transformers/VERS-ARCH''': [https://huggingface.co/transformers/ HuggingFace Transformers]
 +
* '''nlpl-wandb/VERS-ARCH''': [https://pypi.org/project/wandb/ Weights and Biases (wandb)]
 +
 
 +
* '''nlpl-dllogger/0.1.0-ARCH-2019b-Python-3.7.4''': [https://github.com/NVIDIA/dllogger DLLogger] 0.1.0 ''(status unclear)''
 +
* '''nlpl-nvidia-bert/20.06.8-ARCH-2019b-tensorflow-1.15.2-Python-3.7.4''': [https://github.com/NVIDIA/DeepLearningExamples/tree/master/TensorFlow/LanguageModeling/BERT NVIDIA's BERT implementation] for TensorFlow 1 ''(status unclear)''
  
 
= Source =
 
= Source =
  
 
Currently, the virtual laboratory is generated using EasyBuild, all the code and easyconfigs available [https://source.coderefinery.org/nlpl/easybuild here].
 
Currently, the virtual laboratory is generated using EasyBuild, all the code and easyconfigs available [https://source.coderefinery.org/nlpl/easybuild here].

Latest revision as of 22:25, 23 August 2022

NLPL virtual laboratory

The laboratory is a reproducible custom-built set of NLP software. It is currently installed on Saga, Fox, and Puhti HPC clusters.

- To use on Saga: run the following command (can be put in the ~/.bashrc file to be run automatically at login):

module use -a /cluster/shared/nlpl/software/eb/etc/all/

- To use on Fox: run the following command (can be put in the ~/.bashrc file to be run automatically at login):

module use -a /fp/projects01/ec30/software/easybuild/modules/all/

After that, the "nlpl"-branded modules will be available via module avail, module load, etc.

It is highly recommended to use them, instead of installing a copy in one's own home directory.

List of modules

From time to time, updated modules with newer software versions will be added, but the older modules will never be removed (for reproducibility).

Note that the modules which have "gomkl" in their names are built using Intel Math Kernel Library, making them significantly faster in CPU tasks with Intel processors (for example, on Saga).

Those with "foss" instead of "gomkl" are CPU-agnostic and will run on machines with AMD CPUs (for example, on Fox).

The next element in the module name after "foss" or "gomkl" is the virtual laboratory (stack) version: for example, "2019b" or "2021a". Modules from different stack versions are incompatible with each other: you cannot load a module from "foss-2019b" and a module from "foss-2021a" simultaneously. Currently, "2021a" version is the recommended one, with the most up-to-date software built with the most up-to-date compilers.

Further on, we just use the placeholder ARCH, replace it with "gomkl" or "foss" and "2019b" or "2021a", depending on which machine you are working on and what stack version you want to use. Some modules also have the Python version specified in their names (for example, "nlpl-numpy-1.23.1-foss-2021a-Python-3.9.5"). For stack version "2019b" it is usually Python 3.7.4, for stack version "2021a" it is usually Python 3.9.5. Check the output of the module avail command for the exact module names.

"Bundle" modules

These are the modules with the most cryptic names. Each of them contains a bunch of software pieces (Python packages, as a rule). Many of these modules will be loaded automatically as dependencies of the regular modules, but sometimes they can be useful themselves. They have their own bundle versions: "2021.01", "2022.01", etc (further specified as VERS). Here are the details:

  • nlpl-python-candy/VERS-ARCH: various utility packages not directly related to NLP
    • tqdm
    • pydot
    • smart_open
    • cached-property
    • filelock
    • regex
    • sacremoses
    • mpi4py
    • jsonlines
    • typing_extensions
    • packaging
  • nlpl-nlptools/VERS-ARCH: various utility packages related to NLP
    • conllu
    • seqeval
    • langdetect
    • leven
  • nlpl-scipy-ecosystem/VERS-ARCH: everything that constitutes the SciPy ecosystem. Too many packages to enumerate them all, but the most important are:
    • scipy
    • pandas
    • matplotlib
    • ipython
    • jupyter_core
    • jupyter_client
    • networkx
    • sympy

"Regular" modules

These are more obvious modules, each one gives you one software piece:

Most important

  • nlpl-pytorch/1.6.0-ARCH-cuda-10.1.243-Python-3.7.4: PyTorch 1.6.0 (for CUDA 10)
  • nlpl-pytorch/1.7.1-ARCH-cuda-10.1.243-Python-3.7.4: PyTorch 1.7.1 (for CUDA 10)
  • nlpl-pytorch/1.7.1-ARCH-cuda-11.1.1-Python-3.7.4: PyTorch 1.7.1 (for CUDA 11)
  • nlpl-pytorch/1.11.0-ARCH-cuda-11.3.1-Python-3.9.5: PyTorch 1.11.0 (for CUDA 11)
  • nlpl-tensorflow/1.15.2-ARCH-cuda-10.1.243-Python-3.7.4: TensorFlow 1.15.2 (for CUDA 10)
  • nlpl-tensorflow/2.3.2-ARCH-cuda-10.1.243-Python-3.7.4: TensorFlow 2.3.2 (for CUDA 10)
  • nlpl-tensorflow/2.6.2-ARCH-cuda-11.1.1-Python-3.7.4: TensorFlow 2.6.2 (for CUDA 11)
  • nlpl-tensorflow/2.6.5-ARCH-cuda-11.3.1-Python-3.9.5: TensorFlow 2.6.5 (for CUDA 11)

Others

  • nlpl-dllogger/0.1.0-ARCH-2019b-Python-3.7.4: DLLogger 0.1.0 (status unclear)
  • nlpl-nvidia-bert/20.06.8-ARCH-2019b-tensorflow-1.15.2-Python-3.7.4: NVIDIA's BERT implementation for TensorFlow 1 (status unclear)

Source

Currently, the virtual laboratory is generated using EasyBuild, all the code and easyconfigs available here.