Skip to content

Installation Guide

Requirements

  • Python 3.8 or higher
  • pip package manager

Basic Installation

Install Surfing Weights using pip:

pip install streaming-weights

This installs the core package with basic functionality.

Installation with Extra Features

Server Components

For running a weight streaming server:

pip install streaming-weights[server]

This includes additional dependencies for: - FastAPI server - Monitoring capabilities - Server-side caching

Development Installation

For contributing to Surfing Weights or running tests:

pip install streaming-weights[dev]

This includes: - Testing frameworks - Development tools - Documentation dependencies

Full Installation

To install all optional dependencies:

pip install streaming-weights[server,dev]

Cloud Storage Support

Amazon S3

For S3 storage backend support:

pip install streaming-weights[s3]

Verifying Installation

Test your installation by running:

import streaming_weights
print(streaming_weights.__version__)

Next Steps