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

Turn off visual encoder #68

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Conversation

aaprasad
Copy link
Contributor

@aaprasad aaprasad commented Jul 23, 2024

Here we add functionality to turn off the visual encoder and just learn associations based on point coordinates

Summary by CodeRabbit

  • New Features
    • Enhanced flexibility in the visual encoder allows for disabling visual feature extraction based on model configuration.
  • Bug Fixes
    • Streamlined error handling for unsupported model names and backends in the visual encoder.
  • Tests
    • Added new test scenarios for the visual encoder to validate behavior with model name set to "off" using both "timm" and "torch" backends.

Copy link
Contributor

coderabbitai bot commented Jul 23, 2024

Warning

Rate limit exceeded

@aaprasad has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 8 minutes and 38 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 3e4af0a and 5b1806b.

Walkthrough

The recent changes streamline the Tracker and VisualEncoder classes by simplifying initialization and feature extraction processes. The Tracker class removed unnecessary parameters, enhancing clarity and reducing complexity in handling visual features. Meanwhile, the VisualEncoder now conditionally disables output layers and feature extraction based on model configuration, improving flexibility. Test coverage has been expanded to validate these new configurations, ensuring robustness in various scenarios.

Changes

File Path Change Summary
dreem/inference/tracker.py Removed use_vis_feats parameter and logic from Tracker class, simplifying feature extraction.
dreem/models/visual_encoder.py Modified out_layer initialization to conditionally use identity or linear layer based on model name. Updated feature extractor to bypass output when model is off, enhancing flexibility.
tests/test_models.py Added test cases for VisualEncoder to validate behavior with model name set to "off" including checks for output dimensions and non-zero values.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Tracker
    participant VisualEncoder

    User->>Tracker: Initialize tracking
    Tracker->>VisualEncoder: Check for features
    alt Features available
        VisualEncoder-->>Tracker: Extract features
    else No features
        VisualEncoder-->>Tracker: Return zeros
    end
    Tracker-->>User: Track results
Loading

🐰 "In the code's gentle warren,
Changes bloom like spring's sweet morn,
Features trimmed, the path made clear,
With every hop, new joys appear!
In layers light or dense, we play,
Visual magic, come what may!" 🌼


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 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.

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: 4

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between a2a544e and 3e4af0a.

Files selected for processing (3)
  • dreem/inference/tracker.py (4 hunks)
  • dreem/models/visual_encoder.py (2 hunks)
  • tests/test_models.py (2 hunks)
Additional context used
Ruff
dreem/models/visual_encoder.py

77-77: SyntaxError: Expected ':', found 'lambda'

dreem/inference/tracker.py

123-123: f-string without any placeholders

Remove extraneous f prefix

(F541)

Additional comments not posted (3)
dreem/models/visual_encoder.py (2)

55-60: LGTM! The conditional assignment of self.out_layer enhances flexibility.

The implementation correctly assigns torch.nn.Identity() to self.out_layer when model_name is "off", an empty string, or None.


118-118: LGTM! The updated error message improves clarity.

The implementation correctly raises a ValueError for unsupported backends.

dreem/inference/tracker.py (1)

112-114: LGTM! The removal of the conditional check simplifies the code.

The implementation correctly simplifies the feature extraction process by removing the self.use_vis_feats check.

Comment on lines 76 to 79
if model_name in ["", "off", None]:
feature_extractor = lambda lambda tensor: torch.zeros(
(tensor.shape[0], self.d_model), dtype=tensor.dtype, device=tensor.device
) # turn off visual features by returning zeros
Copy link
Contributor

Choose a reason for hiding this comment

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

Fix the syntax error in the lambda function.

The lambda function definition is missing a colon.

-            feature_extractor = lambda lambda tensor: torch.zeros(
+            feature_extractor = lambda tensor: torch.zeros(
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 model_name in ["", "off", None]:
feature_extractor = lambda lambda tensor: torch.zeros(
(tensor.shape[0], self.d_model), dtype=tensor.dtype, device=tensor.device
) # turn off visual features by returning zeros
if model_name in ["", "off", None]:
feature_extractor = lambda tensor: torch.zeros(
(tensor.shape[0], self.d_model), dtype=tensor.dtype, device=tensor.device
) # turn off visual features by returning zeros
Tools
Ruff

77-77: SyntaxError: Expected ':', found 'lambda'

Comment on lines 104 to 111
encoder = VisualEncoder(
model_name="off", in_chans=c, d_model=features, backend=backend
)
output = encoder(input_tensor)

assert output.shape == (b, features)
assert not torch.is_nonzero.any()

Copy link
Contributor

Choose a reason for hiding this comment

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

Fix the syntax error in the assertion for non-zero values.

The torch.is_nonzero.any() function call is incorrect.

-    assert not torch.is_nonzero.any()
+    assert not output.any()
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
encoder = VisualEncoder(
model_name="off", in_chans=c, d_model=features, backend=backend
)
output = encoder(input_tensor)
assert output.shape == (b, features)
assert not torch.is_nonzero.any()
encoder = VisualEncoder(
model_name="off", in_chans=c, d_model=features, backend=backend
)
output = encoder(input_tensor)
assert output.shape == (b, features)
assert not output.any()

Comment on lines 53 to 60
encoder = VisualEncoder(
model_name="off", in_chans=c, d_model=features, backend=backend
)
output = encoder(input_tensor)

assert output.shape == (b, features)
assert not torch.is_nonzero.any()

Copy link
Contributor

Choose a reason for hiding this comment

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

Fix the syntax error in the assertion for non-zero values.

The torch.is_nonzero.any() function call is incorrect.

-    assert not torch.is_nonzero.any()
+    assert not output.any()
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
encoder = VisualEncoder(
model_name="off", in_chans=c, d_model=features, backend=backend
)
output = encoder(input_tensor)
assert output.shape == (b, features)
assert not torch.is_nonzero.any()
encoder = VisualEncoder(
model_name="off", in_chans=c, d_model=features, backend=backend
)
output = encoder(input_tensor)
assert output.shape == (b, features)
assert not output.any()

instances_pred = self.sliding_inference(model, frames)

if not self.persistent_tracking:
logger.debug(f"Clearing Queue after tracking")
logger.debug(f"Clearing queue after tracking single batch")
Copy link
Contributor

Choose a reason for hiding this comment

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

Remove the extraneous f prefix in the logging message.

The f prefix is unnecessary as there are no placeholders in the string.

-            logger.debug(f"Clearing queue after tracking single batch")
+            logger.debug("Clearing queue after tracking single batch")
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
logger.debug(f"Clearing queue after tracking single batch")
logger.debug("Clearing queue after tracking single batch")
Tools
Ruff

123-123: f-string without any placeholders

Remove extraneous f prefix

(F541)

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