VectorScope Documentation

VectorScope is an interactive web-based system for exploring, transforming, and visualizing vector embeddings.

Getting Started

• Installation
  • Option 1: Install from PyPI (Recommended)
  • Option 2: Development Installation
  • Troubleshooting
• Quickstart
  • Starting VectorScope
  • Your First Visualization
  • Saving Your Work
  • Next Steps
• Core Concepts
  • Layers
  • Points
  • Transformations
  • Projections
  • The Data Pipeline
  • State Management

User Guide

• Loading Data
  • Supported File Formats
  • Loading Methods
  • Column Configuration
  • Data Limits
• Graph Editor
  • Overview
  • Node Types
  • Interacting with Nodes
  • Config Panel
  • Building a Pipeline
  • Tips
• Projections
  • Available Projection Types
  • Creating Projections
  • PCA (Principal Component Analysis)
  • t-SNE (t-distributed Stochastic Neighbor Embedding)
  • UMAP (Uniform Manifold Approximation and Projection)
  • Custom Axes
  • Direct Axes
  • Density View
  • Box Plot View
  • Violin View
  • 3D Projections
  • Comparing Projections
  • Understanding the Visualization
  • Best Practices
• Transformations
  • Creating Transformations
  • Scaling
  • Rotation
  • PCA Transformation
  • Custom Affine Transformation
  • Configuring Transformations
  • Chaining Transformations
  • Transformation Properties
  • Tips
• Annotations
  • Accessing the Annotations Panel
  • Selection Tools
  • Named Selections
  • Virtual Points (Barycenters)
  • Auto-Generate from Classes
  • Best Practices
  • Workflow Example
• Sessions
  • What Gets Saved
  • What Doesn’t Get Saved
  • Saving a Session
  • Opening a Session
  • New Session
  • Session Files
  • Importing External Data
  • Scenarios (Built-in)
  • Best Practices

Examples

• Example: Custom Axes Walkthrough
  • Overview
  • Loading the Example
  • Understanding the Graph Structure
  • Creating Custom Axes
  • The Custom Axes View
  • Comparing Views Side-by-Side
  • Projection Modes
  • Key Concepts Demonstrated
  • Next Steps
  • See Also

Developer Guide

• Architecture Overview
  • System Architecture
  • Backend Architecture
  • Frontend Architecture
  • Data Flow
  • Vite Proxy Configuration
  • Singleton Pattern
  • Error Handling
• Extending Transformations
  • Example: Adding a “Normalize” Transformation
  • Advanced: Adding Invertibility
  • Complete Example
  • Testing
  • Checklist
• Extending Projections
  • Example: Adding a “UMAP” Projection
  • Testing the Projection
  • Performance Considerations
  • Adding 3D Support
  • Checklist
• Testing and Screenshots with Playwright
  • Installation
  • Screenshot Capture Script
  • End-to-End Testing
  • Best Practices
  • Troubleshooting
• Building and Releasing
  • Building for PyPI
  • Uploading to PyPI
  • Release Checklist
  • Package Contents
• API Reference
  • REST API Endpoints
  • Python API
  • TypeScript API

API Documentation

• Backend API (Python)
  • Models
  • Services
• Frontend API (TypeScript)
  • Types
  • API Client
  • State Management
  • Components

Credits

Conceptualized by: Kyle Cranmer

Implemented by: Claude Code (Anthropic’s AI coding assistant)

Indices and tables

• Index

• Module Index

• Search Page