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

Fix #130

Merged
merged 7 commits into from
Jul 29, 2024
Merged

Fix #130

merged 7 commits into from
Jul 29, 2024

Conversation

surajpaib
Copy link
Collaborator

@surajpaib surajpaib commented Jul 29, 2024

@ibro45 LighterFileWriter broke because of changes to LighterBaseWriter

I've added some more tests to check test and predict functionality.

I think we should take time to write a more extensive test suite in the near future so we don't break functionality without knowledge.

Summary by CodeRabbit

  • New Features

    • Enhanced error handling in file writing by introducing validation for the specified path.
    • Improved logging for module imports to provide warnings instead of raising errors when modules are already imported.
  • Bug Fixes

    • Adjusted configuration key from directory to path for improved clarity in file writing settings.
  • Tests

    • Expanded test coverage by adding new methods to the testing framework for improved functionality assessment.
  • Chores

    • Simplified configuration by removing explicit callback settings, allowing for default behavior during training.

@dosubot dosubot bot added the size:M This PR changes 30-99 lines, ignoring generated files. label Jul 29, 2024
Copy link
Contributor

coderabbitai bot commented Jul 29, 2024

Walkthrough

The recent changes enhance clarity and error handling across various components of the system. Key updates include renaming the directory parameter to path in the LighterFileWriter class, improving its semantic meaning. In dynamic imports, a more user-friendly logging approach replaces prior error-raising behavior. Adjustments in configuration files streamline definitions, and integration tests have been expanded to cover new functionality, thereby improving robustness and maintainability of the codebase.

Changes

Files Change Summary
lighter/callbacks/writer/file.py Renamed directory parameter to path in LighterFileWriter. Added validation in write method for valid directory paths.
lighter/utils/dynamic_imports.py Updated import_module_from_path to log a warning if a module is already imported, replacing the prior ValueError.
projects/cifar10/experiments/monai_bundle_prototype.yaml Changed key from directory to path for LighterFileWriter configuration, improving semantic clarity.
tests/integration/test_cifar.py Added test and predict method names to the test_trainer_method, expanding the testing scope without altering existing configuration structures.
tests/integration/test_overrides.yaml Removed line setting trainer#callbacks to null, simplifying the configuration and allowing for default behavior in callback management during training.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant LighterFileWriter
    participant DynamicImports
    participant Trainer

    User->>LighterFileWriter: Initialize with path
    LighterFileWriter->>LighterFileWriter: Validate path
    LighterFileWriter->>User: Confirm successful initialization

    User->>DynamicImports: Import module
    alt Module already imported
        DynamicImports-->>User: Log warning
    else New module
        DynamicImports-->>User: Proceed with import
    end

    User->>Trainer: Start training
    Trainer->>Trainer: Execute callbacks
    Trainer-->>User: Training complete
Loading

Poem

In the code, a path we find,
A rabbit's hop, a leap of mind.
With warnings clear and tests so bright,
We write our code, a joyful sight!
Hooray for changes, let’s all cheer,
For every bug we've banished here! 🐇✨


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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 6081ebb and 377ed6d.

Files selected for processing (5)
  • lighter/callbacks/writer/file.py (2 hunks)
  • lighter/utils/dynamic_imports.py (1 hunks)
  • projects/cifar10/experiments/monai_bundle_prototype.yaml (1 hunks)
  • tests/integration/test_cifar.py (1 hunks)
  • tests/integration/test_overrides.yaml (1 hunks)
Files skipped from review due to trivial changes (2)
  • projects/cifar10/experiments/monai_bundle_prototype.yaml
  • tests/integration/test_overrides.yaml
Additional comments not posted (6)
tests/integration/test_cifar.py (2)

19-22: LGTM! The addition of the "test" method name enhances test coverage.

The changes are consistent with the existing structure and improve the robustness of the test suite.


24-27: LGTM! The addition of the "predict" method name enhances test coverage.

The changes are consistent with the existing structure and improve the robustness of the test suite.

lighter/utils/dynamic_imports.py (1)

69-70: LGTM! Replacing the ValueError with a logging warning improves robustness.

The change allows the function to handle previously imported modules gracefully, enhancing the user experience.

lighter/callbacks/writer/file.py (3)

23-23: LGTM! Renaming directory to path improves semantic clarity.

The new parameter name better reflects its purpose.


30-31: LGTM! The constructor update is consistent with the parameter rename.

The changes ensure that the base class receives the correctly named argument.


52-53: LGTM! Adding a validation check for the directory path enhances error handling.

The check ensures that the provided path is a valid directory, preventing potential runtime errors.

@ibro45
Copy link
Collaborator

ibro45 commented Jul 29, 2024

Ah, sorry, thanks man. I feel like it has to be a little testathon otherwise there are always more pressing tasks 😅

@ibro45 ibro45 merged commit c88d891 into main Jul 29, 2024
3 checks passed
@ibro45 ibro45 deleted the fix branch July 29, 2024 19:06
@coderabbitai coderabbitai bot mentioned this pull request Nov 30, 2024
11 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size:M This PR changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants