Skip to content

Getting started with docker for machine learning/deep learning libraries and frameworks. 🐳 + ℳ 𝓛

License

Notifications You must be signed in to change notification settings

ajaymache/deep-learning-docker

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 

Repository files navigation

                         Getting Started With Docker

Introduction

This repository aims at getting you started with docker by setting up environment for machine learning/deep learning libraries and frameworks.

What is docker?

  • Docker is the world’s leading software container platform. Developers use Docker to eliminate “works on my machine” problems when collaborating on code with co-workers.

  • Operators use Docker to run and manage apps side-by-side in isolated containers to get better compute density.

  • Enterprises use Docker to build agile software delivery pipelines to ship new features faster, more securely and with confidence for both Linux and Windows Server apps.

What is an image?

  • An image is a lightweight, stand-alone, executable package that includes everything needed to run a piece of software, including the code, a runtime, libraries, environment variables, and config files.

What is a container?

  • A container is a runtime instance of an image — what the image becomes in memory when actually executed. It runs completely isolated from the host environment by default, only accessing host files and ports if configured to do so.

  • Using containers, everything required to make a piece of software run is packaged into isolated containers. Unlike VMs, containers do not bundle a full operating system - only libraries and settings required to make the software work are needed.

  • This makes for efficient, lightweight, self-contained systems and guarantees that software will always run the same, regardless of where it’s deployed. To learn more about containers click here.

Installing docker

  • Install the docker application following the installation guide for your platform from here

Setting up the environment

  • The Docker Engine client runs natively on Linux, macOS, and Windows. By default, these clients connect to a local Docker daemon running in a virtual environment managed by Docker, which provides the required features to run Linux-based containers within OS X or Windows, or Windows-based containers on Windows.

  • The steps mentioned below are performed with the docker application installed on OSX (macOS). Following the steps mentioned below, you should be able to setup a customized docker image and push to dockerhub.

Starting with a base image

  • While making a custom docker image most of the times you will encounter that one usually starts with a base image. Here we will be using ubuntu as our base image.

  • Please note that we do not have to make the ubuntu image from scratch since its already been officially made by the community and we can use the same image as the starting point or base for creating our own image.

  • To get ubuntu as the base image from the public repository on dockerhub do the following steps:

    1. Open terminal

    2. To check if docker daemon is running type the command docker version in the terminal. You should see something like as shown in the snapshot below:

    If you get an error make sure your docker application is running by looking for the whale icon in the upper task bar as shown in the snapshot below:

    3. Proceed from here only if your docker is running as mentioned above. Since we have started the docker application for the first time we do not have any images yet. Lets confirm that by typing the command docker images in the terminal. You will notice that nothing is listed which confirms that we do not have any images.

    4. To get the ubuntu image as the base image type the command docker pull ubuntu in the terminal. This might take a while depending on your internet speed because it is fetching the image from the dockerhub which is available publicy for use. You should see the download progressing as shown below:

    5. Now type docker images as mentioned in step 3 to see the list of images you have downloaded on your machine. You should see something like as shown in the snapshot below:

Running a container from an image

  • In this section we will spin up a container from the base image ubuntu which we just pulled from the dockerhub.

    1. To run the ubuntu image type the command docker run -it ubuntu in the terminal. Note how the terminal changes pointing to the container which we spinned up just now as shown below:

    2. In order to install the required machine learning/deep learning libraries and frameworks we frist need some tools since the ubuntu image we pulled is very basic and essentially comes only with the kernel and hence it is light weight which is the basically the whole idea of docker. Execute the following commands sequentially one after the other in the terminal to get the required tools.

    apt-get update

    This command will get the latest updates if any. Below is the output after running this command in the terminal:

    apt-get install -y wget

    This command will get the GNU Wget which is a open source software package for retrieving files using HTTP, HTTPS and FTP.

    apt-get install -y bzip2

    This command will get the bzip2 package which will be required to decompress some of the Anaconda files which we will see in the next section.

Installing Anaconda

  • To avoid installing every library individually we will download and install Anaconda 4.2 with Python 3.5.

    1. To create a Downloads folder in the home directory type mkdir home/Downloads in the terminal.

    2. Navigate to this folder by typing cd home/Downloads in the terminal.

    3. To get Anaconda 4.2 with Python 3.5 archive file type wget https://repo.continuum.io/archive/Anaconda3-4.2.0-Linux-x86_64.sh in the terminal. This might take a while since the file is about ~385 MB.

  • After downloading the Anaconda file as explained in the previous section follow the steps below to complete the installation.

    1. To initiate the installation type bash ./Anaconda3-4.2.0-Linux-x86_64.sh in the terminal and hit enter. You will be prompted to read and agree the license terms and conditions. keep pressing enter until you are asked to accept the license terms. Type yes and hit enter to proceed.

    2. After you accept the license terms above you will be prompted with the message Anaconda3 will be now installed into the root location: /root/anaconda3, we will go with the default settings and hence press enter to proceed. This might take a while to install and you can see the logs in the console.

    3. In the end you will be asked if you would like to append the Anaconda3 install location to PATH in your /root/.bashrc. Type yes and hit enter to complete the installation.

    ⚠️ At this point the installation for Anaconda is complete but for the changes to come into effect we need to open a new terminal. One way is we can stop the running container and restart it in a new terminal window or we could simply attach the running container to a new terminal session. To keep it simple for this tutorial we will go with the first option.

    4. To stop the container type exit in the terminal and you will notice the terminal directory changes from root@.... to your home directory.

