Changelog#

v2.4.5#

What’s Changed#

  • Fix bugs in “Train Categorizers” module by @rohansatapathy in https://github.com/umyelab/LabGym/pull/148

  • Add internal notes section to documentation by @rohansatapathy in https://github.com/umyelab/LabGym/pull/149

Full Changelog: https://github.com/umyelab/LabGym/compare/v2.4.4…v2.4.5

v2.4.4#

What’s Changed#

  • Fix crash that occurs when no detectors are present by @rohansatapathy in https://github.com/umyelab/LabGym/pull/140

  • Constrain tensorflow version on non-Windows systems by @rohansatapathy in https://github.com/umyelab/LabGym/pull/141

Full Changelog: https://github.com/umyelab/LabGym/compare/v2.4.3…v2.4.4

v2.4.3#

What’s Changed#

  • Fix bug in static image mode

Full Changelog: https://github.com/umyelab/LabGym/compare/v2.4.3…v2.4.4

v2.4.2#

What’s Changed#

  • Fix bug that prevented using the cropping feature in the preprocessing module

Full Changelog: https://github.com/umyelab/LabGym/compare/v2.4.1…v2.4.2

v2.4.1#

What’s Changed#

  • Standardize order of Animation Analyzer and Pattern Recognizer in GUI

  • Fix OpenCV type error when using Background Subtraction

  • Allow for older versions of dependencies

  • Close window preview when canceling contrast in Preprocessing Module

Full Changelog: https://github.com/umyelab/LabGym/compare/v2.4.0…v2.4.1

v2.4.0#

What’s Changed#

  • Remove all references to THE_ABSOLUTE_CURRENT_PATH by @rohansatapathy in https://github.com/umyelab/LabGym/pull/120

  • Increase line length in format configuration by @rohansatapathy in https://github.com/umyelab/LabGym/pull/122

  • Add date/time changes by @rohansatapathy in https://github.com/umyelab/LabGym/pull/126

  • Refactor detector code by @rohansatapathy in https://github.com/umyelab/LabGym/pull/123

  • Add excel file with animal positions in analysis export by @rohansatapathy in https://github.com/umyelab/LabGym/pull/128

  • Fix text scale in annotated video by @rohansatapathy in https://github.com/umyelab/LabGym/pull/129

Full Changelog: https://github.com/umyelab/LabGym/compare/v2.3.5…v2.4.0

v2.3.5#

What’s Changed#

  • Add ruff format rules by @rohansatapathy in https://github.com/umyelab/LabGym/pull/110

  • Update installation instructions by @rohansatapathy in https://github.com/umyelab/LabGym/pull/114

  • Add automated test suite by @rohansatapathy in https://github.com/umyelab/LabGym/pull/115

  • Fix bug in sorting behavior file name by @rohansatapathy in https://github.com/umyelab/LabGym/pull/116

  • Fix detector batch size bug by @rohansatapathy in https://github.com/umyelab/LabGym/pull/117

Full Changelog: https://github.com/umyelab/LabGym/compare/v2.3.4…v2.3.5

v2.3.4#

What’s Changed#

  • Fix cv2.typing import error by @rohansatapathy in https://github.com/umyelab/LabGym/pull/109

Full Changelog: https://github.com/umyelab/LabGym/compare/v2.3.3…v2.3.4

v2.3.3#

What’s Changed#

  • Fix model path bug in behavior_examples.py by @rohansatapathy in https://github.com/umyelab/LabGym/pull/107

  • Update installation documentation by @rohansatapathy in https://github.com/umyelab/LabGym/pull/106

  • Release v2.3.3 by @rohansatapathy in https://github.com/umyelab/LabGym/pull/108

Full Changelog: https://github.com/umyelab/LabGym/compare/v2.3.2…v2.3.3

v2.3.2#

What’s Changed#

  • Prevent crash when version checking fails by @rohansatapathy in https://github.com/umyelab/LabGym/pull/101

  • Update python-publish.yml by @rohansatapathy in https://github.com/umyelab/LabGym/pull/102

Full Changelog: https://github.com/umyelab/LabGym/compare/v2.3.1…v2.3.2

v2.3.1#

New Features#

  • The recommended way to install LabGym is now through pipx. Please see the installation documentation for more information.

  • It’s now possible to start LabGym by using the LabGym command at the terminal! Now, there’s no need to type from LabGym import gui; gui.gui() at the terminal.

