Strategy selector in documentation#571
Draft
TobyBoyne wants to merge 2 commits into
Draft
Conversation
Contributor
|
Hi Toby, this is super nice! Best, Johannes Tell me when it is ready! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
Currently, there is no Strategy page in the documentation, despite this being the main way that users will interact with BoFire. Additionally, the Surrogates page can be quite overwhelming, with many options to choose from.
I propose we take inspiration from the excellent tool https://honegumi.readthedocs.io/en/latest/, which I found when trying to recreate the 'Install PyTorch' table on https://pytorch.org/. This PR has a rough implementation of this table, with a couple of example screenshots below:
Clicking on the "multi-task" link changes the code block appropriately:
Have you read the Contributing Guidelines on pull requests?
Yes
Test Plan
The docs do not have associated tests. I will check on different devices/platforms that the interface works as intended.