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

Revamp documentation #114

Open
micahjsmith opened this issue Feb 13, 2019 · 3 comments
Open

Revamp documentation #114

micahjsmith opened this issue Feb 13, 2019 · 3 comments

Comments

@micahjsmith
Copy link
Contributor

Create the following documentation pages:

  • getting started: intro
  • getting started: installation
  • getting started: rename basic usage -> quickstart, add a bit on hyperparameters
  • advanced usage: basic concepts
  • advanced usage: hyperparameters
  • advanced usage: tuners -> extend this in depth
  • advanced usage: selectors -> extend this in depth

Reorganize tree, see MLBlocks.

See also: https://hdi-project.github.io/MLBlocks/

See also: #52

@WALEX2000
Copy link

Hey, I was searching through the documentation and I was wondering if there is direct support for MLBlocks Pipelines?
As in, give BTB a json with the MLBlocks Pipeline and start tuning. (I didn't find anything on it on the docs)

@micahjsmith
Copy link
Contributor Author

There is support for this, though you have to write a bit of glue code.

Basically, you load a mlblocks.MLPipeline from the JSON, create BTB tunable using Tunable.from_dict, and then pass the tunable to a BTBSession.

Full working example at https://github.com/ballet/predict-life-outcomes/blob/master/src/fragile_families/analysis/search.py#L168 - see lines 161-171

If you find this example works for your use case, please consider refactoring it into a general-purpose code snippet and making a PR to update the BTB docs!

@WALEX2000
Copy link

@micahjsmith Thanks! I found a similar solution, though the one you presented does look a bit cleaner. I'll look into updating mine on the next couple of days. Thanks for the help!

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

2 participants