8 releases
0.1.8 | Oct 21, 2022 |
---|---|
0.1.7 | Oct 18, 2022 |
0.1.2 | Sep 9, 2022 |
#367 in Machine learning
61 downloads per month
Used in 3 crates
(via jams-core)
70KB
876 lines
CatBoost Rust Package
Cargo Package
Cargo package can be found here
Historical Context
- This started off as an attempt to publish the catboost bindings to cargo
- Eventually decided to unofficially split out the code and maintain separate rust bindings, similar to
onnxruntime-rs
- Note that this is voluntarily maintained and not yet endorsed by the official catboost team
Differences versus official rust package
- Necessary changes made to publish crate instead of referencing the git repo, which is pretty big
- The official
catboost-sys
one attempts to rebuild the shared library, whereas this one downloads it from the github release page. - The
build.rs
script is with assumptionlibcatboost
shared library already downloaded separately. - Also marked the Model as
Send
so that it can be used across threads, due to the documentation stating it's thread safe. Note that this is not yet extensively tested though. - As of the present the catboost version is hardcoded, it is currently 1.0.6.
If you need dependencies for bindgen
apt-get install -y curl build-essential pkg-config libssl-dev libclang-dev clang cmake
Install libcatboost
- Download catboost binary from
https://github.com/catboost/catboost/releases/tag/v1.0.6
.- If you are using Linux, download
libcatboostmodel.so
- If you are using MacOS, download
libcatboostmodel.dylib
- Place the file in
/usr/lib/
- Create a soft link to
x.x.1
, e.g.sudo ln -s libcatboostmodel.so libcatboostmodel.so.1
- If you are using Linux, download
Basic usage example
- Add a dependency to your Cargo.toml:
[dependencies]
catboost-rs = "0.1.6"
- To use catboost, it assumes the shared libraries are available. You will need to download the shared library from the official releases page. If you are using linux, download
libcatboostmodel.so
. If you are using Mac, downloadlibcatboostmodel.dylib
. As of the present, only version 1.0.6 is supported. - Move these libraries to
/usr/lib
- Now you can apply pretrained model in your code:
// Bring catboost module into the scope
use catboost_rs as catboost;
fn main() {
// Load the trained model
let model = catboost::Model::load("tmp/model.bin").unwrap();
println!("Number of cat features {}", model.get_cat_features_count());
println!("Number of float features {}", model.get_float_features_count());
// Apply the model
let prediction = model
.calc_model_prediction(
vec![
vec![-10.0, 5.0, 753.0],
vec![30.0, 1.0, 760.0],
vec![40.0, 0.1, 705.0],
],
vec![
vec![String::from("north")],
vec![String::from("south")],
vec![String::from("south")],
],
)
.unwrap();
println!("Prediction {:?}", prediction);
}
Documentation
Run cargo doc --open
in catboost/rust-package
directory.
Tests
Run cargo test
in catboost/rust-package
directory.
Dependencies
~0–2.1MB
~41K SLoC