Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs hackathon: Starting page and quickstart tutorial #389

Open
wants to merge 14 commits into
base: main
Choose a base branch
from
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
53 changes: 52 additions & 1 deletion docs/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,55 @@
# Introduction
# Welcome to BoFire

<!-- Add BoFire Logo -->

Welcome to the official documentation of BoFire, a powerful Python package that serves as a comprehensive framework for experimental design. BoFire is designed to empower researchers, data scientists, engineers, and enthusiasts who are venturing into the exciting world of Design of Experiments (DoE) and Bayesian optimization (BO) techniques.

```mermaid
flowchart TD
A[BoFire main capabilities] --> B{Iterative process?}
B -->|No| C[classical DoE]
B -->|Yes| D[Bayesian Optimization]
```

### What is BoFire?

BoFire is a cutting-edge Python library that provides robust and flexible tools for implementing DoE and BO techniques. These methodologies are crucial in various fields such as machine learning, engineering, and scientific research, where they are used to optimize processes and make efficient, data-driven decisions.


### Why BoFire?

With BoFire, you can streamline your experimental design process and enhance the efficiency of your research. The package offers:

**DoE Framework**: BoFire provides a wide range of experimental design techniques, allowing you to choose the one that best fits your research needs.

**BO framework**: BoFire implements advanced Bayesian optimization algorithms, enabling you to iteratively find your optimum with high sample efficiency.

**Ease of Use**: BoFire’s problem specifications are json serializable allowing use in RESTful APIs.

**Flexibility**: Whether you’re tuning hyperparameters of a machine learning model, optimizing a manufacturing process, or conducting a scientific experiment, BoFire is versatile enough to handle it all.


### What is Design of Experiments (DoE)?

Design of Experiments (DoE) is a systematic method to determine the relationship between different factors affecting a process and the output of that process. It is used to find cause-and-effect relationships. This information is needed to manage process inputs in order to optimize the output.


### What is Bayesian Optimization (BO)?

```mermaid
graph TD
A[Define search space] --> B[Do initial experiments]
B --> C[Stopping criterion\nmet?]
C -- No --> D[Train\nsurrogate model]
D --> E["Optimize\n(generate proposal)"]
E --> F[Perform next experiment]
F --> C
C --- Yes ---> G["Keep results\n(eg, best observation so far)"]
```

Bayesian Optimization (BO) is a sequential design strategy for global optimization of black-box functions that doesn’t assume any functional forms. It works by constructing a posterior distribution of functions (e.g., Gaussian process) that best describes the function you want to optimize. As the number of observations grows, the posterior distribution improves, and the algorithm becomes more certain of which regions in parameter space are worth exploring and which ones are not.



BoFire is a framework to define and solve black-box optimization problems.
These problems can arise in a number of closely related fields including experimental design, multi-objective optimization and active learning.
Expand Down
1 change: 1 addition & 0 deletions mkdocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ repo_url: https://github.com/experimental-design/bofire

nav:
- index.md
- Quick Start: quick_start.ipynb
- Install: install.md
- Notebook page: getting_started.ipynb
- Examples: examples.md
Expand Down
Loading