Skip to content

Installation

The toolkit uses uv as the package manager (Python 3.11+). For Mac/Linux, uv is installed via:

curl -Ls https://astral.sh/uv/install.sh | sh

brew install astral-sh/uv/uv

For Windows, uv can be installed (using PowerShell 7+) via:

```powershell powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex" 

See the uv page for details and other installation options.


## Installing the toolkit

Once `uv` is installed, install the `aisteer360` package via:

```commandline
uv venv --python 3.11 && uv pip install .

The above creates a .venv (if missing), installs aisteer360 (in non-editable mode), and installs all dependencies listed under [project.dependencies] in the pyproject.toml file. Activate the environment by running source .venv/bin/activate. Note that on Windows, you may need to split the installation script into two separate commands (instead of chained via &&). To install an optional dependency group from [project.optional-dependencies], e.g., docs, append it in quotes and square brackets to the install command as follows:

uv venv --python 3.11 && uv pip install '.[docs]'

Accessing Hugging Face models

Inference is facilitated by Hugging Face. Before steering, create a .env file in the root directory for your Hugging Face API key in the following format: 

HUGGINGFACE_TOKEN=hf_***

Some Hugging Face models (e.g. meta-llama/Meta-Llama-3.1-8B-Instruct) are behind an access gate. To gain access:

  1. Request access on the model’s Hub page with the same account whose token you use in your .env file.
  2. Wait for approval (you’ll receive an email).
  3. (Re-)authenticate locally by running huggingface-cli login.

Once you have completed the above steps, please see our quickstart guide to get up and running!