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

Fixed counting of tracks when calculating analytics report #8088

Merged
merged 6 commits into from
Jun 26, 2024

Conversation

bsekachev
Copy link
Member

@bsekachev bsekachev commented Jun 26, 2024

Motivation and context

How has this been tested?

Checklist

  • I submit my changes into the develop branch
  • I have created a changelog fragment
  • I have updated the documentation accordingly
  • I have added tests to cover my changes
  • I have linked related issues (see GitHub docs)
  • I have increased versions of npm packages if it is necessary
    (cvat-canvas,
    cvat-core,
    cvat-data and
    cvat-ui)

License

  • I submit my code changes under the same MIT License that covers the project.
    Feel free to contact the maintainers if that's a concern.

Summary by CodeRabbit

  • Bug Fixes
    • Corrected the issue with incorrect counting of tracked shapes in analytics reports.

@bsekachev bsekachev requested a review from Marishka17 as a code owner June 26, 2024 07:06
Copy link
Contributor

coderabbitai bot commented Jun 26, 2024

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The recent update fixes an issue in the CVAT application's analytics reporting process. Specifically, it addresses inaccurate tracking of shapes in the annotation_speed.py file. The logic now correctly skips empty shape processing and updates track counts within a loop to handle various scenarios more accurately.

Changes

Files/Groups Change Summary
changelog.d/20240626_100703_boris_fixed... Added a changelog entry describing the fix for incorrect shape tracking in the analytics report generation.
cvat/apps/analytics_report/report/prim... Adjusted logic in annotation_speed.py to properly count tracks by skipping empty shapes and refining count logic.

Poem

In code's realm where shapes do finesse,
A bug did cause some analytics stress.
But now with lines both deft and neat,
Our tracks and shapes all count complete.
🎨🐇✨ Happy coding, neat and fast,
Analytics fixed, precision unsurpassed!


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@bsekachev bsekachev requested a review from nmanovic as a code owner June 26, 2024 07:07
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between cdf50d3 and 64ccd52.

Files selected for processing (2)
  • changelog.d/20240626_100703_boris_fixed_analytics.md (1 hunks)
  • cvat/apps/analytics_report/report/primary_metrics/annotation_speed.py (1 hunks)
Additional comments not posted (1)
changelog.d/20240626_100703_boris_fixed_analytics.md (1)

1-4: Changelog entry is clear and concise.

The entry adequately summarizes the fix and provides a direct link to the relevant PR, helping in traceability.

Comment on lines 114 to 129
if not track["shapes"]:
continue

if track["shapes"] and track["shapes"][0]["type"] == ShapeType.SKELETON:
# skeleton's points are already counted as objects
continue

if len(track["shapes"]) == 1:
count += self._db_obj.segment.stop_frame - track["shapes"][0]["frame"] + 1
continue

# add initial frame here since only diff is added in the following loop
count += 1
for prev_shape, cur_shape in zip(track["shapes"], track["shapes"][1:]):
if not prev_shape["outside"]:
count += cur_shape["frame"] - prev_shape["frame"] + 1
count += cur_shape["frame"] - prev_shape["frame"]
Copy link
Contributor

Choose a reason for hiding this comment

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

Refined track counting logic enhances accuracy.

The changes ensure that empty shapes are skipped and handle scenarios where only one shape exists in a track more robustly, improving the accuracy of the count. However, consider adding comments to explain the logic behind counting frames and handling different scenarios for future maintainability.

+                # Skip processing if no shapes are associated with the track
                 if not track["shapes"]:
                     continue
+                # Skip skeleton shapes as their points are already counted
                 if track["shapes"] and track["shapes"][0]["type"] == ShapeType.SKELETON:
                     continue
+                # If only one shape exists, calculate the frames from the first frame to the stop frame of the segment
                 if len(track["shapes"]) == 1:
                     count += self._db_obj.segment.stop_frame - track["shapes"][0]["frame"] + 1
                     continue
+                # Add the initial frame count and then iterate through shapes to count non-outside frames
                 count += 1
                 for prev_shape, cur_shape in zip(track["shapes"], track["shapes"][1:]):
                     if not prev_shape["outside"]:
                         count += cur_shape["frame"] - prev_shape["frame"]
Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
if not track["shapes"]:
continue
if track["shapes"] and track["shapes"][0]["type"] == ShapeType.SKELETON:
# skeleton's points are already counted as objects
continue
if len(track["shapes"]) == 1:
count += self._db_obj.segment.stop_frame - track["shapes"][0]["frame"] + 1
continue
# add initial frame here since only diff is added in the following loop
count += 1
for prev_shape, cur_shape in zip(track["shapes"], track["shapes"][1:]):
if not prev_shape["outside"]:
count += cur_shape["frame"] - prev_shape["frame"] + 1
count += cur_shape["frame"] - prev_shape["frame"]
# Skip processing if no shapes are associated with the track
if not track["shapes"]:
continue
# Skip skeleton shapes as their points are already counted
if track["shapes"] and track["shapes"][0]["type"] == ShapeType.SKELETON:
# skeleton's points are already counted as objects
continue
# If only one shape exists, calculate the frames from the first frame to the stop frame of the segment
if len(track["shapes"]) == 1:
count += self._db_obj.segment.stop_frame - track["shapes"][0]["frame"] + 1
continue
# Add the initial frame count and then iterate through shapes to count non-outside frames
count += 1
for prev_shape, cur_shape in zip(track["shapes"], track["shapes"][1:]):
if not prev_shape["outside"]:
count += cur_shape["frame"] - prev_shape["frame"]

Copy link

@codecov-commenter
Copy link

Codecov Report

Attention: Patch coverage is 0% with 7 lines in your changes missing coverage. Please review.

Project coverage is 83.60%. Comparing base (7aa699d) to head (ee5d004).
Report is 4 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop    #8088      +/-   ##
===========================================
- Coverage    83.61%   83.60%   -0.02%     
===========================================
  Files          383      383              
  Lines        40449    40460      +11     
  Branches      3819     3821       +2     
===========================================
+ Hits         33822    33825       +3     
- Misses        6627     6635       +8     
Components Coverage Δ
cvat-ui 79.59% <ø> (+<0.01%) ⬆️
cvat-server 87.25% <0.00%> (-0.03%) ⬇️

@bsekachev bsekachev merged commit 1e331ba into develop Jun 26, 2024
33 checks passed
@bsekachev bsekachev deleted the bs/fixed_analytics branch June 26, 2024 09:52
@cvat-bot cvat-bot bot mentioned this pull request Jul 2, 2024
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