diff --git a/docs/usage.md b/docs/usage.md index e69de29..f823a8b 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -0,0 +1,16 @@ +# Usage Examples + +In this page there are some example usage of MOTrainer. + +We assume the users starts from an [xarray.Dataset](https://docs.xarray.dev/en/stable/generated/xarray.Dataset.html) +object which contains spatio-temporal data needed for training multiple independent Machine Learning (ML) models. + + + +## Split Spatio-Temporal Dataset for Independent Training Processes + +## Train-Test Split + +## Parallel ML Model Optimization with Dask-ml + +## Intiate a Jackknife GPI for DNN Training diff --git a/mkdocs.yml b/mkdocs.yml index ab677b7..1785bed 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -8,7 +8,10 @@ nav: - Installation: setup.md - Usage: usage.md - Examples: - - SciKit Learn: notebooks/demo_ml.ipynb + - Covert a nested DataFrame to a Dataset: notebooks/example_read_from_one_df.ipynb + - Align multiple DataFrames to a Dataset: notebooks/example_read_from_multiple_df.ipynb + - Prallely training sklearn models with dask-ml: notebooks/example_daskml.ipynb + - Prallely training DNN with Tensorflow: notebooks/example_dnn.ipynb - Conributing guide: CONTRIBUTING.md - Change Log: CHANGELOG.md