We realized that the organization of both the user guides and the examples needs to be improved. This will involve the introduction of new ways of categorizing pages within the documentation as well as reorganizing the actual content of the documentation.
The core idea is to organize the documentation into Components, Concepts, Examples and Guidance:
- A
Component is a piece of BayBE that needs to work together with other Components, like the recommenders, the objectives and so on.
- A
Concept is a something that is not tied to individual parts of BayBE but rather the things that you can do with BayBE and the features that we want to include into BayBE, like Transfer Learning, Active Learning, Pareto Optimization.
- An
Example is a python script that can be run end-to-end and demonstrates a certain aspect or Concept of BayBE, while ideally being focused on a specific and clear use case. An example for this is the current laser tuning example which is used to demonstrate the Concept of Transformations
Guidance describe the role of BayBE as well as all of its parts in the general BO loop and framework and how to use this. Such aGuidance would for example explain how to model a search space or which recommender to choose.
We currently plan to implement these by first working on the following user guides:
We realized that the organization of both the user guides and the examples needs to be improved. This will involve the introduction of new ways of categorizing pages within the documentation as well as reorganizing the actual content of the documentation.
The core idea is to organize the documentation into
Components,Concepts,ExamplesandGuidance:Componentis a piece of BayBE that needs to work together with otherComponents, like the recommenders, the objectives and so on.Conceptis a something that is not tied to individual parts of BayBE but rather the things that you can do with BayBE and the features that we want to include into BayBE, like Transfer Learning, Active Learning, Pareto Optimization.Exampleis a python script that can be run end-to-end and demonstrates a certain aspect orConceptof BayBE, while ideally being focused on a specific and clear use case. An example for this is the current laser tuning example which is used to demonstrate theConceptofTransformationsGuidancedescribe the role of BayBE as well as all of its parts in the general BO loop and framework and how to use this. Such aGuidancewould for example explain how to model a search space or which recommender to choose.We currently plan to implement these by first working on the following user guides:
Component,Concept,ExampleandGuidanceComponentComponentand will get aGuidance.simulationsubmoduleGuidance