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

added new movement datasets figure, with caption #286

Merged
merged 3 commits into from
Aug 29, 2024
Merged

Conversation

niksirbi
Copy link
Member

Closes #250.

I updated the figure to show both poses and bboxes datasets, as discussed. I also added a little caption. This is how it displays:

Screenshot 2024-08-28 at 16 02 36

Copy link

codecov bot commented Aug 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.77%. Comparing base (3df12a9) to head (f8e5a97).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #286   +/-   ##
=======================================
  Coverage   99.77%   99.77%           
=======================================
  Files          14       14           
  Lines         883      883           
=======================================
  Hits          881      881           
  Misses          2        2           

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

@niksirbi niksirbi marked this pull request as ready for review August 28, 2024 15:20
@niksirbi niksirbi requested a review from sfmig August 28, 2024 15:20
Copy link
Contributor

@sfmig sfmig left a comment

Choose a reason for hiding this comment

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

I really like it!

Just a suggestion on the caption but feel free to take/leave

```{figure} ../_static/dataset_structure.png
:alt: movement dataset structure

A schematic showing the structure of `poses` and `bboxes` datasets in `movement`.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggestion for caption:

An xarray dataset is a collection of several data arrays that share some axes. The schematic shows the data arrays that make up the poses and bboxes datasets in movement.

It is a bit more specific description, and I think the concept in the first sentence is worth hammering in. But I leave it up to you, it may be too lengthy.

Copy link
Member Author

Choose a reason for hiding this comment

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

I like it, I'll just say "dimensions" instead of "axes", to stay within xarray terminology.

Copy link

sonarcloud bot commented Aug 29, 2024

@niksirbi niksirbi added this pull request to the merge queue Aug 29, 2024
Merged via the queue into main with commit 9612951 Aug 29, 2024
27 checks passed
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.

Add a bboxes dataset figure to "Getting started > The movement dataset"
2 participants