generated from alan-cooney/transformer-lens-starter-template
-
Notifications
You must be signed in to change notification settings - Fork 39
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
9060dc1
commit 2fea6a3
Showing
1 changed file
with
28 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,31 @@ | ||
# Sparse Autoencoder | ||
|
||
[![Checks](https://github.com/alan-cooney/sparse_autoencoder/actions/workflows/checks.yml/badge.svg)](https://github.com/alan-cooney/sparse_autoencoder/actions/workflows/checks.yml) | ||
[![Release](https://github.com/alan-cooney/sparse_autoencoder/actions/workflows/release.yml/badge.svg)](https://github.com/alan-cooney/sparse_autoencoder/actions/workflows/release.yml) | ||
|
||
**Note**: This package is in alpha and likely to have breaking changes regularly. | ||
|
||
A sparse autoencoder for mechanistic interpretability research. | ||
|
||
```shell | ||
pip install sparse_autoencoder | ||
``` | ||
|
||
## Demo | ||
|
||
Check out the demo notebook for a guide to using this library. | ||
|
||
## Contributing | ||
|
||
This project uses [Poetry](https://python-poetry.org) for dependency management. After checking out | ||
the repo, install all dependencies with: | ||
|
||
```shell | ||
poetry install --with dev,demos | ||
``` | ||
|
||
Then to run all checks locally: | ||
|
||
```shell | ||
poetry run checks | ||
``` |