neuronpedia

(β˜… 1,114)

open source interpretability platform 🧠

  • .aider.conf.yml
  • .env.inference.deepseek-r1-distill-llama-8b.llamascope-slimpj-res-32k
  • .env.inference.gemma-2-2b-it.gemmascope-res-16k
  • .env.inference.gpt2-small.res-jb
  • .gitignore
  • AGENTS.md
  • architecture.key
  • architecture.png
  • CLAUDE.md
  • CODE_OF_CONDUCT.md
  • CONTRIBUTING.md
  • LICENSE
  • LICENSE-MIT
  • Makefile
  • NOTICE
  • np_model_to_hf.json
  • README.md
  • SECURITY.md
  • vercel.json

# Installation Guide

1. Get the code
git clone https://github.com/hijohnnylin/neuronpedia

Downloads the entire project code from GitHub to your computer.

cd neuronpedia

Moves into the project folder you just downloaded.

2. Official Install Script

Easy Recommended
Prerequisites
  • Homebrew A package manager for macOS/Linux.
  • APT (Debian/Ubuntu 계열) Built into Debian/Ubuntu-based Linux distributions.
brew install postgresql@16 pgvector && brew services start postgresql@16

Installs the pre-built package via Homebrew β€” no source build required.

sudo apt install postgresql-16 postgresql-16-pgvector && sudo systemctl start postgresql

Installs directly from the APT package repository (Debian/Ubuntu-based).

βœ… After installing, open a new terminal and run the program's version command (e.g. --version) to confirm it worked.

Pulled directly from this repo's README.

3. Node.js

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Node.js Node.js must be installed to use npm. The LTS version is recommended.
⚠️ This is a large repository, so this method may point to an internal sub-package rather than the actual core product. Check the full README as well.
cd apps/webapp

This project's files live in a subfolder, so move into it first.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

βœ… After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

4. Python

Easy
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Python 3 On Windows, be sure to check 'Add Python to PATH' during installation.
poetry lock && poetry install # install dependencies

Installs the libraries listed in pyproject.toml.

poetry remove sae-lens # remove production dependency

Type this command into your terminal and run it.

poetry add PATH/TO/CLONED/SAELENS # set local dependency

Type this command into your terminal and run it.

poetry run neuronpedia-runner \

Type this command into your terminal and run it.

βœ… If it runs without errors and prints output in the terminal, it worked.

Pulled directly from this repo's README.

5. Make

Medium
Prerequisites
  • Git Needed to download the project code from GitHub.
  • Make Usually pre-installed on Linux/macOS. On Windows, install separately (e.g. via MSYS2 or WSL).
make db-check

Compiles the code based on the generated build configuration to produce an executable.

make db-init

Compiles the code based on the generated build configuration to produce an executable.

make install-nodejs

Compiles the code based on the generated build configuration to produce an executable.

make webapp-install

Compiles the code based on the generated build configuration to produce an executable.

make webapp-dev

Compiles the code based on the generated build configuration to produce an executable.

βœ… If it finishes without errors, it worked. Try running the generated executable directly.

Pulled directly from this repo's README.

// repository documentation