Skip to content

Commit

Permalink
fixed docs
Browse files Browse the repository at this point in the history
  • Loading branch information
deadsoul44 committed Jun 8, 2024
1 parent 4b68c90 commit 457e0a4
Show file tree
Hide file tree
Showing 4 changed files with 14 additions and 16 deletions.
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,7 @@ PerpetualBooster is a gradient boosting machine (GBM) algorithm which doesn't ha

Hyperparameter optimization usually takes 100 iterations with plain GBM algorithms. PerpetualBooster achieves the same accuracy in the single run. Thus, it achieves around 100x speed-up at the same accuracy with different `budget` levels and with different datasets. The speed-up might be slightly lower or significantly higher than 100x depending on the dataset.

PerpetualBooster prevents overfitting with a generalization algorithm. The paper is work-in-progress to explain the algorithm.

All of the algorithm code is written in [Rust](https://www.rust-lang.org/) with a python wrapper. All of the rust code for the package can be found in the [src](src/) directory, while all of the python wrapper code is in the [python-package](python-package/) directory.
PerpetualBooster prevents overfitting with a generalization algorithm. The paper is work-in-progress to explain how the algorithm works.

## Usage

Expand All @@ -35,7 +33,7 @@ model.fit(X, y, budget=0.4)

## Documentation

Documentation for the python API can be found [here](https://perpetual-ml.com/docs/).
Documentation for the python API can be found [here](https://perpetual-ml.github.io/perpetual/).

## Installation

Expand All @@ -48,5 +46,5 @@ pip install perpetual
To use in a rust project, add the following to your Cargo.toml file.

```toml
perpetual = "0.0.4"
perpetual = "0.0.5"
```
4 changes: 2 additions & 2 deletions python-package/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "py-perpetual"
version = "0.0.4"
version = "0.0.5"
edition = "2021"
authors = ["Mutlu Simsek <[email protected]>"]
homepage = "https://perpetual-ml.com/docs"
Expand All @@ -16,7 +16,7 @@ crate-type = ["cdylib"]

[dependencies]
pyo3 = { version = "0.21.0", features = ["extension-module"] }
perpetual_rs = {package="perpetual", version = "0.0.4", path = "../" }
perpetual_rs = {package="perpetual", version = "0.0.5", path = "../" }
numpy = "0.21.0"
ndarray = "0.15.1"
serde_plain = { version = "1.0" }
Expand Down
8 changes: 2 additions & 6 deletions python-package/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,9 @@

## Python API Reference

<div align="center">
<img alt="PyPI - Version" src="https://img.shields.io/pypi/v/perpetual?link=https%3A%2F%2Fpypi.org%2Fproject%2Fperpetual%2F">

[![Python Versions](https://img.shields.io/pypi/pyversions/perpetual.svg?logo=python&logoColor=white)](https://pypi.org/project/perpetual)
[![PyPI Version](https://img.shields.io/pypi/v/perpetual.svg?logo=pypi&logoColor=white)](https://pypi.org/project/perpetual)
[![Crates.io Version](https://img.shields.io/crates/v/:perpetual?logo=rust&logoColor=white)](https://crates.io/crates/perpetual)

</div>
<img alt="Crates.io Version" src="https://img.shields.io/crates/v/perpetual?link=https%3A%2F%2Fcrates.io%2Fcrates%2Fperpetual">

The `PerpetualBooster` class is currently the only public facing class in the package, and can be used to train gradient boosted decision tree ensembles with multiple objective functions.

Expand Down
10 changes: 7 additions & 3 deletions python-package/pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ build-backend = "maturin"

[project]
name = "perpetual"
description = "A gradient boosting implementation in Rust."
description = "A self-generalizing, hyperparameter-free gradient boosting machine"
license = { file = "LICENSE" }
keywords = [
"rust",
Expand All @@ -21,8 +21,12 @@ dependencies = ["numpy>=1.21", "pandas>=2.0"]
requires-python = ">=3.8"
classifiers = [
"Programming Language :: Rust",
"Programming Language :: Python :: Implementation :: CPython",
"Programming Language :: Python :: Implementation :: PyPy",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
]

[project.optional-dependencies]
Expand Down

0 comments on commit 457e0a4

Please sign in to comment.