⚡ Improve Engine Performance and Implementation

[shaneahmed]

• Improve Engines performance and implementation
• Redesigns PatchPredictor engine using the new EngineABC base class.
• The WSIs are now processed using the same code as for the processing the patches using WSI based dataloader.
• The intermediate output is saved as zarr for the WSIs to resolve memory issues.
• The output of model architectures should now be a dictionary.
• The output can be specified as AnnotationStore for visualisation using TIAViz.
• Fix mypy Type Checks for cli/common.py
• Redesigns PatchPredictor engine using the new EngineABC base class.
• The WSIs are now processed using the same code as for the processing the patches using WSI based dataloader.
• The intermediate output is saved as zarr for the WSIs to resolve memory issues.
• The output of model architectures should now be a dictionary.
• The output can be specified as AnnotationStore for visualisation using TIAViz.
• Add PatchPredictor Engine based on EngineABC
• Add return_probabilities option to Params
• Removes merge_predictions option in PatchPredictor engine.
• Defines post_process_cache_mode which allows running the algorithm on WSI
• Add infer_wsi for WSI inference
• Removes save_wsi_output as this is not required after post processing.
• Removes merge_predictions and fixes docstring in EngineABCRunParams
• compile_model is now moved to EngineABC init
• Fixes bug with _calculate_scale_factor
• Fixes a bug in class_dict definition.
• _get_zarr_array is now a public function get_zarr_array in misc
• patch_predictions_as_annotations runs the loop on patch_coords instead of class_probs

[codecov]

Codecov Report

❌ Patch coverage is 83.62832% with 111 lines in your changes missing coverage. Please review.
✅ Project coverage is 91.19%. Comparing base (5bb255b) to head (ca49b18).
⚠️ Report is 1 commits behind head on develop.

Files with missing lines	Patch %	Lines
tiatoolbox/models/dataset/dataset_abc.py	72.85%	38 Missing ⚠️
tiatoolbox/models/engine/io_config.py	56.75%	32 Missing ⚠️
tiatoolbox/utils/misc.py	57.14%	26 Missing and 1 partial ⚠️
tiatoolbox/models/engine/semantic_segmentor.py	33.33%	12 Missing ⚠️
tiatoolbox/cli/nucleus_instance_segment.py	0.00%	1 Missing ⚠️
tiatoolbox/cli/semantic_segment.py	0.00%	1 Missing ⚠️

❗ There is a different number of reports uploaded between BASE (5bb255b) and HEAD (ca49b18). Click for more details.

HEAD has 1 upload less than BASE

Flag	BASE (5bb255b)	HEAD (ca49b18)
	5	4

Additional details and impacted files

@@             Coverage Diff             @@
##           develop     #578      +/-   ##
===========================================
- Coverage    99.09%   91.19%   -7.90%     
===========================================
  Files           71       73       +2     
  Lines         9161     9374     +213     
  Branches      1196     1230      +34     
===========================================
- Hits          9078     8549     -529     
- Misses          59      792     +733     
- Partials        24       33       +9     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.