Metadata-Version: 2.4
Name: smt-optim
Version: 0.1.2
Summary: A Python toolbox for constrained and multi-fidelity Bayesian optimization
Author-email: Oihan Cordelier <oihan.cordelier@polymtl.ca>
License-Expression: Apache-2.0
Project-URL: Homepage, https://github.com/SMTorg/smt-optim
Project-URL: Issues, https://github.com/SMTorg/smt-optim/issues
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=2.4.0
Requires-Dist: scipy>=1.17.0
Requires-Dist: smt[gpx]==2.13.0
Provides-Extra: dev
Requires-Dist: smt>=2.13.0; extra == "dev"
Dynamic: license-file

[![Tests](https://github.com/SMTorg/smt-optim/actions/workflows/ci.yml/badge.svg)](https://github.com/SMTorg/smt-optim/actions/workflows/ci.yml)

# SMT-Optim: A Python toolbox for constrained and multi-fidelity Bayesian optimization

## Introduction

SMT-Optim is an open-source Python package for Bayesian optimization developed for research applications. 
It is well suited to expensive-to-evaluate black-box problems that offer limited exploitable structure, 
such as derivative information. The package supports constrained and multi-fidelity global optimization 
for mixed-variable design spaces.
## Cite us

To cite SMT-Optim:

```bibtex
@techreport{cordelier_etal_2026,
    author      = {Cordelier, Oihan and Diouane, Youssef and Bartoli, Nathalie and Laurendeau, Eric},
    title       = {Multi-fidelity approaches for general constrained Bayesian optimization with application to aircraft design},
    institution = {{GERAD}},
    year        = 2026,
    type        = {Cahier du GERAD},
    number      = {G-2026-17},
    address     = {Montr\'eal, QC, Canada},
    doi         = {10.48550/arXiv.2603.28987}
}
```
```bibtex
@inproceedings{cordelier_etal_2025,
    author      = {Cordelier, Oihan and Diouane, Youssef and Bartoli, Nathalie and Laurendeau, Eric},
    title       = {{Multi-Fidelity Constrained Bayesian Optimization with Application to Aircraft Wing Design}},
    booktitle   = {{AIAA AVIATION FORUM AND ASCEND 2025}},
    year        = {2025},
    address     = {Las Vegas, Nevada},
    month       = jul,
    publisher   = {American Institute of Aeronautics and Astronautics},
    doi         = {10.2514/6.2025-3474}
    }
```


### Focus on constrained Bayesian optimization

SMT-Optim supports both equality and inequality blackbox constraints. For each constraint, it builds a surrogate model and uses it during acquisition function optimization. The acquisition function can be optimized either with respect to the surrogate mean prediction or by penalizing it with the probability of feasibility. The SMT-Optim interface also allows users to define both lower and upper bounds for each black-box constraint.

### Focus on multi-fidelity

SMT-Optim is designed for multi-fidelity optimization with hierarchical fidelity levels to reduce computational cost. The MFSEGO acquisition strategy judiciously selects low- and high-fidelity evaluations when sampling the blackbox functions. Currently, SMT-Optim offers two state-of-the-art multi-fidelity frameworks: MFSEGO for nested design spaces and VF-PI for non-nested design spaces. Both frameworks can be further customized with specific acquisition functions and framework-specific parameters.

### Focus on mixed-variable

SMT-Optim supports continuous, integer, and categorical variables. It relies on SMT's Design Space to define mixed-variable design spaces and on SMT's surrogate models to accurately represent the quantities of interest with respect to their input variables.

### Focus on a modular framework

SMT-Optim is designed to be modular, allowing users to swap components such as surrogate models, acquisition strategies, and acquisition functions while maintaining a consistent overall structure that is well suited to research benchmarking. The package also offers a straightforward interface through the `minimize` method, enabling seamless implementation and automatically selecting an appropriate optimization framework based on the characteristics of the problem.

# Getting started

## Prerequisites

SMT-Optim requires the following package to be installed in the Python environment:

- Numpy
- SciPy
- SMT (with the GPX surrogate model)

It can be done via PIP:

`pip install numpy scipy smt[gpx]`

## Installation

1. Clone the `smt-optim` repo.

``git clone https://github.com/SMTorg/smt-optim.git``

2. Install SMT-Optim to your Python environment.

``cd smt-optim``

``pip install -e .``


## Usage

Comprehensive examples are available in the documentation:

- [Unconstrained optimization](https://smtorg.github.io/smt-optim/getting_started/unconstrained_optim.html)
- [Constrained optimization](https://smtorg.github.io/smt-optim/getting_started/constrained_optim.html)
- [Multi-fidelity optimization](https://smtorg.github.io/smt-optim/getting_started/multifidelity_optim.html)
- [Mixed variable optimization](https://smtorg.github.io/smt-optim/getting_started/mixed_var_optim.html)

```python
import numpy as np
from smt_optim import minimize

def xsinx(x):
    return (x - 3.5) * np.sin((x - 3.5) / (np.pi))

bounds = np.array([
    [0, 25]
])

state = minimize([xsinx], bounds, max_iter=12, driver_kwargs={"seed": 0})

best_sample = state.get_best_sample()

print(best_sample)
```

# Documentation

The documentation is available online:

[SMT-Optim documentation](https://smtorg.github.io/smt-optim/)

# License

Copyright 2026 SMT-Optim contributors

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

  http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
