new readme #690
new readme #690
Conversation
README.md
Outdated
| A Bayesian optimization toolbox built on [TensorFlow](https://www.tensorflow.org/). Trieste supports Python 3.7 onwards and uses [semantic versioning](https://semver.org/). | ||
| [](https://pypi.org/project/trieste) | ||
| [](LICENSE) | ||
| [](https://github.com/secondmind-labs/trieste/actions?query=workflows%3Aquality-checks) |
There was a problem hiding this comment.
Is this the badge we want here? AFAICT it will show red whenever any unmerged PR is failing some tests. Maybe we want https://github.com/secondmind-labs/trieste/actions/workflows/develop-checks.yaml/badge.svg instead?
There was a problem hiding this comment.
yes, wasn't sure which one exactly to show... it also shows names of our workflows automatically, can we make those names more human readable?
There was a problem hiding this comment.
ok, found a way to show the names nicely, we need to add a name field to our workflows - I'll do that
I agree that quality-checks doesn't make sense as it run on every PR, but develop-checks though runs only the slow tests so that doesn't seem appropriate as well
actually, what we need is checks on master branch, running everything we have, thats what matters here, right?
There was a problem hiding this comment.
develop is essentially master in trieste, so develop-checks is the closest we have (though I could extend it to also rerun the quick tests, even though these need to have already passed for you to merge)
There was a problem hiding this comment.
we often had issues with develop checks not passing, it seems bad that anytime that some PR is merged we could get failing signs here, while the official release is healthy - I think we simply need another GH action that runs everything when there is a release, i.e. something really merged to master
| ### Installation | ||
| [Documentation (release)](https://secondmind-labs.github.io/trieste/1.0.0/index.html) | | ||
| [Documentation (develop)](https://secondmind-labs.github.io/trieste/develop/index.html) | | ||
| [Tutorials](https://secondmind-labs.github.io/trieste/1.0.0/tutorials.html) | |
There was a problem hiding this comment.
Though I guess it won't help for these links. Unless you'd also like me to redirects at https://secondmind-labs.github.io/trieste/tutorials.html and https://secondmind-labs.github.io/trieste/autoapi.html?
There was a problem hiding this comment.
yes, I was wondering if we can put up some redirects
There was a problem hiding this comment.
@uri-granta how can we set these redirects up?
| from trieste.bayesian_optimizer import BayesianOptimizer | ||
|
|
||
| bo = BayesianOptimizer(observer, search_space) | ||
| num_steps = 15 | ||
| result = bo.optimize(num_steps, initial_data, model) | ||
| query_point, observation, arg_min_idx = result.try_get_optimal_point() |
There was a problem hiding this comment.
since we stress the ask-tell, perhaps we should use it here?
There was a problem hiding this comment.
Not in the getting started I think. Though you could explicitly link both the expected-improvement and ask-tell tutorials if you want.
| git clone https://github.com/secondmind-labs/trieste.git | ||
| cd trieste | ||
| pip install -e . |
There was a problem hiding this comment.
this is incomplete, starting point at best - to do typing, formatting and testing there is a series of additional installation commands...
There was a problem hiding this comment.
Strictly speaking they only require tox to run. But yes, the current workflow is a mess and hopefully we'll get a chance to fix (or at least improve) it in not too long.
| @@ -1,12 +1,81 @@ | |||
| # Trieste | |||
There was a problem hiding this comment.
we can add a logo here if we are happy enough with one of the options...
| from trieste.bayesian_optimizer import BayesianOptimizer | ||
|
|
||
| bo = BayesianOptimizer(observer, search_space) | ||
| num_steps = 15 | ||
| result = bo.optimize(num_steps, initial_data, model) | ||
| query_point, observation, arg_min_idx = result.try_get_optimal_point() |
There was a problem hiding this comment.
Not in the getting started I think. Though you could explicitly link both the expected-improvement and ask-tell tutorials if you want.
| git clone https://github.com/secondmind-labs/trieste.git | ||
| cd trieste | ||
| pip install -e . |
There was a problem hiding this comment.
Strictly speaking they only require tox to run. But yes, the current workflow is a mess and hopefully we'll get a chance to fix (or at least improve) it in not too long.
this will likely trigger changes to contribution guidelines
we also need to setup codecov.io account