The easiest option for reading the book is via the static nbviewer. While this does not allow you to change and execute code, it also doesn't require you to install software locally and only needs a browser.

We assume you have a command line interface (CLI) in your OS (bash, zsh, cygwin, git-bash, power-shell etc.). We assume this CLI sets the variable $(pwd) to the current directory. If it doesn't replace all mentions of $(pwd) with the current directory you are in.

For Mac and Windows, go to the docker webpage and follow the instruction for your platform. Instructions for Ubuntu can be found here.

Next you can download the stat-nlp-book docker image like so:

docker pull riedelcastro/stat-nlp-book

If you get a permission error here and at any later point, try prepending sudo to the command:

sudo docker pull riedelcastro/stat-nlp-book

This process may take a while, so use the time to start familiarising yourself with the structure of the course.

You can use the git installation in the docker container to get the repository:

docker run -v "$(pwd)":/home/jovyan/work riedelcastro/stat-nlp-book git clone https://github.com/coastalcph/stat-nlp-book.git  

Note: this will create a new stat-nlp-book directory in your current directory.

We assume from here on that you are in the top level stat-nlp-book directory:

cd stat-nlp-book

Note: you need to be in the stat-nlp-book directory every time you want to run/update the book.

docker run -it --rm -p 8888:8888 -v "$(pwd)":/home/jovyan/work riedelcastro/stat-nlp-book 

You are now ready to visit the overview page locally through the installed book .

Once installed you can always run your notebook server by first changing into your local stat-nlp-book directory, and then executing:

docker run -it --rm -p 8888:8888 -v "$(pwd)":/home/jovyan/work riedelcastro/stat-nlp-book 

This is assuming that your docker daemon is running and that you are in the stat-nlp-book directory. How to run the docker daemon depends on your system.

We frequently make changes to the book. To get these changes you should first make sure to clean your local changes to avoid merge conflicts. That is, you might have made changes (by changing the code or simply running it) to the files that we changed. In these cases git will complain when you do the update. To overcome this you can undo all your changes by executing:

docker run -v "$(pwd)":/home/jovyan/work riedelcastro/stat-nlp-book git checkout -- .

If you want to keep your changes create copies of the changed files. Jupyter has a "Make a copy" option in the "File" menu for this. You can also create a clone of this repository to keep your own changes and merge our changes in a more controlled manner.

To get the actual updates then run

docker run -v "$(pwd)":/home/jovyan/work riedelcastro/stat-nlp-book git pull

The repository contains a lot of material, some of which may not be ready for consumption yet. This is why you should always access content through the top-level overview page (local-link).

Follow the instructions here In short:

pip3 install virtualenv

git clone https://github.com/coastalcph/stat-nlp-book.git

Enter the cloned stat-nlp-book directory:

cd stat-nlp-book

and create the virtual environment:

virtualenv -p python3 venv

source venv/bin/activate

pip3 install --upgrade pip
pip3 install -r requirements.txt
pip3 install git+git://github.com/robjstan/tikzmagic.git
jupyter-nbextension install rise --py --sys-prefix
jupyter-nbextension enable rise --py --sys-prefix    

jupyter notebook