PyTorch on ARC: Difference between revisions

From RCSWiki
Jump to navigation Jump to search
 
(13 intermediate revisions by the same user not shown)
Line 1: Line 1:
= Background =
* https://github.com/pytorch/pytorch - PyTorch project page on GitHub.
* https://docs.computecanada.ca/wiki/PyTorch - Compute Canada article is not directly applicable on ARC but contains a lot of good information.


'''PyTorch''' is a Python package that provides two high-level features:
'''PyTorch''' is a Python package that provides two high-level features:
Line 7: Line 11:
You can reuse your favorite Python packages such as NumPy, SciPy, and Cython to extend PyTorch when needed.
You can reuse your favorite Python packages such as NumPy, SciPy, and Cython to extend PyTorch when needed.


== Installing PyTorch ==
= Installing PyTorch =
You will need a working local '''Conda''' install in your home directory first. If you do not have it yet, please follow [[Conda_on_ARC#Installing_Conda | these instructions]] to have it installed.
You will need a working local '''Conda''' install in your home directory first. If you do not have it yet, please follow [[Conda_on_ARC#Installing_Conda | these instructions]] to have it installed.


Line 14: Line 18:


We will install '''PyTorch''' into its own '''conda environment'''.
We will install '''PyTorch''' into its own '''conda environment'''.
<pre>
$ conda create -n pytorch
....
</pre>
Now we activate our new environment
$ conda activate pytorch
Check for the available versions of <code>pytorch</code> on the <code>conda-forge</code> channel and decide on what you want to install.
Please make sure that there is '''GPU''' or '''cuda''' build for it (3rd column in the output table).
<pre>
(pytorch) $ conda search -c conda-forge pytorch
....
pytorch                        2.1.2 cpu_mkl_py39h9c325db_100  conda-forge       
pytorch                        2.1.2 cuda112_py310hb684afd_301  conda-forge       
....
....
</pre>
For example, we would like to get the version '''2.1.2''', then we see that there are '''CPU''' and '''GPU/cuda''' version.
If we try to install this version on the login node, '''Conda''' will detect that there is no GPU available
and will install the '''CPU version'''.
We have to use the <code>CONDA_OVERRIDE_CUDA</code> variable to override auto-detection and force installation of the '''GPU version'''.
Like this:
<pre>
(pytorch) $ CONDA_OVERRIDE_CUDA="12.2" conda install -c conda-forge pytorch=2.1.2 python pip
....
....
</pre>
'''Before''' confirming the installation,
'''check the list of the packages''' to be installed to make sure that the correct version and build are selected.
Once it is done, your '''PyTorch''' environment is ready.


It is '''very important''' to create the environment with '''python''' and '''pytorch''' in the same command. This way '''conda''' can select the best '''pytorch''' and '''python''' combination.
$ conda create -n pytorch python pytorch-gpu torchvision


Once it is done, activate your '''pytorch''' environment:
At this point you can add more packages to the environment using '''conda'''.
$ conda activate pytorch
<pre>
(pytorch) $ CONDA_OVERRIDE_CUDA="12.2" conda install -c conda-forge torchvision cuda-nvcc
....
....
</pre>
'''Note''' that you will have to use the '''override''' variable again, if the additional packages depend on the '''GPU presence'''.


You can test with the <code>torch-gpu-test.py</code> script shown below. Copy and paste the text into a file and run if from the command line:
== Testing ==
$ python torch-gpu-test.py


If you try this on the login node, it should tell you that GPUs are not available. It is normal, as the login node does not have any. You will need a GPU node to test the GPUs.  
You can test with the <code>torch-gpu-test.py</code> script shown below.  
Copy and paste the text into a file and run if from the command line:
(pytorch) $ python torch-gpu-test.py


Once you know that your '''pytorch''' environment is working properly, you can add more packages to the environment using '''conda'''.
If you try this on the '''login node''', it should tell you that '''GPUs are not available'''.
It is normal, as the login node does not have any. You will need a GPU node to test the GPUs.  


To deactivate the environment use the
To deactivate the environment (and conda itself) the
$ conda deactivate  
<pre>
command.
(pytorch) $ conda deactivate  
(base) $ conda deactivate
$
</pre>
commands.


=== Test script ===
=== Test script ===
Line 88: Line 135:
</syntaxhighlight>
</syntaxhighlight>


== Using PyTorch on ARC ==
= Using PyTorch on ARC =


=== Requesting GPU Resources for PyTorch Jobs ===
=== Requesting GPU Resources for PyTorch Jobs ===
Line 113: Line 160:
</syntaxhighlight>
</syntaxhighlight>


=== Checkpointing ===
== Checkpointing ==
Refer to the checkpointing tutorial at https://pytorch.org/tutorials/recipes/recipes/saving_and_loading_a_general_checkpoint.html.
Refer to the checkpointing tutorial at https://pytorch.org/tutorials/recipes/recipes/saving_and_loading_a_general_checkpoint.html.
== See also ==
* https://github.com/pytorch/pytorch - PyTorch project page on GitHub.
* https://docs.computecanada.ca/wiki/PyTorch - Compute Canada article is not directly applicable on ARC but contains a lot of good information.
* https://pytorch.org/tutorials/recipes/recipes/saving_and_loading_a_general_checkpoint.html - Checkpointing tutorial


= Links =
= Links =

Latest revision as of 22:52, 7 March 2024

Background

PyTorch is a Python package that provides two high-level features:

  • Tensor computation (like NumPy) with strong GPU acceleration
  • Deep neural networks built on a tape-based autograd system

You can reuse your favorite Python packages such as NumPy, SciPy, and Cython to extend PyTorch when needed.

Installing PyTorch

You will need a working local Conda install in your home directory first. If you do not have it yet, please follow these instructions to have it installed.

Once you have your own Conda, activate it with

$ source ~/software/init-conda

We will install PyTorch into its own conda environment.

$ conda create -n pytorch 
....

Now we activate our new environment

$ conda activate pytorch

Check for the available versions of pytorch on the conda-forge channel and decide on what you want to install. Please make sure that there is GPU or cuda build for it (3rd column in the output table).

(pytorch) $ conda search -c conda-forge pytorch
....
pytorch                        2.1.2 cpu_mkl_py39h9c325db_100  conda-forge         
pytorch                        2.1.2 cuda112_py310hb684afd_301  conda-forge         
....
....

For example, we would like to get the version 2.1.2, then we see that there are CPU and GPU/cuda version.


If we try to install this version on the login node, Conda will detect that there is no GPU available and will install the CPU version. We have to use the CONDA_OVERRIDE_CUDA variable to override auto-detection and force installation of the GPU version. Like this:

(pytorch) $ CONDA_OVERRIDE_CUDA="12.2" conda install -c conda-forge pytorch=2.1.2 python pip 
....
....

Before confirming the installation, check the list of the packages to be installed to make sure that the correct version and build are selected.

Once it is done, your PyTorch environment is ready.


At this point you can add more packages to the environment using conda.

(pytorch) $ CONDA_OVERRIDE_CUDA="12.2" conda install -c conda-forge torchvision cuda-nvcc
....
....

Note that you will have to use the override variable again, if the additional packages depend on the GPU presence.

Testing

You can test with the torch-gpu-test.py script shown below. Copy and paste the text into a file and run if from the command line:

(pytorch) $ python torch-gpu-test.py 

If you try this on the login node, it should tell you that GPUs are not available. It is normal, as the login node does not have any. You will need a GPU node to test the GPUs.

To deactivate the environment (and conda itself) the

(pytorch) $ conda deactivate 
(base) $ conda deactivate 
$ 

commands.

Test script

torch-gpu-test.py:

#! /usr/bin/env python 
# -------------------------------------------------------
import torch
# -------------------------------------------------------
print("Defining torch tensors:")
x = torch.Tensor(5, 3)
print(x)
y = torch.rand(5, 3)
print(y)

# -------------------------------------------------------
# let us run the following only if CUDA is available
if torch.cuda.is_available():
    print("CUDA is available.")
    x = x.cuda()
    y = y.cuda()
    print(x + y)
else:
    print("CUDA is NOT available.")

# -------------------------------------------------------

Test script 2

torch-gpu-test2.py:

#! /usr/bin/env python 
# -------------------------------------------------------
import os
import sys
import socket
import torch
# -------------------------------------------------------

dev = os.environ['CUDA_VISIBLE_DEVICES']

host = socket.gethostname()
tdev = torch.cuda.current_device()
tavail = torch.cuda.is_available()
tcount = torch.cuda.device_count()
tname = torch.cuda.get_device_name()

print("Host: %s\nENV Devices: %s\nCudaDev: %s\nCUDA is available: %s\nDevice count: %d\nDevice: %s" % \
        (host, dev, tdev, tavail, tcount, tname))

print(os.popen("/usr/bin/nvidia-smi -L").read().strip())
print(os.popen("env | grep CUDA").read().strip())
print("")
# -------------------------------------------------------

Using PyTorch on ARC

Requesting GPU Resources for PyTorch Jobs

For interactive use see this How-To: How to request an interactive GPU on ARC.

An example of the job script torch_job.slurm:

#! /bin/bash
# ====================================
#SBATCH --job-name=torch-test
#SBATCH --nodes=1
#SBATCH --ntasks=1
#SBATCH --cpus-per-task=4
#SBATCH --mem=16GB
#SBATCH --time=0-04:00:00
#SBATCH --gres=gpu:1
#SBATCH --partition=gpu-v100
# ====================================

source ~/software/init-conda
conda activate pytorch

python torch-gpu-test.py

Checkpointing

Refer to the checkpointing tutorial at https://pytorch.org/tutorials/recipes/recipes/saving_and_loading_a_general_checkpoint.html.

Links

ARC Software pages