Skip to content

Commit

Permalink
Improve documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
nanxstats committed Apr 29, 2024
1 parent a3fc244 commit 637eb05
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 5 deletions.
5 changes: 2 additions & 3 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,8 @@ Version: 0.1.0
Authors@R: c(
person("Nan", "Xiao", email = "me@nanx.me", role = c("aut", "cre", "cph"),
comment = c(ORCID = "0000-0002-0250-5673")))
Description: A minimalist implementation of model stacking
by Wolpert (1992) <doi:10.1016/S0893-6080(05)80023-1>
for boosted tree models.
Description: A minimalist implementation of model stacking by
Wolpert (1992) <doi:10.1016/S0893-6080(05)80023-1> for boosted tree models.
A classic, two-layer stacking model is implemented, where the first layer
generates features using gradient boosting trees, and the second layer
employs a logistic regression model that uses these features as inputs.
Expand Down
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,21 @@ and catboost ([Prokhorenkova et al., 2018](https://dl.acm.org/doi/abs/10.5555/33

## Installation

Install from GitHub:
The easiest way to get stackgbm is to install from CRAN:

```r
install.packages("stackgbm")
```

Alternatively, to use a new feature or get a bug fix,
you can install the development version of stackgbm from GitHub:

```r
# install.packages("remotes")
remotes::install_github("nanxstats/stackgbm")
```

To install all dependencies, check out the instructions from
To install all potential dependencies, check out the instructions from
[manage dependencies](https://github.com/nanxstats/stackgbm/wiki/Manage-dependencies).

## Model
Expand Down

0 comments on commit 637eb05

Please sign in to comment.