Refactor dataset validators

[lochhh]

Description

What is this PR

• Bug fix
• Addition of a new feature
• Other

Why is this PR needed?
Closes #241 #210

What does this PR do?

• Reorganises the datasets validators (ValidPosesInputs, ValidBboxesInputs) to subclass from _BaseDatasetInputs
• Rewrites the relevant tests to reduce duplication - what have been tested in the parent class are not repeated in the subclasses
• Enforces uniqueness in keypoint_names, individual_names supplied (in addition to length check)
• Replaces hardcoded index numbers (e.g. fragile assumption that -1 refers to the individuals dim) by inferring based on DIM_NAMES
• Renames dataset validator classes to better reflect what they actually are (input validators, but not datasets)
• Moves _ds_from_valid_data into the input validator classes as to_dataset for converting validated inputs into xr.Datasets

References

#241, #210 part of #667

How has this PR been tested?

Unit tests have been rewritten

Is this a breaking change?

Yes, the Validators have been renamed to ValidPosesInputs and ValidBboxesInputs

Does this PR require an update to the documentation?

Not until #722 is finalised

Checklist:

• The code has been tested locally
• Tests have been added to cover all new functionality
• The documentation has been updated to reflect any changes
• The code has been formatted with pre-commit

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (96c28a7) to head (50af275).
⚠️ Report is 3 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##              main      #706   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           34        34           
  Lines         2104      2110    +6     
=========================================
+ Hits          2104      2110    +6     

☔ 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.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[sfmig]

Amazing job, thanks @lochhh! 🚀

I like the modularity in both the validators and their tests, it makes everything so much more readable.

My comments are mostly about variable names, I'm curious about your opinion and don't feel too strongly about them either. Let me know thoughts.

[niksirbi]

I've also had a look at this, out of interest, and had very little to add (see inline comments). Adding my approval to the list.

[lochhh]

Thanks @sfmig and @niksirbi for your input!
The main changes are

• renaming validators to _BaseDatasetInputs, ValidPosesInputs, ValidBboxesInputs
• adding the abstract method to_dataset() to_BaseDatasetInputs
• moving _ds_from_valid_data in load_poses, load_bboxes into the respective ValidInputs.to_dataset implementations and adding the unit tests
• rephrasing error messages, docstrings

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud