Skip to content

Commit ea2bf35

Browse files
committed
first cut at readme update including more information about HiOpBBpy
1 parent 7fc53d1 commit ea2bf35

File tree

1 file changed

+14
-2
lines changed

1 file changed

+14
-2
lines changed

README.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -123,11 +123,23 @@ HiOp supports three types of optimization problems, each with a separate input f
123123
124124
More information on the HiOp interfaces are [here](src/Interface/README.md).
125125
126+
# HiOpBBpy - python based black-box optimization
126127
127-
## Issues
128-
Users are highly encouraged to report any issues they found when using HiOp.
128+
HiOpBBpy is a black-box (derivative free) Bayesian optimization solver for solving certain mathematical optimization problems. HiOpBBpy primarily targets problems for which the objective is very expensive and derivative information is not available. HiOpBBpy leverages MPI parallelism for batched Bayesian optimization methods and other embarassingly parallel tasks in said methods.
129+
130+
## Build/install instructions
131+
132+
HiOpBBpy can be built via pip. A standard build can be done by invoking the following from the hiop home directory
133+
```shell
134+
$> pip install .
135+
```
136+
137+
## Dependencies
129138
139+
HiOpBBpy dependencies are listed in the pyproject.toml file.
130140
141+
## Issues
142+
Users are highly encouraged to report any issues they found when using HiOp.
131143
132144
## Acknowledgments
133145

0 commit comments

Comments
 (0)