Skip to content

Kitware/SMQTK

Repository files navigation

SMQTK - Deprecated

CI Unittests

Documentation Status

Deprecated

As of Jan 2021, SMQTK v0.14.0 has been deprecated. The various interfaces and implementations have been broken out into the following distinct packages which will continue to be supported instead.

  • SMQTK-Core provides underlying tools used by other libraries.

  • SMQTK-Dataprovider provides data structure abstractions.

  • SMQTK-Image-IO provides interfaces and implementations around image input/output.

  • SMQTK-Descriptors provides algorithms and data structures around computing descriptor vectors.

  • SMQTK-Classifier provides interfaces and implementations around classification.

  • SMQTK-Detection provides interfaces and support for black-box object detection.

  • SMQTK-Indexing provides interfaces and implementations around the k-nearest-neighbor algorithm.

  • SMQTK-Relevancy provides interfaces and implementations around providing search relevancy estimation.

  • SMQTK-IQR provides classes and utilities to perform the Interactive Query Refinement (IQR) process.

Intent

Social Multimedia Query ToolKit aims to provide a simple and easy to use API for:

  • Scalable data structure interfaces and implementations, with a focus on those relevant for machine learning.
  • Algorithm interfaces and implementations of machine learning algorithms with a focus on media-based functionality.
  • High-level applications and utilities for working with available algorithms and data structures for specific purposes.

Through these features, users and developers are able to access various machine learning algorithms and techniques to use over different types of data for different high level applications. Examples of high level applications may include being able to search a media corpus for similar content based on a query, or providing a content-based relevancy feedback interface for a web application.

Documentation

Documentation for SMQTK is maintained at ReadtheDocs, including build instructions and examples.

Alternatively, you can build the sphinx documentation locally for the most up-to-date reference (see also: Building the Documentation):

# Navigate to the documentation root.
cd docs
# Install dependencies and build Sphinx docs.
pip install -r readthedocs-reqs.txt
make html
# Open in your favorite browser!
firefox _build/html/index.html