Getting Started Installation

Installation

Overview

Installation covers setting up both the Python backend and the Node.js frontend. TokenPrint runs entirely locally to guarantee privacy and fast rendering of massive tensor arrays.

Why it matters

TokenPrint relies on real mathematical operations, requiring specific package versions (like PyTorch) to accurately extract intermediate activations and attentions. A mismatched environment might result in silent fallbacks or missing tensor data that compromises the scientific accuracy of the visualization.

How TokenPrint implements it

The project uses standard, modern package management:

• Backend: Python virtual environments (venv) and requirements.txt.
• Frontend: Node.js with npm.

Step-by-Step Installation

Prerequisites

• Python 3.10+
• Node.js 18+
• Git

1. Clone the repository

git clone https://github.com/Sudharsanselvaraj/Token-Print.git
cd Token-Print

2. Install the Backend

The backend utilizes PyTorch and FastAPI.

cd backend
# Create a virtual environment
python3 -m venv .venv --system-site-packages
# Activate it
source .venv/bin/activate  # On Windows use: .venv\Scripts\activate
# Install dependencies
pip install -r requirements.txt

Note By default, the requirements.txt fetches PyTorch. If you have a specific GPU (CUDA/MPS), ensure your PyTorch build matches your hardware to enable hardware acceleration. The backend works on CPU, but loading models will be slower.

3. Install the Frontend

The frontend uses Next.js, Three.js, and React Three Fiber.

cd ../frontend
# Install dependencies
npm install

Diagram

flowchart TD
    Git[Git Clone Repo] --> Python[Backend: Python venv]
    Git --> Node[Frontend: npm install]
    Python --> PyTorch[Install PyTorch & FastAPI]
    Node --> Next[Install Next.js & Three.js]
    PyTorch --> Ready([Ready to Run])
    Next --> Ready

Loading

Related pages

• Getting Started
• Quick Start

Further reading

• Project README
• Development Environment Setup

Navigation

Previous	Home	Next
Getting Started	Home	Quick Start