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

Incorrectly defined frame number and frame index in GT jobs when startFrame != 0 #8507

Closed

Conversation

bsekachev
Copy link
Member

@bsekachev bsekachev commented Oct 3, 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

  • New Features

    • Enhanced frame number retrieval logic for improved accuracy.
    • Updated functions to streamline frame indexing and retrieval processes.
  • Bug Fixes

    • Adjusted frame index calculations to correctly account for offsets, reducing errors in frame operations.

Copy link
Contributor

coderabbitai bot commented Oct 3, 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 changes in this pull request primarily involve modifications to the FramesMetaData and FrameData classes in the frames.ts file. Adjustments were made to the calculation of frame indices, particularly in the getFrameIndex method, to incorporate the startFrame offset. The getDataFrameNumber function was updated to accept a FramesMetaData instance, enhancing frame number retrieval accuracy. Additionally, the getFrame and findFrame functions were modified to ensure consistency in frame number calculations across the codebase.

Changes

File Change Summary
cvat-core/src/frames.ts - Modified getFrameIndex to account for startFrame offset in frame index calculations.
- Updated getDataFrameNumber to accept FramesMetaData instance.
- Adjusted getFrame to utilize the updated getDataFrameNumber.
- Revised findFrame to reflect changes in frame existence checks.

Poem

🐰 In the world of frames so bright,
We hop along with all our might.
With numbers clear and paths aligned,
Our frames now dance, perfectly timed!
So let’s rejoice, both big and small,
For frame calculations, we’ve conquered all! 🎉


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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration 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 changed the title Incorrectly defined frame number and chunk index in GT jobs when startFrame != 0 Incorrectly defined frame number and frame index in GT jobs when startFrame != 0 Oct 3, 2024
@bsekachev bsekachev changed the title Incorrectly defined frame number and frame index in GT jobs when startFrame != 0 [WIP] Incorrectly defined frame number and frame index in GT jobs when startFrame != 0 Oct 3, 2024
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: 2

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 1285858 and dead428.

📒 Files selected for processing (1)
  • cvat-core/src/frames.ts (5 hunks)
🔇 Additional comments (1)
cvat-core/src/frames.ts (1)

187-187: Update to frameIndex calculation is correct

The adjustment accounts for the startFrame offset, ensuring correct alignment with the includedFrames array. This change improves the accuracy of frame indexing within the job.

@@ -713,7 +717,7 @@ export async function getFrame(
// TODO: migrate to local frame numbers
const dataStartFrame = getDataStartFrame(meta, startFrame);
const dataFrameNumberGetter = (frameNumber: number): number => (
getDataFrameNumber(frameNumber, dataStartFrame, meta.frameStep)
getDataFrameNumber(meta, frameNumber, dataStartFrame, meta.frameStep)
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Consider caching getDataFrameNumber computations

The calls to getDataFrameNumber at lines 720 and 817 use the same parameters. Refactoring to compute the data frame number once and reuse it could enhance performance and readability.

Also applies to: 817-817

Comment on lines 327 to 334
function getDataFrameNumber(meta: FramesMetaData, frameNumber: number, dataStartFrame: number, step: number): number {
if (meta.includedFrames.length) {
return meta.includedFrames[frameNumber] + dataStartFrame;
}

Copy link
Contributor

Choose a reason for hiding this comment

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

⚠️ Potential issue

Add bounds check for meta.includedFrames access

In getDataFrameNumber, accessing meta.includedFrames[frameNumber] without verifying that frameNumber is within valid bounds may lead to an index out of bounds error. Please add a check to ensure frameNumber is less than meta.includedFrames.length to prevent potential runtime exceptions.

Apply this diff to add bounds checking:

function getDataFrameNumber(meta: FramesMetaData, frameNumber: number, dataStartFrame: number, step: number): number {
    if (meta.includedFrames.length) {
+       if (frameNumber >= meta.includedFrames.length || frameNumber < 0) {
+           throw new ArgumentError(`Frame number ${frameNumber} is out of bounds`);
+       }
        return meta.includedFrames[frameNumber] + dataStartFrame;
    }

    return frameNumber * step + dataStartFrame;
}
📝 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
function getDataFrameNumber(meta: FramesMetaData, frameNumber: number, dataStartFrame: number, step: number): number {
if (meta.includedFrames.length) {
return meta.includedFrames[frameNumber] + dataStartFrame;
}
function getDataFrameNumber(meta: FramesMetaData, frameNumber: number, dataStartFrame: number, step: number): number {
if (meta.includedFrames.length) {
if (frameNumber >= meta.includedFrames.length || frameNumber < 0) {
throw new ArgumentError(`Frame number ${frameNumber} is out of bounds`);
}
return meta.includedFrames[frameNumber] + dataStartFrame;
}

@bsekachev bsekachev changed the base branch from develop to zm/validation-management-core October 3, 2024 18:34
@bsekachev bsekachev changed the title [WIP] Incorrectly defined frame number and frame index in GT jobs when startFrame != 0 Incorrectly defined frame number and frame index in GT jobs when startFrame != 0 Oct 3, 2024
Copy link

sonarcloud bot commented Oct 3, 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.

1 participant