beaver-lodge / beaver

MLIR Toolkit in Elixir and Zig.
MIT License
164 stars 8 forks source link

Unified naming convention of beaver CAPI #352

Closed jackalcooper closed 3 months ago

jackalcooper commented 3 months ago

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

Walkthrough

The changes primarily focus on renaming functions across various modules to enhance clarity and consistency in naming conventions. The adjustments involve both internal function calls and exported APIs, ensuring a clearer understanding of their purposes within the MLIR framework. Despite these changes, the overall functionality and control flow of the modules remain intact, promoting better readability and maintainability across the codebase.

Changes

Files Change Summary
lib/beaver/mlir.ex, lib/beaver/mlir/attribute.ex, lib/beaver/mlir/execution_engine.ex, lib/beaver/mlir/module.ex, lib/beaver/mlir/operation/state.ex Renamed various is_null functions and their calls for consistency; logic remains unchanged.
lib/beaver/mlir/pattern.ex Updated function call from beaverApplyPatternsAndFoldGreedily to beaverModuleApplyPatternsAndFoldGreedily.
lib/beaver/slang.ex Renamed :beaverGetIRDLDefinedAttr to :beaverIRDLGetDefinedAttr and :beaverGetIRDLDefinedType to :beaverIRDLGetDefinedType.
lib/beaver/walker.ex Simplified function names by removing the Mlir prefix in named attribute handling functions.
native/include/mlir-c/Beaver/Context.h, native/include/mlir-c/Beaver/Op.h Renamed functions to improve clarity, e.g., adding "Context" to multi-threaded execution functions.
native/lib/CAPI/Beaver.cpp Updated various exported functions for consistency, including renaming beaverGetRegisteredOps to beaverContextGetOps.
native/src/pass.zig, native/src/registry.zig Modified function calls to reflect updated API names, retaining overall structure.
test/capi_test.exs, test/pdl_test.exs Adjusted test cases to reflect renamed functions, ensuring assertions remain valid.

Sequence Diagram(s)

sequenceDiagram
    participant A as User
    participant B as BeaverModule
    participant C as CAPI

    A->>B: Call is_null(attribute)
    B->>C: Call CAPI.beaverIsNullAttribute(attribute)
    C-->>B: Return boolean value
    B-->>A: Return term

πŸ‡ In code we hop and play,
Renaming leads the way,
Clearer paths in every line,
Helping us to tune and shine.
With functions bright and clean,
Together, we'll achieve the dream! ✨


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.