VIAME is a computer vision application designed for do-it-yourself artificial intelligence including object detection, object tracking, image/video annotation, query-based search, image mosaicing, image enhancement, size measurement, multi-camera data processing, rapid model generation, and tools for the evaluation of different algorithms. Originally targeting marine species analytics, VIAME now contains many common algorithms and libraries, and is also useful as a generic computer vision toolkit. It contains a number of standalone tools for accomplishing the above, a pipeline framework which can connect C/C++, python, and matlab nodes together in a multi-threaded fashion, and multiple algorithms resting on top of the pipeline infrastructure. Lastly, a portion of the algorithms have been integrated into both desktop and web user interfaces for deployments in different types of environments, with an open annotation archive and example of the web platform available at viame.kitware.com.

Documentation

The User's Quick-Start Guide, Tutorial Videos, and Developer's Manual are more comprehensive, but select entries are also listed below broken down by individual functionality:

Documentation Overview <> Installation <> Building <> All Examples <> DIVE Interface <> VIEW Interface <> Search and Rapid Model Generation <> Object Detector CLI <> Object Tracker CLI <> Detector Training CLI <> Evaluation of Detectors <> Detection File Formats <> Calibration and Image Enhancement <> Registration and Mosaicing <> Stereo Measurement and Depth Maps <> Pipelining Overview <> Core Class and Pipeline Info <> Plugin Integration <> Example Plugin Templates <> Embedding Algorithms in C++

Installations

For a full installation guide and description of the various flavors of VIAME, see the quick-start guide, above. The full desktop version is provided as either a .msi, .zip or .tar file. Alternatively, standalone annotators (without any processing algorithms) are available via smaller installers (see DIVE standalone, below). Lastly, docker files are available for both VIAME Desktop and Web (below). For full desktop installs, extract the binaries and place them in a directory of your choosing, for example /opt/noaa/viame on Linux or C:\Program Files\VIAME on Windows. If using packages built with GPU support, make sure to have sufficient video drivers installed, version 570.11 or higher. The best way to install drivers depends on your operating system. This isn't required if just using manual annotators (or frame classifiers only). The binaries are quite large, in terms of disk space, due to the inclusion of multiple default model files and programs, but if just building your desired features from source (e.g. for embedded apps) they are much smaller.

Installation Requirements:
* Up to 8 Gb of Disk Space for the Full Installation
* Windows 7*, 8, 10, or 11 (64-Bit) or Linux (64-Bit, e.g. RHEL, CentOS, Ubuntu)
* Windows 7 requires some updates and service packs installed, e.g. KB2533623.
* MacOS is currently only supported running standalone annotation tools, see below.

Installation Recommendations:
* NVIDIA Drivers (Version 570.11 or above, Windows [1] [2] Ubuntu [1] [2] CentOS [1] [2])
* A CUDA-enabled GPU with 8 Gb or more VRAM

Windows Full Desktop Binaries:
* VIAME v0.21.3 Windows, GPU Enabled, Mirror1 (.zip)
* VIAME v0.21.3 Windows, GPU Enabled, Mirror2 (.zip)
* VIAME v0.21.1 Windows, CPU Only, Mirror1 (.zip)
* VIAME v0.21.1 Windows, CPU Only, Mirror2 (.zip)

Linux Full Desktop Binaries:
* VIAME v0.21.1 Linux, GPU Enabled, Mirror1 (.tar.gz)
* VIAME v0.21.1 Linux, GPU Enabled, Mirror2 (.tar.gz)
* VIAME v0.21.1 Linux, CPU Only, Mirror1 (.tar.gz)
* VIAME v0.21.1 Linux, CPU Only, Mirror2 (.tar.gz)

Web Applications:
* VIAME Online Web Annotator and Public Annotation Archive
* VIAME Web Local Installation Instructions
* VIAME Web Source Repository

Additional Packages:
* DIVE Standalone Desktop Annotator (Linux, Mac, Windows) * Model Zoo and Add-Ons * Custom and Prior VIAME Versions

Docker Images

Docker images are available on: https://hub.docker.com. For a default container with just core algorithms, runnable via command-line, see:

kitware/viame:gpu-algorithms-default