What’s Changed#

  • Fix incompatibility issues with Python 3.9 by @rohansatapathy in https://github.com/umyelab/LabGym/pull/99

Full Changelog: https://github.com/umyelab/LabGym/compare/v2.3.0…v2.3.1

v2.3.0#

New Features#

  • The recommended way to install LabGym is now through pipx. Please see the installation documentation for more information.

  • It’s now possible to start LabGym by using the LabGym command at the terminal! Now, there’s no need to type from LabGym import gui; gui.gui() at the terminal.

What’s Changed#

  • Refactor codebase by @rohansatapathy in https://github.com/umyelab/LabGym/pull/70, https://github.com/umyelab/LabGym/pull/85, https://github.com/umyelab/LabGym/pull/93

  • Move documentation to https://labgym.readthedocs.io by @rohansatapathy in https://github.com/umyelab/LabGym/pull/71, https://github.com/umyelab/LabGym/pull/80, https://github.com/umyelab/LabGym/pull/84, https://github.com/umyelab/LabGym/pull/86, https://github.com/umyelab/LabGym/pull/88, https://github.com/umyelab/LabGym/pull/90, https://github.com/umyelab/LabGym/pull/91

  • Start LabGym using the LabGym command at the terminal by @rohansatapathy in https://github.com/umyelab/LabGym/pull/73, https://github.com/umyelab/LabGym/pull/96

  • Add option to downscale video FPS in preprocessing module by @rohansatapathy in https://github.com/umyelab/LabGym/pull/72, https://github.com/umyelab/LabGym/pull/77

Full Changelog: https://github.com/umyelab/LabGym/commits/v2.3.0

v2.2#

  1. Added functions of testing Detectors / Categorizers so that the accuracy of a trained Detector / Categorizer can be tested and reported.

  2. Added behavior mode ‘Static image’ so that LabGym can now analyze behaviors in static images.

  3. Made the spreadsheets for storing behavioral metrics transposed so that they can be more compatible with other platforms.

  4. Other minor optimizations.

v2.1#

  1. Improved the user interface and the Extended User Guide.

  2. Added a tutorial video.

v2.0#

  1. Implemented the analysis pipeline for complex interactive behaviors.

  2. Major improvement on analysis speed.

  3. Bug fix.

v1.9#

  1. Implemented Detector-based detection method. Now the changing background or illumination in videos is no longer a problem for LabGym.

  2. Implemented data mining functional unit.

  3. Implemented preprocessing functional unit.

  4. Simplified code and further optimized the processing speed.

  5. Implemented basic analysis for interactive behavior.

v1.8#

  1. In previous versions, if no animal is detected in a frame, this frame will be skipped. From now on, such frames will not be skipped, and the behavioral classification and quantification will be output as ‘NA’s so that the raster plots and the quantification results can be perfectly aligned for every frame with other data (e.g., ephys recordings).

  2. An ‘uncertain level’ can be added into the Categorizers for reducing the false positives in behavior classification. The Categorizer will output an ‘NA’ if the difference between probability of the highest-likely behavior and the second highest-likely behavior is less than the uncertainty level.

  3. Simplified the user interface.

  4. Optimized the processing speed.

v1.7#

  1. Improved the background extraction and the tracking, making them faster and more accurate.

v1.6#

  1. Added a version checker. If a newer version of LabGym is available, users will see a reminder when initiate the user interface.

v1.5#

  1. Simplified the user interface and made it more self-illustrative.

  2. Added an option of whether to output the distances in pixels when calculating behavior parameters. Previously all the distances were just normalized by the size of a single animal.

v1.4#

  1. Made the time points in the output time-series sheets more precise.

  2. Fixed an error when using the option of ‘load background image’.

v1.3#

  1. Improved background subtraction and the tracking is more accurate.

  2. Now LabGym not only can work for videos with illumination transitions from dark to bright, but can also work for those from bright to dark.

v1.2#

  1. Now LabGym can also be used in categorizing binary behaviors (yes or no behavior, or behaviors with only 2 categories)

  2. Fixed a bug that caused a path error if users did not select any behavior parameters for quantification.

  3. Now users have an option to choose whether to relink newly detected animals to deregistered IDs.

v1.1#

  1. Changed a typo in setup.

v1.0#

Initial release.