VL_CONTRIB - Contribution modules management

VL_CONTRIB is a tool to download, set up and compile external contribution modules for MatConvNet. It downloads the list of available modules from a dedicated repository and uses GIT (if present) or ZIP files to install the modules. Additionally it can setup, compile and test the modules.

VL_CONTRIB (with no arguments) shows the list of available modules, and if possible shows hyperlinks with the available commands for each module.

VL_CONTRIB('COMMAND', 'MODULE', ...), or VL_CONTRIB COMMAND MODULE ... if all parameters are strings, executes one of the following commands:

• VL_CONTRIB LIST

  Print a list of available modules.

• VL_CONTRIB INSTALL MODULE

  Install a module. Specify the 'force', true option to overwrite the existing module. Modules are installed in `<vl_rootnn()>/contrib.

• VL_CONTRIB UPDATE MODULE

  Update a module. Specify the 'force', true option to overwrite the existing module.

• VL_CONTRIB SETUP MODULE

  Setup the MATLAB path for a MODULE so that it can be used. This is equivalent to running <vl_rootnn()>/contrib/MODULE/setup_MODULE.m.

• VL_CONTRIB UNLOAD MODULE

  Remove the module from the MATLAB path.

• VL_CONTRIB COMPILE MODULE ...

  Compile a MODULE. See the module documentation for additional details and accepted arguments. This is equivalent to running <vl_rootnn()>/contrib/MODULE/compile_MODULE.m.

• VL_CONTRIB TEST MODULE ...

  Test a MODULE, if a test script or a test suite dir exists. Test script path is: <vl_rootnn()>/contrib/MODULE/test_MODULE.m Test suite dir is: <vl_rootnn()>/contrib/MODULE/xtest/suite/. See vl_testnn for additional arguments.

• VL_CONTRIB PATH MODULE ...

  Return the path of a MODULE.

Notes

The list of modules is hosted at github.com/vlfeat/matconvnet-contrib.

Modules are installed to the directory <vl_rootnn()>/contrib in MatConvNet root directory. This directory must be writable for installation to succeed.

Modules are installed using GIT, if available; otherwise the function unpacks the zip distribution of the modules from its repository.

See also: VL_SETUPNN, VL_COMPILENN, VL_TESTNN.