Smqtk-descriptors

=======

This minor release updates the mimumum supported python to `python = "^3.8"`, addresses dependency vulnerabilities, and updates typing to conform with current mypy and pytest standards.

Updates / New Features
----------------------

Python

* New minimum supported python changed to `python = "^3.8"`.

CI

* Added workflow to inherit the smqtk-core publish workflow.

* Updated CI unittests workflow to include codecov reporting.
Reduced CodeCov report submission by skipping this step on scheduled runs.

* Updated CI unittests to reflect new minimum support `python = "^3.8"`.

Miscellaneous

* Added a wrapper script to pull the versioning/changelog update helper from
smqtk-core to use here without duplication.

Misc.

* Added PyTorch descriptor generator implementation.

Testing

* Updated pytest configuration to cover package + tests and added report output
options.

* Removed or no-cover mark dead lines of code.

Documentation

* Updated CONTRIBUTING.md to reference smqtk-core's CONTRIBUTING.md file.

Fixes
-----

CI

* Modified CI unittests workflow to run for PRs targetting branches that match
the `release*` glob.

Dependency Versions

* Updated the locked version of urllib3 to address a security vulnerability.

* Updated the locked version of pillow to address a security vulnerability.

* Updated the developer dependency and locked version of ipython to address a
security vulnerability.

* Removed `jedi = "^0.17.2"` requirement since recent `ipython = "^7.17.3"`
update appropriately addresses the dependency.

* Updated the locked versions of dependencies to reflect new minimum support `python = "^3.8"`.

=======

Updates / New Features
----------------------

Fixes
-----
* Remove 'type_col' query option from PostgresDescriptorElement _get_many_vectors()

Updates / New Features
----------------------

Utilities

* ``parallel_map`` learned to retain to feeder thread and workers until
iterator completion via "master stop" mechanic. This allows the mechanism to
now support PyTorch tensors in multiprocessing mode.

Fixes
-----

=======
This release deprecates and renames certain variables and functions to modernize
some of the code while preserving functionality. It also adds the ability
for images to be handles directly in `ImageDescriptorGenerator` while also
paving the way to include a future `VideoDescriptorGenerator`.


Updates / New Features
----------------------

Deprecations

* Deprecated and renamed various functions with `iter*` prefix because this is
no longer a standard. Deprecation warnings were added to preserve usability.

* Removed `type_str` from `descriptor_element` interface and impls because the
type-string attribute isn't utilized.

Utils

* More usefully type and annotate
:func:`smqtk_descriptors.utils.parallel.parallel_map` to pass through the
input callable's annotated return type as the iteration output of the
returned :class:`~smqtk_descriptors.utils.parallel.ParallelResultsIterator`
instance.

Features

* Created :class:`~smqtk_descriptors.interfaces.image_descriptor_generator.ImageDescriptorGenerator`
And added an implementation :class:`smqtk_descriptors.impls.descriptor_generator.image_descriptor_generator_wrapper.ImageDescriptorGeneratorWrapper`
for the purposes of handling image matrices directly.

Fixes
-----

=======
This minor release updates the build system used to [Poetry], updates the
``smqtk-core`` package dependency to a version >= 0.18.0 (the current release)
and makes use of its importlib metadata pass-through.


Updates / New Features
----------------------

Dependencies

* Remove dependency on ``setuptool``'s ``pkg_resources`` module.
Taking the stance of bullet number 5 in from [Python's Packaging User-guide]
with regards to getting this package's version.
The "needs to be installed" requirement from before is maintained.

* Added ``ipython`` (and appropriately supporting version of ``jedi``) as
development dependencies.
Minimum versioning is set to support python 3.6 (current versions follow
[NEP 29] and thus require python 3.7+).

Misc.

* Now standardize to using [Poetry] for environment/build/publish management.

* Collapsed pytest configuration into the ``pyproject.toml`` file.

Testing

* Added terminal-output coverage report in the standard pytest config in the
``pyproject.toml`` file.

Fixes
-----

* Update CI configurations to use [Poetry].


[Poetry]: https://python-poetry.org/
[Python's Packaging User-guide]: https://packaging.python.org/guides/single-sourcing-package-version/
[NEP 29]: https://packaging.python.org/guides/single-sourcing-package-version/

SMQTK v0.15.0 Release Notes
===========================

This is the initial release of ``smqtk-descriptor``, spinning off from
v0.14.0 of the monolithic [SMQTK](https://github.com/kitware/smqtk) library.


Updates / New Features
----------------------

CI

* Added actions workflow for CI on GitHub.

Misc.

* Updated various type annotations for type-checking compliance.

* Updated to use now publicly available ``smqtk-dataprovider`` package from
PYPI.


Fixes
-----

CI

* Fix other LGTM warnings.

Descriptor Element

* Removed old ``elements_to_matrix`` utility function, replacing it's use with
the appropriate invocation of `smqtk.utils.parallel.parallel_map`.

Descriptor Set

* Memory

* Fixed issue with iter* methods not returning *Iterator* types, which
specifically caused an issue with `iterdescriptors` as it is used in the
parent-class definition of ``__iter__``, which requires that an
iterator-type be returned.

Misc.

* Fixed issue with packages specifier in ``setup.py`` where it was only
excluding the top-level ``tests`` module but including the rest. Fixed to
only explicitly include the ``smqtk_descriptors`` package and submodules.

* Fixed issues with type checking mypy tests exposed with more strict settings.

Utilities

* Parallel

* Fix `smqtk_descriptors.util.parallel._Worker` definition of
`_Worker._make_event` to a class method instead of an instance
method.

* Fix overly broad ``BaseException`` catches that didn't re-raise to more
specifically handle ``Exception`` and ``KeyboardInterrupt`` classes.