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

add basic docs for optimizers and loops #125

Merged
merged 4 commits into from
Mar 1, 2024
Merged

Conversation

LGro
Copy link
Member

@LGro LGro commented Mar 1, 2024

To help newcomers find their way around blackboxopt, this PR adds explicit docs pages for the most important optimizers and optimization loop implementations.

Signed-off-by: Grossberger Lukas (CR/AIR2.2) <Lukas.Grossberger@de.bosch.com>
@LGro LGro requested a review from sfalkner March 1, 2024 13:09
Signed-off-by: Grossberger Lukas (CR/AIR2.2) <Lukas.Grossberger@de.bosch.com>
@LGro LGro force-pushed the docs/optimizers-and-loops branch from 03a5796 to 21c60d4 Compare March 1, 2024 13:14
Signed-off-by: Grossberger Lukas (CR/AIR2.2) <Lukas.Grossberger@de.bosch.com>
Copy link

github-actions bot commented Mar 1, 2024

Coverage report

Click to see where and how coverage changed

FileStatementsMissingCoverageCoverage
(new stmts)
Lines missing
  blackboxopt
  __init__.py
  base.py
  evaluation.py
  io.py
  utils.py
  blackboxopt/examples
  dask_distributed.py
  blackboxopt/optimization_loops
  dask_distributed.py
  testing.py
  utils.py
  blackboxopt/optimizers
  botorch_base.py
  botorch_utils.py
  testing.py
  blackboxopt/optimizers/staged
  hyperband.py
  iteration.py
  optimizer.py
  utils.py
  blackboxopt/visualizations
  utils.py
  visualizer.py
Project Total  

This report was generated by python-coverage-comment-action

Copy link
Collaborator

@sfalkner sfalkner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @LGro for adding these very nice docs!

Signed-off-by: Grossberger Lukas (CR/AIR2.2) <Lukas.Grossberger@de.bosch.com>
@LGro LGro merged commit 7306df7 into main Mar 1, 2024
9 checks passed
@LGro LGro deleted the docs/optimizers-and-loops branch March 1, 2024 13:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants