catboost-rust 0.3.2

Rust bindings for CatBoost, a gradient boosting library for machine learning. Downloads CatBoost binaries at runtime for cross-platform compatibility.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130

use std::ffi::CString;

#[derive(Default)]
pub struct EmptyFloatFeatures {}

impl AsRef<[Vec<f32>]> for EmptyFloatFeatures {
    fn as_ref(&self) -> &[Vec<f32>] {
        &[]
    }
}

#[derive(Default)]
pub struct EmptyCatFeatures {}

impl AsRef<[Vec<String>]> for EmptyCatFeatures {
    fn as_ref(&self) -> &[Vec<String>] {
        &[]
    }
}

#[derive(Default)]
pub struct EmptyTextFeatures {}

impl AsRef<[Vec<CString>]> for EmptyTextFeatures {
    fn as_ref(&self) -> &[Vec<CString>] {
        &[]
    }
}

#[derive(Default)]
pub struct EmptyEmbeddingFeatures {}

impl AsRef<[Vec<Vec<f32>>]> for EmptyEmbeddingFeatures {
    fn as_ref(&self) -> &[Vec<Vec<f32>>] {
        &[]
    }
}

pub struct ObjectsOrderFeatures<
    // must provide 2-level dereferencing to f32. Outer is by-object, inner is by float feature
    TFloatFeatures = EmptyFloatFeatures,
    // must provide 2-level dereferencing to str. Outer is by-object, inner is by cat feature
    TCatFeatures = EmptyCatFeatures,
    // must provide 2-level dereferencing to CStr. Outer is by-object, inner is by cat feature
    // Note: CStr is used because that's what CatBoost's C API functions accept this format for now.
    TTextFeatures = EmptyTextFeatures,
    // must provide 3-level dereferencing to f32. Levels are: by-object, by-embedding, index in embedding
    TEmbeddingFeatures = EmptyEmbeddingFeatures,
> {
    pub float_features: TFloatFeatures,
    pub cat_features: TCatFeatures,
    pub text_features: TTextFeatures,
    pub embedding_features: TEmbeddingFeatures,
}


impl ObjectsOrderFeatures<EmptyFloatFeatures, EmptyCatFeatures, EmptyTextFeatures, EmptyEmbeddingFeatures>
{
    pub fn new() -> Self {
        ObjectsOrderFeatures {
            float_features: EmptyFloatFeatures {},
            cat_features: EmptyCatFeatures {},
            text_features: EmptyTextFeatures {},
            embedding_features: EmptyEmbeddingFeatures {},
        }
    }
}

impl Default for ObjectsOrderFeatures<EmptyFloatFeatures, EmptyCatFeatures, EmptyTextFeatures, EmptyEmbeddingFeatures> {
    fn default() -> Self {
        Self::new()
    }
}


/// `with_*_features` are convenience functions when you don't want to specify all types of features when you don't
///   need them.
/// They are necessary because Rust does not support default params.
/// See examples in model tests.
impl<TFloatFeatures, TCatFeatures, TTextFeatures, TEmbeddingFeatures>
    ObjectsOrderFeatures<TFloatFeatures, TCatFeatures, TTextFeatures, TEmbeddingFeatures>
{
    pub fn with_float_features<TNewFloatFeatures>(
        self,
        new_float_features: TNewFloatFeatures
    ) -> ObjectsOrderFeatures<TNewFloatFeatures, TCatFeatures, TTextFeatures, TEmbeddingFeatures> {
        ObjectsOrderFeatures{
            float_features: new_float_features,
            cat_features: self.cat_features,
            text_features: self.text_features,
            embedding_features: self.embedding_features
        }
    }

    pub fn with_cat_features<TNewCatFeatures>(
        self,
        new_cat_features: TNewCatFeatures
    ) -> ObjectsOrderFeatures<TFloatFeatures, TNewCatFeatures, TTextFeatures, TEmbeddingFeatures> {
        ObjectsOrderFeatures{
            float_features: self.float_features,
            cat_features: new_cat_features,
            text_features: self.text_features,
            embedding_features: self.embedding_features
        }
    }

    pub fn with_text_features<TNewTextFeatures>(
        self,
        new_text_features: TNewTextFeatures
    ) -> ObjectsOrderFeatures<TFloatFeatures, TCatFeatures, TNewTextFeatures, TEmbeddingFeatures> {
        ObjectsOrderFeatures{
            float_features: self.float_features,
            cat_features: self.cat_features,
            text_features: new_text_features,
            embedding_features: self.embedding_features
        }
    }

    pub fn with_embedding_features<TNewEmbeddingFeatures>(
        self,
        new_embedding_features: TNewEmbeddingFeatures
    ) -> ObjectsOrderFeatures<TFloatFeatures, TCatFeatures, TTextFeatures, TNewEmbeddingFeatures> {
        ObjectsOrderFeatures{
            float_features: self.float_features,
            cat_features: self.cat_features,
            text_features: self.text_features,
            embedding_features: new_embedding_features
        }
    }
}