This image is headless (ie, it contains no GUI) and contains a VIAME desktop (not web) installation in the folder /opt/noaa/viame. For links to the VIAME-Web docker containers see the above section in the installation documentation. Most add-on models are not included in the instance but can be downloaded via running the script downloadviameaddons.sh in the bin folder.

Quick Build Instructions

These instructions are intended for developers or those interested in building the latest release branch. Anyone interested in just running the software as-is and not modifying it should use the installers listed in the prior section, without needing to do a software build. More in-depth build instructions can be found here, but the software can be built either as a super-build, which builds most of its dependencies alongside itself, or standalone. To build VIAME requires, at a minimum, Git, CMake, and a C++ compiler. Installing Python and CUDA is also recommended. If using CUDA, version 12.6 with CUDNN 9 is most tested, though other versions of 11 or 12 also likely work. For python distributions, at a minimum Python3.6 or above is necessary, alongside having pip and numpy installed.

To build on the command line in Linux, use the following commands, only replacing [source-directory] and [build-directory] with locations of your choice. While these directories can be the same, it's good practice to have a 'src' checkout then a seperate 'build' directory alongside it:

git clone https://github.com/VIAME/VIAME.git [source-directory]

cd [source-directory] && git submodule update --init --recursive

Next, create a build directory and run the following cmake command (or alternatively use the cmake GUI if you are not using the command line interface):

mkdir [build-directory] && cd [build-directory]

cmake -DCMAKE_BUILD_TYPE:STRING=Release [source-directory]

Once your cmake command has completed, you can configure any build flags you want using 'ccmake' or the cmake GUI, and then build with the following command on Linux:

make -j8

Or alternatively by building it in Visual Studio or your compiler of choice on Windows. On Linux, '-j8' tells the build to run multi-threaded using 8 threads, this is useful for a faster build though if you get an error it can be difficult to see it, in which case running just 'make' might be more helpful. For Windows, currently VS2019 is the most tested compiler.

There are several optional arguments to viame which control which plugins get built, such as those listed below. If a plugin is enabled that depends on another dependency such as OpenCV) then the dependency flag will be forced to on. If uncertain what to turn on, it's best to just leave the default enable and disable flags which will build most (though not all) functionalities. These are core components we recommend leaving turned on:

And a number of flags which control which system utilities and optimizations are built, e.g.:

And lastly, a number of flags which build algorithms or interfaces with more specialized functionality:

Source Code Layout

 VIAME
   ├── cmake               # CMake configuration files for subpackages
   ├── docs                # Documentation files and manual (pre-compilation)
   ├── configs             # All system-runnable config files and models
   │   ├── pipelines       # All processing pipeline configs
   │   │   └── models      # All models, which only get downloaded based on flags
   │   ├── prj-linux       # Default linux project files
   │   └── prj-windows     # Default windows project files 
   ├── examples            # All runnable examples and example tutorials
   ├── packages            # External projects used by the system
   │   ├── kwiver          # Processing backend infastructure
   │   ├── fletch          # Dependency builder for things which don't change often
   │   ├── kwant           # Scoring and detector evaluation tools
   │   ├── vivia           # Baseline desktop GUIs (v1.0)
   │   └── ...             # Assorted other packages (typically for algorithms)
   ├── plugins             # Integrated algorithms or wrappers around external projects
   │   └── ...             # Assorted plugins (detectors, depth maps, filters, etc.)
   ├── tools               # Standalone tools or scripts, often building on the above
   └── README.md           # Project introduction page that you are reading
   └── RELEASE_NOTES.md    # A list of the latest updates in the system per version

Update Instructions

If you already have a checkout of VIAME and want to switch branches or update your code, it is important to re-run:

git submodule update --init --recursive

After switching branches to ensure that you have on the correct hashes of sub-packages within the build. Very rarely you may also need to run:

git submodule sync

Just in case the address of submodules has changed. You only need to run this command if you get a "cannot fetch hash #hashid" error.

License, Citations, and Acknowledgements

VIAME is released under a BSD-3 license.

A non-exhaustive list of relevant papers used within the project alongside contributors can be found here.

VIAME was developed with funding from multiple sources, with special thanks to those listed here.