CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

[0.8.4] - 2022-08-23

This release include improvements based on review feedback from our JOSS submission. We want to thank our reviewers Carl Simon Adorf, Matthew Feickert and our editor Daniel S. Katz for their valuable contributions.

• Expanded and improved documentation based on Carl Simon Adorf and Matthew Feickert feedback.
  • Added better API description and a new design section by Ítalo Epifânio.
  • Properly described: tests execution and "infinitely hackable" claim by Ítalo Epifânio.
• Made Ipyannotator dependencies more flexible as suggested by Matthew Feickert.
  • Fixed minimum version of the dependencies by Ítalo Epifânio.
• Update dependencies descriptions as advise by Carl Simon Adorf and Matthew Feickert.
  • Removed fixed dependencies from README by Ítalo Epifânio.
  • Synced setup.py with pyproject.toml dependencies by Ítalo Epifânio.
• Improved Ipyannotator support for Python versions according to Matthew Feickert feedback.
  • CI testing now runs for all Python versions supported by Ipyannotator Ítalo Epifânio.
  • Properly build Ipyannotator on Python 3.10 by updating scikit-image minimum version to 1.9.3, pandas minimum version to 1.2.0, and ipywidgets minimum version to 7.6.0 Ítalo Epifânio.

[0.8.3] - 2022-05-06

Added

• Extend documentation with new pages for API Reference and key Input/Output types Ítalo Epifânio.

Change

• Disabled save button when using explore step by Ítalo Epifânio.

Fixed

• Properly select elements on the Capture annotator Ítalo Epifânio.
• Video annotator supports now image resizing by properly using the fit canvas option by Ítalo Epifânio.
• tqdm now rendering correctly at image classification tutorial by Ítalo Epifânio.
• Index error at image classification tutorial when reading the artificial dataset by Ítalo Epifânio.

[0.8.1] - 2022-04-09

Changed

• Refactored notebooks to use python to handle folder structure instead of linux commands by Ítalo Epifânio.

Added

• tqdm dependency Ítalo Epifânio.
• Doc section explaining Ipyannotator dev dependencies Ítalo Epifânio.

[0.8.0] - 2022-04-09

Changed

• Make the creation of new label classes more flexible and decouple it from the folder structure by Ítalo Epifânio.
• Refactored Im2Im and Capture annotators to render any widget on grid menu by Ítalo Epifânio.
• Replaced exception with warning when using the same file storage on multiple annotators by Ítalo Epifânio.

Added

• New fit_canvas option to adjust images to the size of the canvas by Ítalo Epifânio.
• Annotator step (explore, create, improve) can be recovered when using Ipyannotator API by Ítalo Epifânio.
• New documentation theme and structure by Carlos Cerqueira and Ítalo Epifânio.

[0.7.0] - 2022-02-19

Changed

• Updated dependencies to fix Voila's conflict by Ítalo Epifânio.
• Code is now MyPy compliant by Carlos Cerqueira.
• Added TrajectoryStore class to improve code readability by Ítalo Epifânio.

Fixed

• BBoxAnnotator coordinate's input now changes according to the image size Ítalo Epifânio.
• Faster right menu rendering, improving overall VideoAnnotator navigation speed by Ítalo Epifânio.
• Don't draw trajectory for deleted objects in VideoAnnotator by Ítalo Epifânio.

[0.6.0] - 2022-01-31

Added

• New annotator to explore images in a directory (ExploreAnnotator) by Alexander Pisarenko.
• New annotator for video format (VideoAnnotator) by Ítalo Epifânio.
• New tutorial showing how to use the video annotator by Ítalo Epifânio.
• New artifical data generator for video by Carlos Cerqueira.
• New linter to ensure code standard by Carlos Cerqueira.

Changed

• Updated the CI/CD to add the linter verification by Carlos Cerqueira.
• Started to switch classes from Pydantic models to use Attrs by Ítalo Epifânio.
• Refactored callbacks to use the standard on_<prefix>_<action> ex. on_navi_clicked by Ítalo Epifânio.
• Updated dataset download to use pooch by Carlos Cerqueira.

[0.5.2] - 2022-01-01

Added

• New state layer to decouple individual annotators using Pydantic for data validation and PyPubSub for comunication.
• New tutorial showing how to build annotators by Ítalo Epifânio.
• New debug module for annotators by Carlos Cerqueira.
• New voila dockerfile by Carlos Cerqueira.

Changed

• Refactored the annotators to use the new state layer by Ítalo Epifânio.
• Allow users to draw multiple bboxes on the BBoxAnnotator by Enrique Moran with its PR (adapted by Ítalo Epifânio).
• Revisited the tutorial API by Alexander Pisarenko.
• Documentation enhancements and updates to use nbdev to build it by Carlos Cerqueira.

Fixed

• CI test check_lib_diff not validating all notebooks by Carlos Cerqueira.