Releases: knaw-huc/loghi-htr
Releases · knaw-huc/loghi-htr
1.2.3
Release Notes for Loghi-HTR Version 1.2.3
Date: 2023-10-02
Overview
This release introduces significant refactoring, added VGSL Spec functionality, unit tests, and upgraded dependencies. It also brings improvements to the documentation and cleanups in the file structure.
New Features
- VGSL Spec Implementation: Added VGSL spec-type model creation functionality.
- Unit Tests: Introduced unittests for the most-used classes and additional functionalities.
- Custom VGSL Model Names: Models can now be named using the
--model_name
argument. - VGSL Spec String Conversion: Models can now be converted to a VGSL spec string using the
VGSLSpecGenerator.model_to_string(model)
function.
Enhancements
- Improved Documentation: Enhanced the
README.md
with a FAQ section, API usage section, and more accurate and consistent information. - GitHub Actions Integration: Setup GitHub Actions to run unittests on push/pull requests.
- Confidence Interval: Added a 95% confidence interval feature.
- Dependency Upgrades: Upgraded various dependencies and set Python requirement to > 3.8.
Deprecations and Removals
- Old Model Creation Method Deprecated: The previous method of creating models is no longer supported. Models must now be created either from the model library or using a VGSL spec string. This change facilitates rapid and structured prototyping among other benefits. For details on transitioning from the old to the new method, see the "Upgrading" section of these release notes.
- File Cleanup: Removed many unused files and arguments.
- Requirements.txt Moved: Moved
requirements.txt
out of thesrc
folder.
Upgrading
- New models must now be created with either a VGSL spec string, or "model" + the version number corresponding to the "old" way of creating models. For example,
--model new17
becomes--model model17
. - Old models can be converted to VGSL spec by running the following command:
This command will be helpful for users who have old models and want to convert them to the new VGSL spec format, making the upgrading process smoother.
python3 src/vgsl_spec_generator.py --model_dir /path/to/model/dir/
Docker Image
The Docker image for version 1.2.3 can be obtained using the following command:
docker pull loghi/docker.htr:1.2.3
Contributors
- @TimKoornstra: Major contributions including refactoring, VGSL Spec implementation, documentation improvements, and more.
- @Thelukepet: Significant contributions including writing most of the VGSL spec string, updating the corresponding README documentation, file cleanup, and implementing the 95% confidence interval feature.