Skip to content
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.

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

Set up documentation #59

Merged
merged 19 commits into from
Oct 17, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
4 changes: 3 additions & 1 deletion docs/abbreviations.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
*[GNN]: Gradient Nearest Neighbor
*[MSN]: Most Similar Neighbor
*[kNN]: k-Nearest Neighbor
*[RFNN]: Random Forest Nearest Neighbor
*[RFNN]: Random Forest Nearest Neighbor
*[CCorA]: Canonical Correlation Analysis
aazuspan marked this conversation as resolved.
Show resolved Hide resolved
*[CCA]: Canonical Correspondence Analysis
18 changes: 18 additions & 0 deletions docs/pages/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,24 @@ est = GNNRegressor(n_components=3).fit(X, y)
!!! warning
The maximum number of components depends on the input data and the estimator. Specifying `n_components` greater than the maximum number of components will raise an error.
aazuspan marked this conversation as resolved.
Show resolved Hide resolved

### Custom Transformers

Most estimators in `sknnr` work by applying specialized transformers like [CCA](api/transformers/cca.md) and [CCorA](api/transformers/ccora.md) to the input data. These transformers can be used independently of the estimators, like any other `sklearn` transformer.

```python
from sknnr.transformers import CCATransformer

cca = CCATransformer(n_components=3)
cca.fit_transform(X, y)
```

`sknnr` currently provides the following transformers:

- [StandardScalerWithDOF](api/transformers/standardscalerwithdof.md)
- [MahalanobisTransformer](api/transformers/mahalanobis.md)
- [CCATransformer](api/transformers/cca.md)
- [CCorATransformer](api/transformers/ccora.md)

## Datasets

`sknnr` estimators can be used for any multi-output regression problem, but they excel at predicting forest attributes. The `sknnr.datasets` module contains a number of test datasets with plot-based forest measurements and environmental attributes.
Expand Down
Loading