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

Improve documentation #39

Open
23 of 28 tasks
kiudee opened this issue Mar 1, 2020 · 0 comments
Open
23 of 28 tasks

Improve documentation #39

kiudee opened this issue Mar 1, 2020 · 0 comments

Comments

@kiudee
Copy link
Owner

kiudee commented Mar 1, 2020

To make the library more accessible, all the publicly facing methods should be properly documented. In addition example Jupyter notebooks could be beneficial to illustrate how the library is to be used.
Differences to the parent library scikit-optimize need to be clear.

To do

  • Set up API reference in sphinx
  • Write the docstrings for
    • Optimizer(...)
    • Optimizer.tell(...)
    • Optimizer.ask()
    • Optimizer.run(...)
    • BayesGPR.theta (property)
    • BayesGPR.noise_set_to_zero (context manager)
    • BayesGPR.sample(...)
    • BayesGPR.fit(...)
    • BayesGPR.sample_y(...)
    • Acquisition functions:
      • PVRS
      • MaxValueSearch
      • ExpectedImprovement
      • TopTwoEI
      • LCB
      • Expectation
      • ThompsonSampling
      • VarianceReduction
  • Write example notebooks for
    • How to fit a BayesGPR to a simple noisy 1d function
    • How to optimize a simple noisy 1d function
    • How to warm start an optimization
    • How to save/resume
    • How to save the hyperposterior and load it for the next optimization
  • Write usage instructions in sphinx
  • Link notebooks to sphinx
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant