Skip to content

docs: fix site_url typo, broken lazyloading nav links, README quickstart, CONTRIBUTING onboarding #96

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wilmund wants to merge 1 commit into from
Closed

docs: fix site_url typo, broken lazyloading nav links, README quickstart, CONTRIBUTING onboarding #96

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

---

Expand All @@ -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.
Expand All @@ -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
Expand Down
4 changes: 3 additions & 1 deletion docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
```

Expand Down
7 changes: 3 additions & 4 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand All @@ -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:
Expand Down