Skip to main content

A fast, offline token calculator for AI vision models

Project description

Token Vision Banner

Warning: This is an experimental alpha release. APIs and functionality may change significantly between versions.

Token Vision

A fast, offline token calculator for images with various AI models (Claude, OpenAI, Google). Calculate image tokens and costs without making API calls or hitting rate limits.

Author

Ashraf Ali (ashrafali.net)

Advantages

  • Offline Operation: Calculate tokens without internet connectivity or API keys
  • No Rate Limits: Process unlimited images without worrying about API quotas
  • Ultra Fast: Get instant results without network latency
  • Cost Efficient: Plan and estimate costs without spending API credits
  • Multi-Model Support: One library for all major vision models
  • Accurate: Uses the same tiling and scaling algorithms as the official implementations
  • Developer Friendly: Clean API with type hints and comprehensive documentation
  • Extensible: Support for custom models and pricing configurations

Installation

pip install token-vision

Quick Start

from token_vision import ImageTokenCalculator

# Initialize calculator
calculator = ImageTokenCalculator()  # Defaults to gemini-1-5-flash

# Calculate tokens for an image
tokens = calculator.calculate(
    image_path="path/to/image.jpg",
    model="gemini-1-5-flash"  # Optional, defaults to gemini-1-5-flash
)

# Get cost
cost = calculator.get_cost(tokens)
print(f"Tokens: {tokens:,}")
print(f"Cost: ${cost:.6f}")

Features

  • Support for multiple AI models:
    • Claude (3.5 Sonnet, 3.5 Haiku, 3 Opus, 3 Sonnet, 3 Haiku)
    • GPT-4o (Latest, Nov 2024, Aug 2024, May 2024)
    • Gemini (1.5 Pro, 1.5 Flash)
  • Accurate token calculation based on image dimensions
  • Cost estimation for both input and output tokens
  • Support for various image input formats
  • Batch processing capabilities
  • Memory efficient processing
  • Custom model configuration support
  • Smart image size handling:
    • No automatic resizing - calculates tokens for original dimensions
    • Provides warnings when images exceed model-specific optimal sizes
    • Suggests optimizations to reduce bandwidth costs

Documentation

Image Size Handling

The library calculates tokens based on your original image dimensions while providing helpful warnings:

from token_vision import ImageTokenCalculator

calculator = ImageTokenCalculator()

# Calculate tokens for a large image
result = calculator.calculate("large_image.jpg")
print(f"Tokens: {result.tokens:,}")

# Check for any size-related warnings
if result.warnings:
    print("\nWarnings:")
    for warning in result.warnings:
        print(f"- {warning}")

Example output for a 4096x4096 image:

Tokens: 12,545
Warnings:
- Image dimensions (4096x4096) exceed recommended size. The model will automatically scale this down. Consider resizing to max 2048px on the longest side to reduce bandwidth costs.

The library will:

  1. Calculate tokens for your original image size
  2. Warn you if the image exceeds model-specific optimal dimensions
  3. Explain how the model will handle the image
  4. Suggest optimizations to reduce bandwidth costs

This approach gives you full control while providing the information needed to optimize your usage.

Supported Models

The library supports the following models with their respective token calculation methods:

Claude Models

  • claude-3-5-sonnet-20241022
  • claude-3-5-haiku-20241022
  • claude-3-opus-20240229
  • claude-3-sonnet-20240229
  • claude-3-haiku-20240307

OpenAI Models

  • gpt-4o
  • gpt-4o-2024-11-20
  • gpt-4o-2024-08-06
  • gpt-4o-2024-05-13

Google Models

  • gemini-1-5-pro
  • gemini-1-5-flash (default)

Custom Models

You can add your own models or override existing ones using a JSON configuration file:

from token_vision import ImageTokenCalculator
from token_vision.models import load_custom_models

# Load custom models
load_custom_models("path/to/custom_models.json")

# Use custom model
calculator = ImageTokenCalculator()
tokens = calculator.calculate("image.jpg", model="custom-model-v1")

Example custom_models.json:

{
    "custom-provider": {
        "name": "Custom Provider",
        "max_images": 10,
        "token_multiplier": 1.0,
        "models": {
            "custom-model-v1": {
                "name": "Custom Model V1",
                "input_rate": 15000,
                "output_rate": 75000,
                "batch_input_rate": 7500,
                "batch_output_rate": 37500,
                "cached_input_rate": 1500,
                "cached_output_rate": 7500
            }
        }
    }
}

Advanced Usage

# Custom configuration
calculator = ImageTokenCalculator(
    default_model="gemini-1-5-flash",
    detail_level="high"
)

# Process multiple images
results = calculator.calculate_batch([
    "image1.jpg",
    "image2.jpg"
])

# Get batch costs (uses batch rates)
costs = calculator.get_cost_batch(results)

# Using numpy arrays
import numpy as np
image_array = np.array(...)  # Your image data
result = calculator.calculate(
    image=image_array,
    model="gemini-1-5-flash",
    detail_level="low"
)

Development

Setup

  1. Clone the repository:
git clone https://github.com/nerveband/token-vision.git
cd token-vision
  1. Create a virtual environment:
python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
  1. Install development dependencies:
pip install -e ".[dev]"

Running Tests

pytest

License

This project is licensed under the MIT License - see the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

token_vision-0.1.2a1.tar.gz (12.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

token_vision-0.1.2a1-py3-none-any.whl (7.1 kB view details)

Uploaded Python 3

File details

Details for the file token_vision-0.1.2a1.tar.gz.

File metadata

  • Download URL: token_vision-0.1.2a1.tar.gz
  • Upload date:
  • Size: 12.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.4

File hashes

Hashes for token_vision-0.1.2a1.tar.gz
Algorithm Hash digest
SHA256 e718408cdac9ec0334965d4fd1c5f3434cc59d1572148ac7748bbfcf24b70da4
MD5 dae2631fcfe9498166267671d572b141
BLAKE2b-256 9a42e827360b85e8b7eefcbc1768944c221a96a7e408b9935dec10ed5b678374

See more details on using hashes here.

File details

Details for the file token_vision-0.1.2a1-py3-none-any.whl.

File metadata

  • Download URL: token_vision-0.1.2a1-py3-none-any.whl
  • Upload date:
  • Size: 7.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.0.1 CPython/3.12.4

File hashes

Hashes for token_vision-0.1.2a1-py3-none-any.whl
Algorithm Hash digest
SHA256 09fc7c787612b7fe290bb91b002699fca5df4a6bb9eca1ab113c4d3ba49e8325
MD5 e6690491e0cdee1d42a91b4eb5ef3545
BLAKE2b-256 fd1bbdd71014abb51c94ebd3f0492f33b43caf186031d63f6a282222a36f12fe

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page