search

dtch1997 / sae-eap

Edge attribution patching with SAEs
1 stars 0 forks source link

refactor: nodes #13

Closed dtch1997 closed 3 months ago

dtch1997 commented 3 months ago

Unify SrcNode and DestNode, as in principle, a node can be both a SrcNode and a DestNode

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

Walkthrough

The primary adjustments involve renaming nodes and edges to use more generalized types like TensorNode and AttentionNode, while also consolidating and streamlining type aliases and functionality across multiple files for improved clarity and maintainability. Some test fixtures were updated to align with these changes, ensuring consistency throughout the codebase.

Changes

File Paths Change Summaries
sae_eap/attribute.py Updated imports and type aliases related to the graph module, e.g., changed AttributionScores to EdgeAttributionScores.
sae_eap/graph/init.py Replaced SrcNode and DestNode with AttentionNode, added EdgeName class to imports.
sae_eap/graph/build.py Refactored node classes, changing function returns to use TensorNode and AttentionNode.
sae_eap/graph/edge.py Introduced generic Edge class, specific TensorEdge class, and adjusted node type dependencies.
sae_eap/graph/graph.py Added node property methods, updated type hints, and modified serialization methods.
sae_eap/graph/index.py Refactored TensorGraphIndexer class, updating dictionary types to use TensorNode.
sae_eap/graph/node.py Introduced as_src and as_dest methods, and refactored node classes including AttentionNode.
sae_eap/graph/prune.py Renamed nodes in method signatures and updated associated logic to reflect new names.
sae_eap/runner.py Changed import and return type from AttributionScores to EdgeAttributionScores.
tests/integration/runner/test_run_ablate.py Removed pytest import and test failure expectation decorator.
tests/unit/graph/test_graph.py Updated Node object creation to use named arguments in fixtures.
tests/unit/graph/test_node.py Updated Node instantiation to use named arguments in test function.

Sequence Diagrams

Changes to the control flow do not necessitate new sequence diagrams due to their straightforward refactoring nature.

Poem

In fields of code where functions play, A rabbit smiles at end of day 🐇 Nodes reshaped, edges aligned, A clearer graph now intertwined. With tensors and attention grand, Our project flourishes, just as planned. 🎉

[!WARNING]

Review ran into problems

Problems (1) * Git: Failed to clone repository. Please contact CodeRabbit support.

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