SOMHunter Core

The main component of the SOMHunter tool. All models and all the logic is inside this component. Other components can be substituted with other implementetions because the core uses HTTP server (OpenAPI) as its interface. Optionally, you can use the core natively as a C++ class (class Somhunter).

Build & Run with Docker (recommended)

# Build the container
sudo docker build -t somhunter-core .
# Install the core
sudo docker run -ti --rm -v ${PWD}:/somhunter-core somhunter-core:latest sh install.sh RelWithDebugInfo
# Run it on port 8082
sudo docker run -ti --rm -v ${PWD}:/somhunter-core -p 8082:8082 somhunter-core:latest sh run.sh

Build & Run (for bold & brave)

Prerequisites

• libcurl- https://curl.se/libcurl/
• OpenCV - https://opencv.org/
• cpprestsdk - https://github.com/microsoft/cpprestsdk
• libtorch - https://pytorch.org/
  • (this will be downloaded and installed during CMake script execution, you shouldn't worry about this)

Windows

Because Windows does not have a unified package manager with dev packages, you need to provide the dependency libraries manually OR use some other package manager. We recommend using vcpkg for dependency management. It works quite well with CMake (and also on Linux distros).

Dependencies

1. Download and install vcpkg
2. Install required dependencies for your architecture and system (e.g. for x64 windows)

./vcpkg install curl:x64-windows opencv4:x64-windows cpprestsdk:x64-windows openssl:x64-windows

3. Get path to the CMake toolchain file

./vcpkg integrate install

# This will output how to tell CMake about this. Something like 
CMake projects should use: "-DCMAKE_TOOLCHAIN_FILE="c:/vcpkg/scripts/buildsystems/vcpkg.cmake"

Generate the build

Now just run CMake as usual with this additional option. An example for VS 2019 solution may look like this:

mkdir build
cd build

# Debug
cmake .. -G "Visual Studio 16 2019" -A x64  -DCMAKE_BUILD_TYPE=Debug -DCMAKE_TOOLCHAIN_FILE="~/source/repos/vcpkg/scripts/buildsystems/vcpkg.cmake"
    
# Release
cmake .. -G "Visual Studio 16 2019" -A x64 -DCMAKE_BUILD_TYPE=Release -DCMAKE_TOOLCHAIN_FILE="~/source/repos/vcpkg/scripts/buildsystems/vcpkg.cmake" 
    

Build the core

Just use Visual Studio, or

cmake --build . --config Debug
cmake --build . --config Release

UNIX systems

You should be able to install all dependencies from the package management. On Debian-based systems (including Ubuntu and Mint) the following should work:

Similar (similarly named) packages should be available on most other distributions.

Dependencies

# Install dependencies
apt-get install build-essential libcurl4-openssl-dev libopencv-dev libcpprest-dev

Generate the build

mkdir build && cd build

# Debug
cmake .. -DCMAKE_BUILD_TYPE="Debug"

# Release
cmake .. -DCMAKE_BUILD_TYPE="Release"

Build the core

make -j

Core HTTP API

API documentation is available at <server_address>/api/ (e.g. http://localhost:8082/api/). It requires the running core.

Doxygen documentation

The pre-built version is available here.

doxygen doxygen.cfg

Licenses

Attached dataset

The attached dataset is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.

For more information, please see: https://ftp.itec.aau.at/datasets/short-casual-videos/

Models downloaded during the installation

During the installation, the script will download two third-party models. You will be prompted to accept this. You need to check that the way you're about to use them is OK with their respective licenses.

• ResNext101: Mettes, P., Koelma, D. C., & Snoek, C. G. (2020). Shuffled ImageNet Banks for Video Event Detection and Search. ACM Transactions on Multimedia Computing, Communications, and Applications (TOMM), 16(2), 1-21.

• ResNet152: https://mxnet.incubator.apache.org/versions/1.9.0/

FAQ

1. I'm am getting an error saying "python not found".

Do you have Python 3 installed? Maybe you don't have it aliased on python command. Consider aliasing it (or use something like apt install python-is-pyton3).