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

[AL-2135] 3d bbox doc api #2145

Merged
merged 6 commits into from
Jan 30, 2023
Merged

[AL-2135] 3d bbox doc api #2145

merged 6 commits into from
Jan 30, 2023

Conversation

adolkhan
Copy link
Contributor

🚀 🚀 Pull Request

Checklist:

  • My code follows the style guidelines of this project and the Contributing document
  • I have commented my code, particularly in hard-to-understand areas
  • I have kept the coverage-rate up
  • I have performed a self-review of my own code and resolved any problems
  • I have checked to ensure there aren't any other open Pull Requests for the same change
  • I have described and made corresponding changes to the relevant documentation
  • New and existing unit tests pass locally with my changes

Changes

Docs API on 3d bbox

@tatevikh tatevikh changed the title 3d bbox doc api [AL-2135] 3d bbox doc api Jan 27, 2023

- ``length`` - is the length of the bounding box along x direction
- ``width`` - is the width of the bounding box along y direction
- ``height`` - is the height of the bounding box along z direction
Copy link
Contributor

Choose a reason for hiding this comment

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

also describe rot_x, -rot_z and rot_y

- ``length`` - is the length of the bounding box along x direction
- ``width`` - is the width of the bounding box along y direction
- ``height`` - is the height of the bounding box along z direction
- ``rot_x`` - rotation angel along x axis, given in degrees
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- ``rot_x`` - rotation angel along x axis, given in degrees
- ``rot_x`` - rotation angle along x axis, given in degrees

- ``width`` - is the width of the bounding box along y direction
- ``height`` - is the height of the bounding box along z direction
- ``rot_x`` - rotation angel along x axis, given in degrees
- ``rot_y`` - rotation angel along y axis, given in degrees
Copy link
Contributor

Choose a reason for hiding this comment

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

typo


Bounding boxes are in KITTI format. In order for bounding boxes to be correctly displayed by the visualizer, the format of the bounding box should be as follows:

``[x, y, z, length, width, hieght, rot_x, -rot_z, rot_y]``
Copy link
Contributor

Choose a reason for hiding this comment

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

why does rot_z have a minus symbol? Also follow this same ordering in the descriptions below

Copy link
Contributor

@FayazRahman FayazRahman left a comment

Choose a reason for hiding this comment

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

Few typos

@codecov
Copy link

codecov bot commented Jan 27, 2023

Codecov Report

Base: 88.32% // Head: 88.23% // Decreases project coverage by -0.09% ⚠️

Coverage data is based on head (f63fb43) compared to base (19343a3).
Patch has no changes to coverable lines.

❗ Current head f63fb43 differs from pull request most recent head 378b91b. Consider uploading reports for the commit 378b91b to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2145      +/-   ##
==========================================
- Coverage   88.32%   88.23%   -0.09%     
==========================================
  Files         291      287       -4     
  Lines       32059    31750     -309     
==========================================
- Hits        28317    28016     -301     
+ Misses       3742     3734       -8     
Flag Coverage Δ
unittests 88.23% <ø> (-0.09%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
deeplake/util/downsample.py 84.00% <0.00%> (-3.84%) ⬇️
deeplake/core/query/filter.py 78.90% <0.00%> (-1.18%) ⬇️
deeplake/core/linked_chunk_engine.py 90.65% <0.00%> (-1.01%) ⬇️
deeplake/core/serialize.py 96.19% <0.00%> (-0.58%) ⬇️
deeplake/core/transform/transform_tensor.py 80.15% <0.00%> (-0.47%) ⬇️
deeplake/core/tiling/deserialize.py 88.88% <0.00%> (-0.35%) ⬇️
deeplake/core/chunk/uncompressed_chunk.py 93.67% <0.00%> (-0.24%) ⬇️
deeplake/__init__.py 95.00% <0.00%> (-0.09%) ⬇️
deeplake/core/chunk_engine.py 94.15% <0.00%> (-0.08%) ⬇️
deeplake/core/tensor.py 88.29% <0.00%> (-0.07%) ⬇️
... and 11 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

docs/source/Htypes.rst Outdated Show resolved Hide resolved
@adolkhan adolkhan merged commit 261ca16 into main Jan 30, 2023
@adolkhan adolkhan deleted the bbox-3d-api-docs branch January 30, 2023 11:50
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.

3 participants