Skip to main content

A library to use Large Language Models (LLMs) as numerical optimizers

Project description

LLMize

LLMize is a Python package that uses Large Language Models (LLMs) for multipurpose, numerical optimization tasks. It provides a flexible and efficient framework for solving various optimization problems using LLM-based approaches, with support for both maximization and minimization objectives.

Features

  • LLM-Based Optimization: Utilizes LLM for iteratively generating and optimizing solutions, inspired by OPRO methods paper here
  • Flexible Problem Definition: Supports both text-based problem descriptions and objective functions
  • Parallel Processing: Built-in support for parallel evaluation of solutions
  • Callback System: Extensible callback mechanism for monitoring and controlling the optimization process
  • Early Stopping: Built-in early stopping mechanism to prevent overfitting
  • Adaptive Temperature: Dynamic LLM temperature adjustment based on optimization progress
  • Comprehensive Results: Detailed optimization results including best scores, solution history, and convergence metrics

Installation

To install LLMize, you can use pip:

pip install llmize

For development installation:

git clone https://github.com/yourusername/llmize.git
cd llmize
pip install -e .

Quick Start

Here's a simple example of how to use LLMize with OPRO approach:

from llmize import OPRO
import os

def obj_func(x):
    if isinstance(x, list):
        return (float(x[0]) + 2)**2  # Minimum at x=-2
    else:
        return (float(x) + 2)**2  # Minimum at x=-2

opro = OPRO(
    problem_text="Minimize (x+2)^2",
    obj_func=obj_func,
    api_key=os.getenv("GEMINI_API_KEY")
)

init_samples = ["0", "1", "-1"]
init_scores = [4, 9, 1]  # (0+2)^2, (1+2)^2, (-1+2)^2

result = opro.minimize(
    init_samples=init_samples,
    init_scores=init_scores,
    num_steps=2,
    batch_size=2
)

# Access results using the new OptimizationResult class
print(f"Best solution: {result.best_solution}")
print(f"Best score: {result.best_score}")
print(f"Convergence history: {result.best_score_history}")
print(f"Per-step scores: {result.best_score_per_step}")

Examples

The package includes several example implementations:

  • Neural Network Hyperparameter Tuning: Optimize neural network architectures and hyperparameters
  • Traveling Salesman Problem: Solve TSP using LLM-based optimization
  • Linear Programming: Solve linear programming problems
  • Convex Optimization: Handle convex optimization tasks
  • Nuclear Fuel Optimization: Complex optimization in nuclear engineering paper here

Check the examples/ directory for detailed implementations.

Advanced Usage

Callbacks

LLMize supports custom callbacks for monitoring and controlling the optimization process:

from llmize.callbacks import EarlyStopping, AdaptTempOnPlateau

callbacks = [
    EarlyStopping(patience=5),
    AdaptTempOnPlateau(factor=0.5)
]

results = optimizer.maximize(
    callbacks=callbacks,
    # ... other parameters
)

Parallel Processing

Enable parallel evaluation of solutions:

results = optimizer.maximize(
    parallel_n_jobs=4,  # Number of parallel processes
    # ... other parameters
)

Result Analysis

The new OptimizationResult class provides comprehensive optimization results:

# Access optimization results
print(f"Best solution: {results.best_solution}")
print(f"Best score: {results.best_score}")
print(f"Score history: {results.best_score_history}")
print(f"Per-step scores: {results.best_score_per_step}")
print(f"Average scores: {results.avg_score_per_step}")
print(f"Number of steps: {results.num_steps}")
print(f"Total time: {results.total_time} seconds")

Configuration

The optimizer can be configured with various parameters:

opro = OPRO(
    problem_text="Your problem description",
    obj_func=your_objective_function,
    api_key=your_api_key,
    temperature=0.7,
    max_tokens=100,
    # ... other parameters
)

Dependencies

  • Python >= 3.8
  • numpy >= 1.21.0
  • google-generativeai >= 0.3.0
  • colorama >= 0.4.6
  • matplotlib >= 3.5.0

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

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

Citation

If you use LLMize in your research, please cite:

@software{llmize2025,
  author = {Your Name},
  title = {LLMize: LLM-based Optimization Library},
  year = {2025},
  publisher = {GitHub},
  url = {https://github.com/rizkiokt/llmize}
}

Contact

For questions, suggestions, or support, please contact:

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

llmize-0.1.3.tar.gz (25.9 kB view details)

Uploaded Source

Built Distribution

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

llmize-0.1.3-py3-none-any.whl (31.6 kB view details)

Uploaded Python 3

File details

Details for the file llmize-0.1.3.tar.gz.

File metadata

  • Download URL: llmize-0.1.3.tar.gz
  • Upload date:
  • Size: 25.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for llmize-0.1.3.tar.gz
Algorithm Hash digest
SHA256 e28139e1b2249efa91a2aaba21d9fb7aaad28ed8b61bef97a5006e30e7957a91
MD5 5af7e58fa3c91f26d0f6e9eae4d69928
BLAKE2b-256 931f4323247b974d9a39d67d2d2cfa0d1aa24229a806e15549adc3a2db1bcd41

See more details on using hashes here.

File details

Details for the file llmize-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: llmize-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 31.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for llmize-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 3e6a84adfaa630b100a464cfd8333aa415e6a363ebe4dfa5c504f50ecc3cc920
MD5 8248834d62fef5bc6946b797912a20ee
BLAKE2b-256 3fc8998b08828a2776befbc79cf5200e4752b98f43b2c777de0b34d52ea156e5

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