LLNL / MuyGPyS

A fast, pure python implementation of the MuyGPs Gaussian process realization and training algorithm.
Other
23 stars 11 forks source link

Need to simplify `MuyGPyS.examples` #108

Open bwpriest opened 1 year ago

bwpriest commented 1 year ago

As the library has matured, we have moved away from relying upon one-line interfaces. In the next release we should crystallize MuyGPyS.examples into single-use functions that are meant to be read and used as tutorials, but not actually directly used in anger by data scientists. This will involve removing MuyGPyS.examples.from_indices, moving the make_*_regressor functions into MuyGPyS._test, and removing support from all of the workflows on MultivariateMuyGPS. We might want to add a separate MultivariateMuyGPS-based example, once that class is "finished".

bwpriest commented 1 year ago

In general, in the future we want new features to not have to modify anything in MuyGPyS.examples. If a feature is significant enough that it needs a tutorial, we should add another file to MuyGPyS.examples or another documentation notebook.