Skip to content

Commit

Permalink
Update readme for transfer (#90)
Browse files Browse the repository at this point in the history
Fix links & citation note
  • Loading branch information
alan-cooney authored Jun 20, 2024
1 parent c264c94 commit fd37348
Showing 1 changed file with 15 additions and 2 deletions.
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
Mechanistic Interpretability visualizations, that work both in both Python (e.g. with
[Jupyter Lab](https://jupyter.org/)) and JavaScript (e.g. [React](https://reactjs.org/) or plain HTML).

View them all at https://alan-cooney.github.io/CircuitsVis
View them all at [https://transformerlensorg.github.io/CircuitsVis](https://transformerlensorg.github.io/CircuitsVis)

## Use

Expand All @@ -28,7 +28,7 @@ yarn add circuitsvis
### Add visualizations

You can use any of the components from the [demo
page](https://alan-cooney.github.io/CircuitsVis). These show the source code for
page](https://transformerlensorg.github.io/CircuitsVis). These show the source code for
use with React, and for Python you can instead import the function with the same
name.

Expand Down Expand Up @@ -119,3 +119,16 @@ released to the latest production version of this library.

When a new GitHub release is created, the codebase will be automatically built
and deployed to [PyPI](https://pypi.org/project/circuitsvis/).

### Citation

Please cite this library as:

```BibTeX
@misc{cooney2023circuitsvis,
title = {CircuitsVis},
author = {Alan Cooney},
year = {2023},
howpublished = {\url{https://github.com/TransformerLensOrg/CircuitsVis}},
}
```

0 comments on commit fd37348

Please sign in to comment.