dtch1997 / sae-eap

Edge attribution patching with SAEs
1 stars 0 forks source link

fix: attribution calculation #14

Closed dtch1997 closed 2 months ago

dtch1997 commented 3 months ago

Summary by CodeRabbit

coderabbitai[bot] commented 3 months ago

[!WARNING]

Review failed

The pull request is closed.

Walkthrough

The project saw the introduction of a new example notebook and various enhancements to the existing codebase. Notebook additions provide a comprehensive pipeline for model handling, graph operations, and ablation experiments. The code changes encompass renaming and refining functions and classes, revising method signatures, and introducing new utilities for cache management and graph pruning. These updates augment functionality and usability and improve cohesion between modules.

Changes

Files/Groups Summary
.gitignore Added *.pkl to ignore list.
examples/walkthrough.ipynb Introduced a pipeline for model loading, graph operations, and ablation experiments.
sae_eap/attribute.py Renamed several classes and functions for clarity.
sae_eap/cache.py Created a CacheHook namedtuple, added new cache-management functions, and renamed existing ones.
sae_eap/prune.py Updated imports and generalized types in method signatures.
sae_eap/graph/viz.py Added new imports and modified edge visualization logic.
sae_eap/runner.py Replaced manual cache hook creation with a utility function.
tests/unit/attribute/test_attribute.py Introduced test function for model cache comparison.
tests/unit/test_prune.py Added test cases for edge sorting and pruning in a graph.
tests/integration/attribute/test_attribute.py Removed one test and added another to validate forward hooks.
tests/unit/attribute/test_cache_hooks_and_dicts.py Added tests for cache hooks and dictionaries in model transformations.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Notebook as examples/walkthrough.ipynb
    participant ModelLoader as sae_eap/model/load_pretrained
    participant Graph as sae_eap/graph/build
    participant Attribution as sae_eap/runner
    participant Pruner as sae_eap/prune
    participant Viz as sae_eap/graph/viz

    User ->> Notebook: Open notebook
    Notebook ->> ModelLoader: Call load_model
    ModelLoader -->> Notebook: Return model
    Notebook ->> ModelLoader: Call make_ioi_single
    Notebook ->> Graph: Call build_graph
    Graph -->> Notebook: Return graph
    Notebook ->> Attribution: Call run_attribution
    Notebook ->> Pruner: Call PruningPipeline
    Pruner -->> Notebook: Return pruned graph
    Notebook ->> Viz: Call to_graphviz
    Viz -->> Notebook: Return visualized graph
    Notebook ->> Attribution: Call run_ablation
    Notebook ->> Viz: Call plot_faithfulness_curves

Poem

In the world of code, vast and grand,
A notebook's journey, a careful hand,
Model and graphs in harmony dance,
Cache hooks and pruners at first glance.
Tests now guard our precious scripts,
Ensuring no bugs sneak through the crypts.
Hail to progress, in bytes we trust,
Onward, advancements, robust and just.


[!TIP]

Early access features: enabled We are currently testing the following features in early access: - **OpenAI `gpt-4o` model for code reviews and chat**: OpenAI claims that this model is better at understanding and generating code than the previous models. We seek your feedback over the next few weeks before making it generally available. Note: - You can enable or disable early access features from the CodeRabbit UI or by updating the CodeRabbit configuration file. - Please join our [Discord Community](https://discord.com/invite/GsXnASn26c) to provide feedback and report issues. - OSS projects are currently opted into early access features by default.

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.