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"

# 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
    await lms.scan_models()
    
    # List all models
    models = await 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 = await 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.

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.34.tar.gz (45.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.34-py3-none-any.whl (32.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for lmstrix-1.0.34.tar.gz
Algorithm Hash digest
SHA256 d73e159e5c079943b403bb60dc64fe159442099a50eb828d76ecea0633077a22
MD5 929cc9cdbfc444f7a7ff5227feebe8bb
BLAKE2b-256 c0a7da6957e44a679a284aa97f39f9a1788b691aa1f2c4dc1a150b754b8bd85f

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for lmstrix-1.0.34-py3-none-any.whl
Algorithm Hash digest
SHA256 3c569b0b0a6d51637cc92570caf68ce7546f44559d64ae9649fb2cc8639746bc
MD5 6ceba78b6ad6bb59664d1f7ad626fc4d
BLAKE2b-256 4fb50b4ad5900a0558f4e68864caa1f78d18e6c6680ab82df177df332ec5b9df

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