Skip to main content

A toolkit for managing and testing LM Studio models with automatic context limit discovery

Project description

LMStrix is a professional, installable Python toolkit designed to supercharge your interaction with LM Studio. It provides a powerful command-line interface (CLI) and a clean Python API for managing, testing, and running local language models, with a standout feature: the Adaptive Context Optimizer.

For the full documentation, please visit the LMStrix GitHub Pages site.

Key Features

  • Automatic Context Optimization: Discover the true context limit of any model with the test command.
  • Full Model Management: Programmatically list available models and scan for newly downloaded ones.
  • Flexible Inference Engine: Run inference with a powerful two-phase prompt templating system that separates prompt structure from its content.
  • Rich CLI: A beautiful and intuitive command-line interface built with rich and fire.
  • Modern Python API: An async-first API designed for high-performance, concurrent applications.

Installation

# Using pip
pip install lmstrix

# Using uv (recommended)
uv pip install lmstrix

For more detailed installation instructions, see the Installation page.

Quick Start

Command-Line Interface (CLI)

# First, scan for available models in LM Studio
lmstrix scan

# List all models with their test status
lmstrix list

# Test the context limit for a specific model
lmstrix test "model-id-here"

# Test all untested models with enhanced safety controls
lmstrix test --all --threshold 102400

# Test all models at a specific context size
lmstrix test --all --ctx 32768

# Sort and filter model listings
lmstrix list --sort size_gb  # Sort by model size descending
lmstrix list --show json --sort name  # Export as JSON sorted by model name

# Run inference on a model
lmstrix infer "Your prompt here" --model "model-id" --max-tokens 150

Python API

import asyncio
from lmstrix import LMStrix

async def main():
    # Initialize the client
    lms = LMStrix()
    
    # Scan for available models
    lms.scan_models()
    
    # List all models
    models = lms.list_models()
    print(models)
    
    # Test a specific model's context limits
    model_id = models[0].id if models else None
    if model_id:
        result = lms.test_model(model_id)
        print(result)
    
    # Run inference
    if model_id:
        response = await lms.infer(
            prompt="What is the meaning of life?",
            model_id=model_id,
            max_tokens=100
        )
        print(response.content)

if __name__ == "__main__":
    asyncio.run(main())

For more detailed usage instructions and examples, see the Usage page and the API Reference.

Enhanced Testing Strategy

LMStrix uses a sophisticated testing algorithm to safely and efficiently discover true model context limits:

Safety Features

  • Threshold Protection: Default 102,400 token limit prevents system crashes from oversized contexts.

Testing Algorithm

  1. Initial Verification: Tests at a small context size (1024) to verify the model loads correctly.
  2. Threshold Test: Tests at the min(threshold, declared_limit) to safely assess the initial context window.
  3. Binary Search: If the threshold test fails, it performs an efficient binary search to find the exact context limit.
  4. Progress Persistence: Saves results after each test for resumable operations.

Multi-Model Optimization

  • Batch Processing: The --all flag allows for testing multiple models sequentially.
  • Rich Output: Displays results in a clear table, showing the tested context size and status.

Development

# Clone the repository
git clone https://github.com/twardoch/lmstrix
cd lmstrix

# Install in development mode with all dependencies
pip install -e ".[dev]"

# Run the test suite
pytest

Changelog

All notable changes to this project are documented in the CHANGELOG.md file.

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

lmstrix-1.0.52.tar.gz (63.7 kB view details)

Uploaded Source

Built Distribution

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

lmstrix-1.0.52-py3-none-any.whl (53.1 kB view details)

Uploaded Python 3

File details

Details for the file lmstrix-1.0.52.tar.gz.

File metadata

  • Download URL: lmstrix-1.0.52.tar.gz
  • Upload date:
  • Size: 63.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.28.1

File hashes

Hashes for lmstrix-1.0.52.tar.gz
Algorithm Hash digest
SHA256 a93f17ef1fca62478dcccf3e2d017da0644576192ce13e556cb0551844ec9f8c
MD5 a38c87b94d3f6d8933ef512131f38df8
BLAKE2b-256 0ce32fe36706f4063887c60c83d056a449aca14b76acc97c471812cda58a75b0

See more details on using hashes here.

File details

Details for the file lmstrix-1.0.52-py3-none-any.whl.

File metadata

  • Download URL: lmstrix-1.0.52-py3-none-any.whl
  • Upload date:
  • Size: 53.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.28.1

File hashes

Hashes for lmstrix-1.0.52-py3-none-any.whl
Algorithm Hash digest
SHA256 060ce806d92ccfaab0b8b5d3d88a3157657b066233c47d113cf89c972ae25dc1
MD5 226ce6454a5ac78f67cb5041c419f12f
BLAKE2b-256 177a365ec6bda6019bd4f303e1af3e13d1739a70affb78fc168966df55a7f09d

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