Skip to main content

SBArchOpt: Surrogate-Based Architecture Optimization

Project description

SBArchOpt Logo

SBArchOpt: Surrogate-Based Architecture Optimization

Tests PyPI License JOSS Documentation Status

GitHub Repository | Documentation

SBArchOpt (es-bee-ARK-opt) provides a set of classes and interfaces for applying Surrogate-Based Optimization (SBO) for system architecture optimization problems:

  • Expensive black-box problems: evaluating one candidate architecture might be computationally expensive
  • Mixed-discrete design variables: categorical architectural decisions mixed with continuous sizing variables
  • Hierarchical design variables: decisions can deactivate/activate (parts of) downstream decisions
  • Multi-objective: stemming from conflicting stakeholder needs
  • Subject to hidden constraints: simulation tools might not converge for all design points

Surrogate-Based Optimization (SBO) aims to accelerate convergence by fitting a surrogate model (e.g. regression, gaussian process, neural net) to the inputs (design variables) and outputs (objectives/constraints) to try to predict where interesting infill points lie. Potentially, SBO needs about one or two orders of magnitude less function evaluations than Multi-Objective Evolutionary Algorithms (MOEA's) like NSGA2. However, dealing with the specific challenges of architecture optimization, especially in a combination of the challenges, is not trivial. This library hopes to support in doing this.

The library provides:

  • A common interface for defining architecture optimization problems based on pymoo
  • Support in using Surrogate-Based Optimization (SBO) algorithms:
    • Implementation of a basic SBO algorithm
    • Connectors to various external SBO libraries
  • Analytical and realistic test problems that exhibit one or more of the architecture optimization challenges

Installation

First, create a conda environment (skip if you already have one):

conda create --name opt python=3.9
conda activate opt

Then install the package:

conda install numpy
pip install sb-arch-opt

Note: there are optional dependencies for the connected optimization frameworks and test problems. Refer to their documentation for dedicated installation instructions.

Documentation

Refer to the documentation for more background on SBArchOpt and how to implement architecture optimization problems.

Citing

If you use SBArchOpt in your work, please cite it:

Bussemaker, J.H., (2023). SBArchOpt: Surrogate-Based Architecture Optimization. Journal of Open Source Software, 8(89), 5564, DOI: 10.21105/joss.05564

Contributing

The project is coordinated by: Jasper Bussemaker (jasper.bussemaker at dlr.de)

If you find a bug or have a feature request, please file an issue using the Github issue tracker. If you require support for using SBArchOpt or want to collaborate, feel free to contact me.

Contributions are appreciated too:

  • Fork the repository
  • Add your contributions to the fork
    • Update/add documentation
    • Add tests and make sure they pass (tests are run using pytest)
  • Read and sign the Contributor License Agreement (CLA) , and send it to the project coordinator
  • Issue a pull request into the dev branch

Adding Documentation

pip install -r requirements-docs.txt
mkdocs serve

Refer to mkdocs and mkdocstrings documentation for more information.

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

sb_arch_opt-1.5.2.tar.gz (39.4 MB view details)

Uploaded Source

Built Distribution

sb_arch_opt-1.5.2-py3-none-any.whl (39.8 MB view details)

Uploaded Python 3

File details

Details for the file sb_arch_opt-1.5.2.tar.gz.

File metadata

  • Download URL: sb_arch_opt-1.5.2.tar.gz
  • Upload date:
  • Size: 39.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for sb_arch_opt-1.5.2.tar.gz
Algorithm Hash digest
SHA256 06e03f092ff73b515b8e1d89b3fd4545ffab6469ab9ea121d595974e7a67eba2
MD5 64dc5263cdb589a39101b2822e8c63ec
BLAKE2b-256 6259279fe9b4db698417debd36c82a987e3b678de18d982d4ad64d57584bb8a7

See more details on using hashes here.

Provenance

File details

Details for the file sb_arch_opt-1.5.2-py3-none-any.whl.

File metadata

  • Download URL: sb_arch_opt-1.5.2-py3-none-any.whl
  • Upload date:
  • Size: 39.8 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for sb_arch_opt-1.5.2-py3-none-any.whl
Algorithm Hash digest
SHA256 512edefc240afc6dee0bf45c3a516f38db02d2950ab21e2e4836bdbcb717dd02
MD5 8282bee7db37dd13c5199de4b1b9e019
BLAKE2b-256 ea2a79e26ea2e508668c59cfb4634381490dcc1f457bcc29a44435e57519e2b9

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page