dtch1997 / sae-eap

Edge attribution patching with SAEs
1 stars 0 forks source link

refactor: graph #1

Closed dtch1997 closed 3 months ago

dtch1997 commented 3 months ago

Refactor the graph used in EAP, in preparation for supporting SAEs.

Summary by CodeRabbit

These updates significantly enhance the graph construction and visualization capabilities, offering more robust and efficient tools for end-users.

coderabbitai[bot] commented 3 months ago

[!WARNING]

Rate limit exceeded

@dtch1997 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 9 minutes and 9 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](https://coderabbit.ai/docs/faq) for further information.
Commits Files that changed from the base of the PR and between b8cedeb9d2f7f1b74e61e184cc46307049000f98 and 73f321dcf15d4f2857bab5bbb55670df3ab1ce4e.

Walkthrough

This update introduces significant enhancements and new functionalities to the sae_eap project. Key additions include new dependencies (tensordict and networkx), extension of graph and node management capabilities, new classes and methods for pruning and visualization, and expansion of unit tests. These changes together aim to improve model configuration, graph manipulation, and visualization support within the computational framework.

Changes

File(s) Description of Changes
pyproject.toml Added tensordict and networkx dependencies.
sae_eap/core/constants.py Added new imports and GPT_2_SMALL_MODEL_CONFIG initialization; removed redundant code.
sae_eap/core/types.py Refactored type definitions and removed node name utility functions.
sae_eap/eap/graph.py Introduced classes SAEReconstructionNode and SAEErrorNode; added methods to Graph.
sae_eap/graph/build.py Added functions for building graphs from models/configurations.
sae_eap/graph/edge.py Defined Edge class and related functionalities.
sae_eap/graph/graph.py Enhanced Graph class with new attributes, constructors, and methods for graph management.
sae_eap/graph/node.py Added various node classes (Node, LogitNode, MLPNode, AttentionNode, etc.).
sae_eap/graph/prune.py Introduced pruning classes and methods (ThresholdPruner, TopNPruner, GreedyPruner).
sae_eap/graph/viz.py Added visualization utilities and conversion functions for Graphviz.
tests/unit/conftest.py Added pytest fixture ts_model for model caching.
tests/unit/graph/test_build.py Introduced test for verifying graph structure from a model.
tests/unit/helpers.py Added load_model_cached function for model caching.
.github/workflows/release.yaml Added Graphviz setup step in workflow.
.github/workflows/tests.yaml Added Graphviz setup step in workflow.

Sequence Diagram(s)

sequenceDiagram
    participant Dev as Developer
    participant BuildGraph as build_graph()
    participant Graph as Graph
    participant Config as HookedTransformerConfig

    Note over Dev: Initiate graph building with new functions
    Dev ->>+ BuildGraph: Call build_graph(model_or_config)
    BuildGraph ->> Config: Parse model_or_config

    Note over BuildGraph, Graph: Add nodes and edges as per configuration
    BuildGraph ->>+ Graph: Call add_layer_nodes_and_edges for each layer
    loop For each layer
        Graph ->>+ Graph: Add nodes and edges
    end
    BuildGraph -->>- Dev: Return built Graph

Poem

In code's realm, enhancements spread wide,
With types and nodes, we take the ride.
Graphs now glow with vivid hue,
Builders and pruners, all brand new.
Dependencies grow, our tools refine,
Amidst the logic, our models shine.


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.