Skip to content

README.md

Latest commit

 

History

History
111 lines (80 loc) · 3.68 KB

README.md

File metadata and controls

111 lines (80 loc) · 3.68 KB

MiniLLMLib

GitHub stars GitHub forks GitHub issues GitHub last commit

PyPI version Docs License: MIT Python

Installation

pip install minillmlib
# For HuggingFace/local models: (Beta - not well tested)
pip install minillmlib[huggingface]

A Python library for interacting with various LLM providers (OpenAI, Anthropic, Mistral, HuggingFace, through URL).

Author: Quentin Feuillade--Montixi

Installation

From Source

git clone https://github.com/qfeuilla/MiniLLMLib.git
cd MiniLLMLib
pip install -e .  # Install in editable mode

Usage

import minillmlib as mll

# Create a GeneratorInfo for your model/provider
import os

gi = mll.GeneratorInfo(
    model="gpt-4",
    _format="openai",
    api_key=os.getenv("OPENAI_API_KEY")  # Recommended: use env var for secrets
)

# Create a chat node (conversation root)
chat = mll.ChatNode(content="Hello!", role="user")

# Synchronous completion
response = chat.complete_one(gi)
print(response.content)

# Or asynchronous version
# response = await chat.complete_one_async(gi)

Features

  • Unified interface for major LLM providers:
    • OpenAI, Anthropic, Mistral, HuggingFace (local), custom URL (e.g. OpenRouter)
  • Thread (linear) and loom (tree/branching) conversation modes
  • Synchronous & asynchronous API
  • Multimodal support:
    • Audio input (WAV/MP3) compatible with OpenRouter
    • Image input (URLs, local paths, base64)
    • Audio output (OpenAI audio models, beta)
  • Flexible parameter/config management via GeneratorInfo and GeneratorCompletionParameters
  • Save/load conversation trees
  • Extensible: add new models/providers easily

Documentation

  • See the Usage Guide for advanced usage, parameter tables, and branching/loom semantics.
  • See the Provider Matrix for supported models and configuration tips.
  • See Troubleshooting for common issues and debugging.

Configuration

Development & Contribution

  • Run tests with: 
    pytest tests/
  • See Contributing for contribution guidelines.

For more, see the full documentation at minillmlib.readthedocs.io or open an issue on GitHub if you need help.

Release Tagging Reminder

(for maintainers use)

To push a new release tag:

git add <files you changed>
git commit -m "<your message>"
git tag v<NEW_VERSION> -m "Release v<NEW_VERSION>: <short description>"
git push origin main --tags