planktonsdm 0.0.7 documentation

Hide navigation sidebar
Hide table of contents sidebar
Back to top
Toggle table of contents sidebar

# planktonsdm docs

This is a set of tools to build and process species distributions models in Python.

Currently supports:

Classifiers: `RandomForestClassifier` `KNeighborsClassifier` `XGBClassifier`

Regressors: `RandomForestRegressor` `KNeighborsRegressor` `XGBRegressor`

Configuration: `1-phase` or `2-phase`

Transformations: `y log-transform` and `X normalization`

Predictions: `single model` and weighted `ensembles`

- Installation
  - Pre-requisites
  - Basic Installation
- Model Configuration
  - myconfig.yml
    - root
    - path_out
    - traits
    - scale_X
    - verbose
    - seed
    - n_threads
    - cv
    - predict_probability
    - ensemble_config
- Examples
  - 1-phase random forest classifier
    - setup
    - train
    - predict
    - post
  - 2-phase XGBoost regressor
    - setup
    - train
    - predict
    - post
  - 1-phase ensemble regression
    - setup
    - train
    - predict
    - post
- Predict
  - `predict`
    - `predict.make_prediction()`
- Post
  - `post`
    - `post.cwm()`
    - `post.def_groups()`
    - `post.estimate_carbon()`
    - `post.export_ds()`
    - `post.merge_env()`
    - `post.merge_performance()`
    - `post.return_d()`
    - `post.richness()`
    - `post.total()`

# Indices and tables

- Index

- Module Index

- Search Page