Metadata-Version: 2.1
Name: steering-vectors
Version: 0.12.1
Summary: Steering vectors for transformer language models in Pytorch / Huggingface
Home-page: https://steering-vectors.github.io/steering-vectors
Author-Email: David Chanin <chanindav@gmail.com>, Daniel Tan <dtch009@gmail.com>
License: MIT
Project-URL: Homepage, https://steering-vectors.github.io/steering-vectors
Project-URL: Repository, https://github.com/steering-vectors/steering-vectors
Requires-Python: <4.0,>=3.10
Requires-Dist: transformers<5.0.0,>=4.35.2
Requires-Dist: tqdm<5.0.0,>=4.1.0
Requires-Dist: scikit-learn<2.0.0,>=1.4.0
Description-Content-Type: text/markdown

# Steering Vectors

[![ci](https://img.shields.io/github/actions/workflow/status/steering-vectors/steering-vectors/ci.yaml?branch=main)](https://github.com/steering-vectors/steering-vectors)
[![Codecov](https://img.shields.io/codecov/c/github/steering-vectors/steering-vectors/main)](https://codecov.io/gh/steering-vectors/steering-vectors)
[![PyPI](https://img.shields.io/pypi/v/steering-vectors?color=blue)](https://pypi.org/project/steering-vectors/)

Steering vectors / representation engineering for transformer language models in Pytorch / Huggingface

Check out our [example notebook](examples/caa_sycophancy.ipynb). <a target="_blank" href="https://colab.research.google.com/github/steering-vectors/steering-vectors/blob/main/examples/caa_sycophancy.ipynb">
<img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/>
</a>

Full docs: https://steering-vectors.github.io/steering-vectors

## About

This library provides utilies for training and applying steering vectors to language models (LMs) from [Huggingface](https://huggingface.co/), like GPT, LLaMa, Gemma, Mistral, Pythia, and many more!

For more info on steering vectors and representation engineering, check out the following work:

- [Steering Llama 2 via Contrastive Activation Addition](https://arxiv.org/abs/2312.06681) Rimsky et al., 2023
- [Representation Engineering: A Top-Down Approach to AI Transparency](https://arxiv.org/abs/2310.01405) Zou et al., 2023

## Installation

```
pip install steering-vectors
```

Check out the [full documentation](https://steering-vectors.github.io/steering-vectors/) for more usage info.

## Contributing

Any contributions to improve this project are welcome! Please open an issue or pull request in this repo with any bugfixes / changes / improvements you have.

This project uses [Ruff](https://docs.astral.sh/ruff/) for code formatting and linting, [MyPy](https://mypy.readthedocs.io/en/stable/) for type checking, and [Pytest](https://docs.pytest.org/) for tests. Make sure any changes you submit pass these code checks in your PR. If you have trouble getting these to run feel free to open a pull-request regardless and we can discuss further in the PR.

## License

This code is released under a MIT license.