Restarting the stopped container

  • To restart the stopped conatiner we need the CONTAINER ID. Follow the steps below to obtain the CONTAINER ID and restart the container.

    1. To get the CONATINER ID type docker ps -a in the terminal. You will be listed with the CONTAINER ID and some more information about the container regarding when it was created, stopped etc. Copy this CONTAINER ID.

    2. To start the container type docker container start -i CONTAINER ID in the terminal. This will again restart the container which we stopped before and you can verify it by looking at terminal which will be pointing to root@....

    ⚠️ Do not forget to update the CONTAINER ID keyword with the actual container id in step 2 above while starting the container.

    3. To verify the Anaconda installation you could run the following commands in the terminal and they should execute without any errors.

    python --version
    
    pip --version
    
    which jupyter

    4. To update pip type pip install --upgrade pip in the terminal, since we would be using it to install other libraries it is good to have the latest updates fetched.

Installing deep learning frameworks

  • In this section we will be installing the most popular deep learning framework TensorFlow and keras. Note that while installing keras Theano another deep learning library will also be installed as its a dependency for keras. With these being installed you should be able to build most of your deep neural nets. Also note that this installation is for CPU version of TensorFlow only.

    1. Before we install TensorFlow, as the official documentation suggests we will create a seperate conda environment. To do so type conda create -n tensorflow. You will be asked to confirm for the environment location where this new environment will be created say yes to proceed. This might take few seconds.

    2. Now to enter the environment we just created type source activate tensorflow in the terminal. We will now install tensorflow and keras in this environment.

    3. To install tensorflow type the following command in the terminal:

    pip install --ignore-installed --upgrade https://storage.googleapis.com/tensorflow/linux/cpu/tensorflow-1.2.1-cp35-cp35m-linux_x86_64.whl

    4. To check if tensorflow was successfull installed invoke the python kernel by typing python in the terminal first then type the following commands sequentially.

    import tensorflow as tf
    hello = tf.constant('Hello, TensorFlow!')
    sess = tf.Session()
    print(sess.run(hello))

    If the system outputs b'Hello, TensorFlow!' then you are ready to begin writing TensorFlow programs. Type exit() to exit from the python shell and return to the terminal.

    ⚠️ You might get some warnings related to tensorflow not being compiled to use multiple CPU cores available on your machine. You can ignore them for now.

    5. To install keras type pip install keras in the terminal. Note that this will also get Theano

    6. To exit out of the tensorflow conda environment we are currently in type source deactivate. Note how the terminal changes.

    7. Now to stop the container and exit out of it type exit in the terminal. This will get back you to the host machine directory where you started with.

Creating new image from the container

  • This is the last section where will be creating an image from the container we exited. The container we stopped and exited from persists all the libraries and installations we have done so far. Note that if we remove the container we no more have access to the changes we have made so far and hence it makes sense to make an image out of this container so that we could run a container from it anytime we want in future and for distribution purposes.

    1. Note the CONATINER ID as explained previosuly by typing docker ps -a in the terminal.

    2. Before we create an image of this container please go to dockerhub and signup for a dockerhub account, because that is a cloud repository where we are going to push our images. Also please note the username while creating your account since this will be required both while creating an image as well as pusing the image to the dockerhub.

    3. Type docker commit CONTAINER ID yvariable/dl-image:test in the terminal to create your image. Replace the CONTAINER ID with the actual container id, yvariable with your USERNAME and dl-image with any other name you would like to give to your docker image. Note that the :test after dl-image is the tag for that image, you can give a different tag if you wish to and if you dont give any it will use latest as the default tag. This step can take several minutes.

    4. Type docker images in the terminal and you should see your newly created image.

Pushing docker image to dockerhub

  • You could keep the newly created docker image on your host machine but it would make more sense if you host it somewhere on a cloud server so that someone else can pull it and start using it or to server the purpose of collaboration if multiple people are woking on the same image (Same analogy as Github).

  • Before proceeding further make sure you have a dockerhub account. If not signup for one from here, also note the USERNAME.

    1. Type docker login in the terminal. Enter your credentials and verify it with the login successfull message which will appear on the console.

    2. Type docker push yvariable/dl-image:test in the terminal. This might take a few minutes as the image is large of the size ~2.7 GB and is being pushed to the server.

    ⚠️ Dont forget to replace yvariavle with your USERNAME and dl-image with the name you gave to your docker image. Note that the :test after dl-image is the tag for that image replace it with the one you gave for your image, if you dont give any it will use latest as the default tag.

Conclusion

  • 🏆 Congratulations! You can now visit dockerhub and verify that you have succesfully created your docker image and pushed to the dockerhub in your repository.

  • You can now pull this image like any other image (as done for the base image ubuntu) from the dockerhub directly on your host machine by typing docker pull yvariable/dl-image:test in the terminal.

References