Skip to content

Commit

Permalink
add usage page
Browse files Browse the repository at this point in the history
  • Loading branch information
rogerkuou committed Dec 12, 2023
1 parent 11c1a79 commit 0292371
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 1 deletion.
16 changes: 16 additions & 0 deletions docs/usage.md
Original file line number Diff line number Diff line change
@@ -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
5 changes: 4 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 0292371

Please sign in to comment.