All the demos/tutorials provided in this repo require Torch7 to be installed, as well as some extra (3rd-party) packages.

Follow instructions on: Torch7's homepage.

Different demos/tutorials rely on different 3rd-party packages. If a demo crashes because it can't find a package then simply try to install it using torch-pkg:

$ torch-pkg install image    # an image library for Torch7
$ torch-pkg install nnx      # lots of extra neural-net modules
$ torch-pkg install camera   # a camera interface for Linux/MacOS
$ torch-pkg install ffmpeg   # a video decoder for most formats
$ ...

A complete list of packages can be obtained by doing:

$ torch-pkg list

or checking out this page.

Torch's main documentation gets installed when you install Torch, and should be available here, or wherever you installed Torch.

This repo also comes with documentation, in the form of tutorials. To make them available, simply issue the following command in this directory:

$ torch-pkg deploy

After that, a list of tutorials will be available in the documentation.

Each directory provides a tutorial or a demo, with no particular order. It's a good idea to have the local Torch documentation open on the side, for reference. As Torch is based on the Lua language, it's also a good idea to go through the Lua 5.1 book.

These demos were slowly put together by: Clement Farabet & Roy Lowrance.