Refactor tracking

[nikk-nikaznan]

After #141
Another attempt of #106
Probably first attempt towards #190

[codecov-commenter]

Codecov Report

Attention: Patch coverage is 26.26932% with 334 lines in your changes missing coverage. Please review.

Project coverage is 39.60%. Comparing base (e247e89) to head (380da85).

Files	Patch %	Lines
crabs/tracker/track_video.py	0.00%	99 Missing ⚠️
crabs/tracker/sort.py	0.00%	77 Missing ⚠️
crabs/tracker/utils/sort.py	0.00%	65 Missing ⚠️
crabs/tracker/utils/io.py	0.00%	38 Missing ⚠️
crabs/tracker/utils/tracking.py	61.53%	15 Missing ⚠️
crabs/tracker/evaluate_tracker.py	86.36%	12 Missing ⚠️
crabs/detector/utils/detection.py	23.07%	10 Missing ⚠️
crabs/detector/utils/train.py	40.00%	9 Missing ⚠️
crabs/detector/evaluate_model.py	0.00%	7 Missing ⚠️
crabs/detector/utils/evaluate.py	50.00%	2 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #193      +/-   ##
==========================================
+ Coverage   37.91%   39.60%   +1.68%     
==========================================
  Files          20       24       +4     
  Lines        1440     1414      -26     
==========================================
+ Hits          546      560      +14     
+ Misses        894      854      -40     

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

[sfmig]

Hi @nikk-nikaznan,

I liked this organisation, feels clearer!

I had a go at changing a few things - below an attempt at explaining my thinking. Let me know thoughts.

general

• I renamed the detection module ---> detector.
• I renamed the tracking module ---> tracker.

This is to avoid repetition between higher and lower level modules.

detector module

• I added a crabs.detector.utils submodule.
  • It holds the previous _utils modules.
  • Specifically, I split detection_utils and evaluation_utils into:
    • crabs.detector.utils.detection: utils shared by evaluation and training,
    • crabs.detector.utils.train: utils only used in training,
    • crabs.detector.utils.evaluate: utils only used in evaluation.
  • I also moved the optuna utils there (named optuna for now, but we can discuss!) and the visualization.

Initially I wasn't sure if it would be too much nesting (mainly wanted to try). But I think it leaves the crabs.detector level a bit more clear at a glance. It may help writing unit tests too.

tracker module

In the tracker module I did some more substantial changes. I tried to follow the structure of crabs.detector.

• I added a crabs.tracker.sort module, which only has the tracker classes
  • (somewhat equivalent to crabs.detector.models).
• I added a crabs.tracker.evaluate_tracker module with a TrackerEvaluate class
  • (somewhat equivalent to crabs.detector.evaluate_model and the DetectorEvaluate class).
• I added a crabs.tracker.track_video module which would be the main entry point
  • (somewhat equivalent to crabs.detector.train_model or crabs.detector.evaluate_model).
• a crabs.tracker.utils submodule, which holds
  • sort utils: I extracted them from the sort script,
  • tracking utils: the previous tracking_utils,
  • io utils. This is the most substantial change. The io module contains what was called before inference, removing the class. The class was called Inference but it seemed mostly io operations (there was no prediction or tracking in the class), so I thought this format could work better.

other

I think having a separate config is a good idea!

I also changed the entry points name for the tracker to something a bit more explicit (albeit longer): detect-and-track-video.

I did my best but I am les familiar with the tracking bits, so there may be fixes required in the tracking 🙈

[nikk-nikaznan]

Thank you Sofia! Looking good. I just fixed some tracking bits that throw error. I am happy with the new name convention, I just tried to follow the module name as in the issue, but have no strong opinion on either. The only thing, can we not rename optuna_util as optuna? We can either do _optuna or hyperparameter_optimizer or hpo?

[sfmig]

LGTM! 🚀

I leave you the satisfaction of pressing the big green 🔘 😁