Welcome to Olympus’ documentation!

Olympus is a toolkit that provides a consistent and easy-to-use framework to access a number of optimization algorithms (Planners) as well as benchmark surfaces. In addition to analytic benchmark functions (Surfaces), a collection of experimental emulators (Emulators) are provided. These are based on models (Models) trained on experimental datasets (Datasets) from across the natural sciences, including examples from physics, chemistry, and materials science.

Getting Started

• Overview
• Installation
• Credits
• Support

Examples

• Experiment emulators
• Run a simple benchmark
• Run a larger benchmark
• Planners Interfaces
• Noisy Inputs
• Custom Dataset
• Custom Planner

Core Classes

• Planners
• Datasets
• Models
• Emulators
• Surfaces
• Noises

Advanced Usage

• Custom Emulators
• Custom Planners

Complete API Reference

• olympus package
  • Subpackages
  • olympus.olympus

Indices and tables

• Index

• Module Index

• Search Page