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
testcommand. - Full Model Management: Programmatically
listavailable models andscanfor 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
richandfire. - 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
- Initial Verification: Tests at a small context size (1024) to verify the model loads correctly.
- Threshold Test: Tests at the
min(threshold, declared_limit)to safely assess the initial context window. - Binary Search: If the threshold test fails, it performs an efficient binary search to find the exact context limit.
- Progress Persistence: Saves results after each test for resumable operations.
Multi-Model Optimization
- Batch Processing: The
--allflag 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
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file lmstrix-1.0.51.tar.gz.
File metadata
- Download URL: lmstrix-1.0.51.tar.gz
- Upload date:
- Size: 61.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: python-httpx/0.28.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
06e393a3702245760191382624a8dab652ccce175dbfe09714fcfd5fa757f422
|
|
| MD5 |
2d5540f83a6c721856d5d542f4d55bd1
|
|
| BLAKE2b-256 |
fc24fc6ac84f076494e598d2ee96650b1202084c464a59ec489d3c01e7060f8f
|
File details
Details for the file lmstrix-1.0.51-py3-none-any.whl.
File metadata
- Download URL: lmstrix-1.0.51-py3-none-any.whl
- Upload date:
- Size: 50.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: python-httpx/0.28.1
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
eaa785c349170f21f5b1a8466fb13c17b292cd1f72d07efc2e98f043e8ff7bf9
|
|
| MD5 |
405da446a61fa6b3061ccb3eb15d225b
|
|
| BLAKE2b-256 |
8cf169a6c85916d74382e9eda7b766c582f829f0186025a8560d6e0ae87d45c9
|