On this page, you will find not only the list of dependencies to install for the tutorial, but a description of how to install them. This tutorial assumes you have a laptop with OSX or Linux. If you use Windows, you might have to install a virtual machine to get a UNIX-like environment to continue with the rest of this instruction. A lot of this instruction is more verbose than needed to accomodate participants of different skill levels.
Please note that these are only optional. On the first day of this training, you will be provided with a link to a JupyterHub instance where the environment will be pre-made and ready to go!
0. Get Anaconda¶
Anaconda is a Python (and R) distribution that aims to provide everything needed for common scientific and machine learning situations out-of-the-box. We chose Anaconda for this tutorial as it significantly simplifies Python dependency management.
In practice, Anaconda can be used to manage different environment and packages. This setup document will assume that you have Anaconda installed as your default Python distribution.
You can download Anaconda here: https://www.continuum.io/downloads
After installing Anaconda, you can access its command-line interface
1. Create a new environment¶
Environments are a tool for sanitary software development. By this, we mean that you can install specific versions of packages without worrying that it breaks a dependency elsewhere.
Here is how you can create an environment with Anaconda
conda create -n dl4nlp python=3.6
2. Install Dependencies¶
2a. Activate the environment¶
After creating the environment, you need to activate the environment:
source activate dl4nlp
After an environment is activated, it might prepend/append itself to your console prompt to let you know it is active.
With the environment activated, any installation commands
(whether it is
pip install X,
python setup.py install or using
Anaconda’s install command
conda install X) will only install inside
2b. Install IPython and Jupyter¶
Two core dependencies are IPython and Jupyter. Let’s install them first:
conda install ipython conda install jupyter
To allow a jupyter notebooks to use this environment as their kernel, it needs to be linked:
python -m ipykernel install --user --name dl4nlp
2c. Installing CUDA (optional)¶
NOTE: CUDA is currently not supported out of the conda package control manager. Please refer to pytorch’s github repository for compilation instructions.
If you have a CUDA compatible GPU, it is worthwhile to take advantage of it as it can significantly speedup training and make your PyTorch experimentation more enjoyable.
To install CUDA:
- Download CUDA appropriate to your OS/Arch from here.
- Follow installation steps for your architecture/OS. For Ubuntu/x86_64, see here.
- Download and install CUDNN from here.
Make sure you have the latest CUDA (8.0) and CUDNN (7.0).
2d. Install PyTorch¶
There are instructions on http://pytorch.org which detail how to install it. If you have been following along so far and have Anaconda installed with CUDA enabled, you can simply do:
conda install pytorch torchvision cuda80 -c soumith
The widget on PyTorch.org will let you select the right command line for your specific OS/Arch. Make sure you have PyTorch 2.0 or higher.
2e. Clone (or Download) Repository¶
At this point, you may have already cloned the tutorial repository. But if you have not, you will need it for the next step.
git clone https://github.com/joosthub/pytorch-nlp-tutorial-sf2017.git
If you do not have git or do not want to use it, you can also download the repository as a zip file
2f. Install Dependencies from Repository¶
Assuming the you have cloned (or downloaded and unzipped) the repository, please navigate to the directory in your terminal. Then, you can do the following:
pip install -r requirements.txt