diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 923e9ca..01f2803 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -13,7 +13,7 @@ We welcome contribution to `stemflow` 1. Submit a pull request -We recommend you to open and issue of `feature` if you wish to add brand-new features before the PR, especially with heavy mathematics to resolve. +We recommend you to open an issue of `feature` if you wish to add brand-new features before the PR, especially with heavy mathematics to resolve. --- @@ -24,7 +24,7 @@ You will need your own fork to work on the code. Go to the `stemflow` project pa ```bash git clone git@github.com:YOUR-USER-NAME/stemflow.git stemflow-YOURNAME cd stemflow-YOURNAME -git remote add upstream git://github.com/stemflow/stemflow.git +git remote add upstream https://github.com/chenyangkang/stemflow.git ``` This creates the directory `stemflow-YOURNAME` and connects your repository to the upstream (main project) `stemflow` repository. @@ -45,9 +45,9 @@ To do this, first install miniconda or conda: Next, start a new environment called `stemflow`, activate it, and install dependencies: ```bash -conda create -n stemflow -python=3.8 -y +conda create -n stemflow python=3.9 -y activate stemflow -conda install --file requirement.txt +conda install --file requirements.txt conda install pre-commit pytest pytest-cov pytest-xdist pre-commit install diff --git a/docs/index.md b/docs/index.md index 6407eaf..6179cf8 100644 --- a/docs/index.md +++ b/docs/index.md @@ -166,13 +166,15 @@ model = AdaSTEMRegressor( Fitting and prediction methods follow the style of sklearn `BaseEstimator` class: ```py +import numpy as np + ## fit model = model.fit(X_train.reset_index(drop=True), y_train) ## predict pred = model.predict(X_test) pred = np.where(pred<0, 0, pred) -eval_metrics = AdaSTEM.eval_STEM_res('hurdle',y_test, pred_mean) +eval_metrics = AdaSTEM.eval_STEM_res('hurdle',y_test, pred) print(eval_metrics) ``` diff --git a/mkdocs.yml b/mkdocs.yml index c67c37a..8298ec6 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -2,7 +2,7 @@ site_name: stemflow site_description: 'A package for Adaptive Spatio-Temporal Model (AdaSTEM) in python.' repo_name: 'chenyangkang/stemflow' repo_url: 'https://github.com/chenyangkang/stemflow' -site_url: https://chenyangkag.github.io/stemflow/ +site_url: https://chenyangkang.github.io/stemflow/ use_directory_urls: false theme: @@ -104,8 +104,8 @@ nav: - 'Sphere_QTree': API_Documentation/gridding/stemflow.gridding.Sphere_QTree.md - 'QuadGrid': API_Documentation/gridding/stemflow.gridding.QuadGrid.md - stemflow.lazyloading: - - 'lazyloading': API_Documentation/gridding/stemflow.lazyloading.lazyloading.md - - 'open_db_connection': API_Documentation/gridding/stemflow.lazyloading.open_db_connection.md + - 'lazyloading': API_Documentation/lazyloading/stemflow.lazyloading.lazyloading.md + - 'open_db_connection': API_Documentation/lazyloading/stemflow.lazyloading.open_db_connection.md - stemflow.utils: - 'jitterrotation': - 'jitterrotator': API_Documentation/utils/jitterrotation/stemflow.utils.jitterrotation.jitterrotator.md @@ -120,7 +120,6 @@ nav: - 'generate_random': API_Documentation/utils/stemflow.utils.generate_random.md - 'validation': API_Documentation/utils/stemflow.utils.validation.md - 'wrapper': API_Documentation/utils/stemflow.utils.wrapper.md - - 'lazyloading': API_Documentation/utils/stemflow.utils.lazyloading.md - stemflow.model_selection: API_Documentation/stemflow.model_selection.md - Fun Visualization: