Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mykelk authored Sep 22, 2024
1 parent cb0d2a5 commit 6480b07
Showing 1 changed file with 3 additions and 9 deletions.
12 changes: 3 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,10 @@

**DividedRectangles.jl** provides an implementation of the DIRECT (DIvided RECTangles) [algorithm for global optimization](https://scholar.google.com/scholar?hl=en&as_sdt=0%2C5&q=Lipschitzian+optimization+without+the+Lipschitz+constant&btnG=). The DIRECT algorithm is particularly useful for optimizing functions where the Lipschitz constant is unknown. This package allows users to perform both univariate and multivariate optimization efficiently.

- The figure below shows the DIRECT method after 16 iterations on the Branin function. The cells are much denser around the minima of the Branin function because the DIRECT method is designed to increase its resolution in promising regions.
The figure below shows the DIRECT method after 16 iterations on the Branin function. The cells are much denser around the minima of the Branin function because the DIRECT method is designed to increase its resolution in promising regions.

![page_11](https://github.com/user-attachments/assets/b833bedd-41aa-40c5-a27f-26188a171797)


This documentation provides detailed usage examples, theoretical background, and advanced customization options to help you get the most out of `DividedRectangles.jl`.

## Installation

To install the package, start Julia and run the following command:
Expand All @@ -25,17 +22,14 @@ using Pkg
Pkg.add(url="https://github.com/sisl/DividedRectangles.jl")

```
# Usage
## Usage

To use the `DividedRectangles` module, start your code with:

```julia
using DividedRectangles
```

## Core Functions

### `optimize`
The `optimize` function is the primary function of the `DividedRectangles` module. It implements the DIRECT algorithm to find the minimum of a given objective function within specified bounds.

To use the `optimize` function with a custom objective function::
Expand Down Expand Up @@ -65,7 +59,7 @@ println("Best design found: ", result)
- `min_radius`: (Optional) The minimum radius of hyper-rectangles (default: 1e-5).

**Returns:**
- The best design 𝑥 found by DIRECT.
- The best design `x` found by DIRECT.

## Credits

Expand Down

0 comments on commit 6480b07

Please sign in to comment.