TMS-Kit
=====================

Toolkit for running toy models of superposition experiments in PyTorch. 

.. image:: https://img.shields.io/pypi/v/tms-kit.svg?color=blue
   :target: https://pypi.org/project/tms-kit
   :alt: PyPI

.. image:: https://img.shields.io/github/actions/workflow/status/dtch1997/tms-kit/tests.yaml?branch=main
   :target: https://github.com/dtch1997/tms-kit
   :alt: Build Status


Installation
------------
Releases are hosted on `PyPI`_, and can be installed using `pip` as below:

.. code-block:: bash

   pip install tms-kit

Paper Reproductions
--------------------
This library provides utilities for reproducing experiments on toy models of superposition as described in the following papers:

   * `Toy Models of Superposition <https://transformer-circuits.pub/2022/toy_model/index.html>`_
   * `Toy Models of Feature Absorption <https://www.lesswrong.com/posts/kcg58WhRxFA9hv9vN/toy-models-of-feature-absorption-in-saes>`_


See the `reproductions <reproductions>`_ section for more details.

Contents
--------
.. toctree::
   :maxdepth: 2

   basic_usage
   reproductions

.. toctree::
   :caption: Project Links

   GitHub <https://github.com/dtch1997/tms-kit>
   PyPI <https://pypi.org/project/tms-kit>

.. _PyPI: https://pypi.org/project/tms-kit/