Metadata-Version: 2.1
Name: smqtk_descriptors
Version: 0.21.0
Summary: Algorithms, data structures and utilities around computingdescriptor vectors from data.
Home-page: https://github.com/Kitware/SMQTK-Descriptors
License: BSD-3-Clause
Author: Kitware, Inc.
Author-email: smqtk-developers@kitware.com
Requires-Python: >=3.10, !=2.7.*, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, !=3.5.*, !=3.6.*, !=3.7.*, !=3.8.*, !=3.9.*
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: Unix
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Provides-Extra: pytorch
Requires-Dist: numpy (>=1.23.5) ; python_version < "3.13"
Requires-Dist: numpy (>=2.1) ; python_version >= "3.13" and python_version < "3.14"
Requires-Dist: numpy (>=2.3.2) ; python_version >= "3.14"
Requires-Dist: smqtk-core (>=0.22.0)
Requires-Dist: smqtk-dataprovider (>=0.20.0)
Requires-Dist: smqtk-image-io (>=0.19.0)
Requires-Dist: torch (>=2.13.0) ; extra == "pytorch"
Requires-Dist: torchvision (>=0.28.0) ; extra == "pytorch"
Project-URL: Documentation, https://smqtk-descriptors.readthedocs.io/
Project-URL: Repository, https://github.com/Kitware/SMQTK-Descriptors
Description-Content-Type: text/markdown

# SMQTK - Descriptors

## Intent
This package aims to provide interfaces for algorithms and data structures
around computing descriptor vectors from input data.

This package also includes a utility function that can map an arbitrary
function to some set of input iterables, not unlike the python `map`, except
that this version is parallelized across threads or processes. This function
also does not block and may be used for parallelized stream processing.

## Documentation
You can build the sphinx documentation locally for the most up-to-date
reference:
```bash
# Install dependencies
poetry install
# Navigate to the documentation root.
cd docs
# Build the docs.
poetry run make html
# Open in your favorite browser!
firefox _build/html/index.html
```

