Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add bboxes sample data #231

Merged
merged 12 commits into from
Jun 28, 2024
Merged

Add bboxes sample data #231

merged 12 commits into from
Jun 28, 2024

Conversation

sfmig
Copy link
Contributor

@sfmig sfmig commented Jun 20, 2024

Description

What is this PR

  • Bug fix
  • Addition of a new feature
  • Other

Why is this PR needed?
We are adding a bounding boxes dataset and we need sample data to test it.

In the GIN repository for the test data, I added a sample VIA tracks file and updated the metadata file. To distinguish between pose and bounding boxes data, I added a type field in the metadata.yaml file.

This PR adapts the code to take that into account.

What does this PR do?
Adapts the sample_data module to load the sample bounding boxes file.

The data is not loaded yet as a dataset, since that is the focus of PR #229. As a result, that bit is not fully tested (yet), and codecov shows fail.

References

\

How has this PR been tested?

Tests pass locally and in CI.

Is this a breaking change?

We should be able to load old versions of the sample data, but I am not sure that is actually a functionality we want to support. Tests wouldn't pass with the old metadata file though (because we check the keys are the expected ones, which now include 'type').

Does this PR require an update to the documentation?

Yes, the CONTRIBUTING.md file has been updated.

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

Copy link

codecov bot commented Jun 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.70%. Comparing base (2e406e1) to head (aab31c3).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #231   +/-   ##
=======================================
  Coverage   99.70%   99.70%           
=======================================
  Files          12       12           
  Lines         678      681    +3     
=======================================
+ Hits          676      679    +3     
  Misses          2        2           

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

@sfmig sfmig marked this pull request as ready for review June 20, 2024 16:08
@sfmig sfmig requested a review from niksirbi June 20, 2024 16:08
@sfmig sfmig force-pushed the smg/sample-bboxes-data branch from ba0dc18 to 1f0ffdc Compare June 20, 2024 18:40
@sfmig sfmig changed the title Add bboxes sample data Add bboxes sample data (3/4) Jun 20, 2024
Copy link
Collaborator

@lochhh lochhh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @sfmig! Minor suggestions and changes. I would also remove (3/4) from the PR title before merging.

tests/test_unit/test_sample_data.py Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
CONTRIBUTING.md Outdated Show resolved Hide resolved
movement/sample_data.py Outdated Show resolved Hide resolved
tests/conftest.py Outdated Show resolved Hide resolved
movement/sample_data.py Outdated Show resolved Hide resolved
movement/sample_data.py Outdated Show resolved Hide resolved
movement/sample_data.py Outdated Show resolved Hide resolved
CONTRIBUTING.md Show resolved Hide resolved
@sfmig sfmig changed the title Add bboxes sample data (3/4) Add bboxes sample data Jun 27, 2024
@sfmig sfmig requested a review from lochhh June 27, 2024 18:35
movement/sample_data.py Outdated Show resolved Hide resolved
tests/conftest.py Outdated Show resolved Hide resolved
@lochhh
Copy link
Collaborator

lochhh commented Jun 28, 2024

I also had a go at refactoring fetch_dataset_paths and went ahead with replacing "pose"-related docstrings in sample_data.py with the more generic "data" as you've done with the var names.

Copy link

Copy link
Collaborator

@lochhh lochhh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good to go 🚀 only held off by Anaconda issues

@sfmig sfmig added this pull request to the merge queue Jun 28, 2024
Merged via the queue into main with commit 7f6553b Jun 28, 2024
17 checks passed
@lochhh lochhh deleted the smg/sample-bboxes-data branch July 1, 2024 10:04
@lochhh lochhh mentioned this pull request Jul 10, 2024
8 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants