project-lighter / lighter

Config-based framework for organized and reproducible deep learning. MONAI Bundle + PyTorch Lightning.
https://project-lighter.github.io/lighter
MIT License
22 stars 2 forks source link

Fix #130

Closed surajpaib closed 3 months ago

surajpaib commented 3 months ago

@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

coderabbitai[bot] commented 3 months ago

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

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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
ibro45 commented 3 months ago

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