Skip to content

Commit

Permalink
Add quick start to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
alan-cooney committed Nov 3, 2023
1 parent 9060dc1 commit 2fea6a3
Showing 1 changed file with 28 additions and 0 deletions.
28 changes: 28 additions & 0 deletions README.md
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
```

0 comments on commit 2fea6a3

Please sign in to comment.