Treelite
c_api.cc
Go to the documentation of this file.
1 
8 #include <treelite/annotator.h>
9 #include <treelite/c_api.h>
10 #include <treelite/c_api_error.h>
11 #include <treelite/compiler.h>
13 #include <treelite/data.h>
14 #include <treelite/filesystem.h>
15 #include <treelite/frontend.h>
16 #include <treelite/tree.h>
17 #include <treelite/math.h>
18 #include <treelite/gtil.h>
19 #include <treelite/logging.h>
20 #include <memory>
21 #include <algorithm>
22 #include <fstream>
23 #include <string>
24 #include <cstdio>
25 
26 using namespace treelite;
27 
28 namespace {
29 
31 struct TreeliteAPIThreadLocalEntry {
33  std::string ret_str;
34 };
35 
36 // define threadlocal store for returning information
37 using TreeliteAPIThreadLocalStore = ThreadLocalStore<TreeliteAPIThreadLocalEntry>;
38 
39 } // anonymous namespace
40 
42  ModelHandle model, DMatrixHandle dmat, int nthread, int verbose, AnnotationHandle* out) {
43  API_BEGIN();
44  std::unique_ptr<BranchAnnotator> annotator{new BranchAnnotator()};
45  const Model* model_ = static_cast<Model*>(model);
46  const auto* dmat_ = static_cast<const DMatrix*>(dmat);
47  TREELITE_CHECK(dmat_) << "Found a dangling reference to DMatrix";
48  annotator->Annotate(*model_, dmat_, nthread, verbose);
49  *out = static_cast<AnnotationHandle>(annotator.release());
50  API_END();
51 }
52 
54  const char* path) {
55  API_BEGIN();
56  const BranchAnnotator* annotator = static_cast<BranchAnnotator*>(handle);
57  std::ofstream fo(path);
58  annotator->Save(fo);
59  API_END();
60 }
61 
63  API_BEGIN();
64  delete static_cast<BranchAnnotator*>(handle);
65  API_END();
66 }
67 
68 int TreeliteCompilerCreateV2(const char* name, const char* params_json_str, CompilerHandle* out) {
69  API_BEGIN();
70  std::unique_ptr<Compiler> compiler{Compiler::Create(name, params_json_str)};
71  *out = static_cast<CompilerHandle>(compiler.release());
72  API_END();
73 }
74 
76  ModelHandle model,
77  const char* dirpath) {
78  API_BEGIN();
79  const Model* model_ = static_cast<Model*>(model);
80  Compiler* compiler_ = static_cast<Compiler*>(compiler);
81  TREELITE_CHECK(model_);
82  TREELITE_CHECK(compiler_);
83  compiler::CompilerParam param = compiler_->QueryParam();
84 
85  // create directory named dirpath
86  const std::string& dirpath_(dirpath);
87  filesystem::CreateDirectoryIfNotExist(dirpath);
88 
89  /* compile model */
90  auto compiled_model = compiler_->Compile(*model_);
91  if (param.verbose > 0) {
92  TREELITE_LOG(INFO) << "Code generation finished. Writing code to files...";
93  }
94 
95  for (const auto& it : compiled_model.files) {
96  if (param.verbose > 0) {
97  TREELITE_LOG(INFO) << "Writing file " << it.first << "...";
98  }
99  const std::string filename_full = dirpath_ + "/" + it.first;
100  if (it.second.is_binary) {
101  filesystem::WriteToFile(filename_full, it.second.content_binary);
102  } else {
103  filesystem::WriteToFile(filename_full, it.second.content);
104  }
105  }
106 
107  API_END();
108 }
109 
111  API_BEGIN();
112  delete static_cast<Compiler*>(handle);
113  API_END();
114 }
115 
116 int TreeliteLoadLightGBMModel(const char* filename, ModelHandle* out) {
117  API_BEGIN();
118  std::unique_ptr<Model> model = frontend::LoadLightGBMModel(filename);
119  *out = static_cast<ModelHandle>(model.release());
120  API_END();
121 }
122 
123 int TreeliteLoadXGBoostModel(const char* filename, ModelHandle* out) {
124  API_BEGIN();
125  std::unique_ptr<Model> model = frontend::LoadXGBoostModel(filename);
126  *out = static_cast<ModelHandle>(model.release());
127  API_END();
128 }
129 
130 int TreeliteLoadXGBoostJSON(const char* filename, ModelHandle* out) {
131  API_BEGIN();
132  std::unique_ptr<Model> model = frontend::LoadXGBoostJSONModel(filename);
133  *out = static_cast<ModelHandle>(model.release());
134  API_END();
135 }
136 
137 int TreeliteLoadXGBoostJSONString(const char* json_str, size_t length, ModelHandle* out) {
138  API_BEGIN();
139  std::unique_ptr<Model> model = frontend::LoadXGBoostJSONModelString(json_str, length);
140  *out = static_cast<ModelHandle>(model.release());
141  API_END();
142 }
143 
144 int TreeliteLoadXGBoostModelFromMemoryBuffer(const void* buf, size_t len, ModelHandle* out) {
145  API_BEGIN();
146  std::unique_ptr<Model> model = frontend::LoadXGBoostModel(buf, len);
147  *out = static_cast<ModelHandle>(model.release());
148  API_END();
149 }
150 
152  int n_estimators, int n_features, const int64_t* node_count, const int64_t** children_left,
153  const int64_t** children_right, const int64_t** feature, const double** threshold,
154  const double** value, const int64_t** n_node_samples, const double** impurity,
155  ModelHandle* out) {
156  API_BEGIN();
157  std::unique_ptr<Model> model = frontend::LoadSKLearnRandomForestRegressor(
158  n_estimators, n_features, node_count, children_left, children_right, feature, threshold,
159  value, n_node_samples, impurity);
160  *out = static_cast<ModelHandle>(model.release());
161  API_END();
162 }
163 
165  int n_estimators, int n_features, int n_classes, const int64_t* node_count,
166  const int64_t** children_left, const int64_t** children_right, const int64_t** feature,
167  const double** threshold, const double** value, const int64_t** n_node_samples,
168  const double** impurity, ModelHandle* out) {
169  API_BEGIN();
170  std::unique_ptr<Model> model = frontend::LoadSKLearnRandomForestClassifier(
171  n_estimators, n_features, n_classes, node_count, children_left, children_right, feature,
172  threshold, value, n_node_samples, impurity);
173  *out = static_cast<ModelHandle>(model.release());
174  API_END();
175 }
176 
178  int n_estimators, int n_features, const int64_t* node_count, const int64_t** children_left,
179  const int64_t** children_right, const int64_t** feature, const double** threshold,
180  const double** value, const int64_t** n_node_samples, const double** impurity,
181  ModelHandle* out) {
182  API_BEGIN();
183  std::unique_ptr<Model> model = frontend::LoadSKLearnGradientBoostingRegressor(
184  n_estimators, n_features, node_count, children_left, children_right, feature, threshold,
185  value, n_node_samples, impurity);
186  *out = static_cast<ModelHandle>(model.release());
187  API_END();
188 }
189 
191  int n_estimators, int n_features, int n_classes, const int64_t* node_count,
192  const int64_t** children_left, const int64_t** children_right, const int64_t** feature,
193  const double** threshold, const double** value, const int64_t** n_node_samples,
194  const double** impurity, ModelHandle* out) {
195  API_BEGIN();
196  std::unique_ptr<Model> model = frontend::LoadSKLearnGradientBoostingClassifier(
197  n_estimators, n_features, n_classes, node_count, children_left, children_right, feature,
198  threshold, value, n_node_samples, impurity);
199  *out = static_cast<ModelHandle>(model.release());
200  API_END();
201 }
202 
203 int TreeliteSerializeModel(const char* filename, ModelHandle handle) {
204  API_BEGIN();
205  FILE* fp = std::fopen(filename, "wb");
206  TREELITE_CHECK(fp) << "Failed to open file '" << filename << "'";
207  auto* model_ = static_cast<Model*>(handle);
208  model_->SerializeToFile(fp);
209  std::fclose(fp);
210  API_END();
211 }
212 
213 int TreeliteDeserializeModel(const char* filename, ModelHandle* out) {
214  API_BEGIN();
215  FILE* fp = std::fopen(filename, "rb");
216  TREELITE_CHECK(fp) << "Failed to open file '" << filename << "'";
217  std::unique_ptr<Model> model = Model::DeserializeFromFile(fp);
218  std::fclose(fp);
219  *out = static_cast<ModelHandle>(model.release());
220  API_END();
221 }
222 
223 int TreeliteDumpAsJSON(ModelHandle handle, int pretty_print, const char** out_json_str) {
224  API_BEGIN();
225  auto* model_ = static_cast<Model*>(handle);
226  std::string& ret_str = TreeliteAPIThreadLocalStore::Get()->ret_str;
227  ret_str = model_->DumpAsJSON(pretty_print != 0);
228  *out_json_str = ret_str.c_str();
229  API_END();
230 }
231 
233  API_BEGIN();
234  delete static_cast<Model*>(handle);
235  API_END();
236 }
237 
238 int TreeliteGTILGetPredictOutputSize(ModelHandle handle, size_t num_row, size_t* out) {
239  API_BEGIN();
240  const auto* model_ = static_cast<const Model*>(handle);
241  *out = gtil::GetPredictOutputSize(model_, num_row);
242  API_END();
243 }
244 
245 int TreeliteGTILPredict(ModelHandle handle, const float* input, size_t num_row, float* output,
246  int pred_transform, size_t* out_result_size) {
247  API_BEGIN();
248  const auto* model_ = static_cast<const Model*>(handle);
249  *out_result_size =
250  gtil::Predict(model_, input, num_row, output, (pred_transform == 1));
251  API_END();
252 }
253 
254 int TreeliteQueryNumTree(ModelHandle handle, size_t* out) {
255  API_BEGIN();
256  const auto* model_ = static_cast<const Model*>(handle);
257  *out = model_->GetNumTree();
258  API_END();
259 }
260 
261 int TreeliteQueryNumFeature(ModelHandle handle, size_t* out) {
262  API_BEGIN();
263  const auto* model_ = static_cast<const Model*>(handle);
264  *out = static_cast<size_t>(model_->num_feature);
265  API_END();
266 }
267 
268 int TreeliteQueryNumClass(ModelHandle handle, size_t* out) {
269  API_BEGIN();
270  const auto* model_ = static_cast<const Model*>(handle);
271  *out = static_cast<size_t>(model_->task_param.num_class);
272  API_END();
273 }
274 
275 int TreeliteSetTreeLimit(ModelHandle handle, size_t limit) {
276  API_BEGIN();
277  TREELITE_CHECK_GT(limit, 0) << "limit should be greater than 0!";
278  auto* model_ = static_cast<Model*>(handle);
279  const size_t num_tree = model_->GetNumTree();
280  TREELITE_CHECK_GE(num_tree, limit) << "Model contains fewer trees(" << num_tree << ") than limit";
281  model_->SetTreeLimit(limit);
282  API_END();
283 }
284 
285 int TreeliteTreeBuilderCreateValue(const void* init_value, const char* type, ValueHandle* out) {
286  API_BEGIN();
287  std::unique_ptr<frontend::Value> value = std::make_unique<frontend::Value>();
288  *value = frontend::Value::Create(init_value, GetTypeInfoByName(type));
289  *out = static_cast<ValueHandle>(value.release());
290  API_END();
291 }
292 
294  API_BEGIN();
295  delete static_cast<frontend::Value*>(handle);
296  API_END();
297 }
298 
299 int TreeliteCreateTreeBuilder(const char* threshold_type, const char* leaf_output_type,
300  TreeBuilderHandle* out) {
301  API_BEGIN();
302  std::unique_ptr<frontend::TreeBuilder> builder{
303  new frontend::TreeBuilder(GetTypeInfoByName(threshold_type),
304  GetTypeInfoByName(leaf_output_type))
305  };
306  *out = static_cast<TreeBuilderHandle>(builder.release());
307  API_END();
308 }
309 
311  API_BEGIN();
312  delete static_cast<frontend::TreeBuilder*>(handle);
313  API_END();
314 }
315 
317  API_BEGIN();
318  auto* builder = static_cast<frontend::TreeBuilder*>(handle);
319  TREELITE_CHECK(builder) << "Detected dangling reference to deleted TreeBuilder object";
320  builder->CreateNode(node_key);
321  API_END();
322 }
323 
325  API_BEGIN();
326  auto* builder = static_cast<frontend::TreeBuilder*>(handle);
327  TREELITE_CHECK(builder) << "Detected dangling reference to deleted TreeBuilder object";
328  builder->DeleteNode(node_key);
329  API_END();
330 }
331 
333  API_BEGIN();
334  auto* builder = static_cast<frontend::TreeBuilder*>(handle);
335  TREELITE_CHECK(builder) << "Detected dangling reference to deleted TreeBuilder object";
336  builder->SetRootNode(node_key);
337  API_END();
338 }
339 
341  TreeBuilderHandle handle, int node_key, unsigned feature_id, const char* opname,
342  ValueHandle threshold, int default_left, int left_child_key, int right_child_key) {
343  API_BEGIN();
344  auto* builder = static_cast<frontend::TreeBuilder*>(handle);
345  TREELITE_CHECK(builder) << "Detected dangling reference to deleted TreeBuilder object";
346  builder->SetNumericalTestNode(node_key, feature_id, opname,
347  *static_cast<const frontend::Value*>(threshold),
348  (default_left != 0), left_child_key, right_child_key);
349  API_END();
350 }
351 
353  TreeBuilderHandle handle, int node_key, unsigned feature_id,
354  const unsigned int* left_categories, size_t left_categories_len, int default_left,
355  int left_child_key, int right_child_key) {
356  API_BEGIN();
357  auto* builder = static_cast<frontend::TreeBuilder*>(handle);
358  TREELITE_CHECK(builder) << "Detected dangling reference to deleted TreeBuilder object";
359  std::vector<uint32_t> vec(left_categories_len);
360  for (size_t i = 0; i < left_categories_len; ++i) {
361  TREELITE_CHECK(left_categories[i] <= std::numeric_limits<uint32_t>::max());
362  vec[i] = static_cast<uint32_t>(left_categories[i]);
363  }
364  builder->SetCategoricalTestNode(node_key, feature_id, vec, (default_left != 0),
365  left_child_key, right_child_key);
366  API_END();
367 }
368 
369 int TreeliteTreeBuilderSetLeafNode(TreeBuilderHandle handle, int node_key, ValueHandle leaf_value) {
370  API_BEGIN();
371  auto* builder = static_cast<frontend::TreeBuilder*>(handle);
372  TREELITE_CHECK(builder) << "Detected dangling reference to deleted TreeBuilder object";
373  builder->SetLeafNode(node_key, *static_cast<const frontend::Value*>(leaf_value));
374  API_END();
375 }
376 
378  const ValueHandle* leaf_vector, size_t leaf_vector_len) {
379  API_BEGIN();
380  auto* builder = static_cast<frontend::TreeBuilder*>(handle);
381  TREELITE_CHECK(builder) << "Detected dangling reference to deleted TreeBuilder object";
382  std::vector<frontend::Value> vec(leaf_vector_len);
383  TREELITE_CHECK(leaf_vector) << "leaf_vector argument must not be null";
384  for (size_t i = 0; i < leaf_vector_len; ++i) {
385  TREELITE_CHECK(leaf_vector[i]) << "leaf_vector[" << i << "] contains an empty Value handle";
386  vec[i] = *static_cast<const frontend::Value*>(leaf_vector[i]);
387  }
388  builder->SetLeafVectorNode(node_key, vec);
389  API_END();
390 }
391 
393  int num_feature, int num_class, int average_tree_output, const char* threshold_type,
394  const char* leaf_output_type, ModelBuilderHandle* out) {
395  API_BEGIN();
396  std::unique_ptr<frontend::ModelBuilder> builder{new frontend::ModelBuilder(
397  num_feature, num_class, (average_tree_output != 0), GetTypeInfoByName(threshold_type),
398  GetTypeInfoByName(leaf_output_type))};
399  *out = static_cast<ModelBuilderHandle>(builder.release());
400  API_END();
401 }
402 
404  const char* value) {
405  API_BEGIN();
406  auto* builder = static_cast<frontend::ModelBuilder*>(handle);
407  TREELITE_CHECK(builder) << "Detected dangling reference to deleted ModelBuilder object";
408  builder->SetModelParam(name, value);
409  API_END();
410 }
411 
413  API_BEGIN();
414  delete static_cast<frontend::ModelBuilder*>(handle);
415  API_END();
416 }
417 
419  int index) {
420  API_BEGIN();
421  auto* model_builder = static_cast<frontend::ModelBuilder*>(handle);
422  TREELITE_CHECK(model_builder) << "Detected dangling reference to deleted ModelBuilder object";
423  auto* tree_builder = static_cast<frontend::TreeBuilder*>(tree_builder_handle);
424  TREELITE_CHECK(tree_builder) << "Detected dangling reference to deleted TreeBuilder object";
425  return model_builder->InsertTree(tree_builder, index);
426  API_END();
427 }
428 
430  API_BEGIN();
431  auto* model_builder = static_cast<frontend::ModelBuilder*>(handle);
432  TREELITE_CHECK(model_builder) << "Detected dangling reference to deleted ModelBuilder object";
433  auto* tree_builder = model_builder->GetTree(index);
434  TREELITE_CHECK(tree_builder) << "Detected dangling reference to deleted TreeBuilder object";
435  *out = static_cast<TreeBuilderHandle>(tree_builder);
436  API_END();
437 }
438 
440  API_BEGIN();
441  auto* builder = static_cast<frontend::ModelBuilder*>(handle);
442  TREELITE_CHECK(builder) << "Detected dangling reference to deleted ModelBuilder object";
443  builder->DeleteTree(index);
444  API_END();
445 }
446 
448  API_BEGIN();
449  auto* builder = static_cast<frontend::ModelBuilder*>(handle);
450  TREELITE_CHECK(builder) << "Detected dangling reference to deleted ModelBuilder object";
451  std::unique_ptr<Model> model = builder->CommitModel();
452  *out = static_cast<ModelHandle>(model.release());
453  API_END();
454 }
Some useful math utilities.
int TreeliteQueryNumClass(ModelHandle handle, size_t *out)
Query the number of classes of the model. (1 if the model is binary classifier or regressor) ...
Definition: c_api.cc:268
C API of Treelite, used for interfacing with other languages This header is excluded from the runtime...
Parameters for tree compiler.
int TreeliteModelBuilderSetModelParam(ModelBuilderHandle handle, const char *name, const char *value)
Set a model parameter.
Definition: c_api.cc:403
int TreeliteLoadSKLearnRandomForestRegressor(int n_estimators, int n_features, const int64_t *node_count, const int64_t **children_left, const int64_t **children_right, const int64_t **feature, const double **threshold, const double **value, const int64_t **n_node_samples, const double **impurity, ModelHandle *out)
Load a scikit-learn random forest regressor model from a collection of arrays. Refer to https://sciki...
Definition: c_api.cc:151
branch annotator class
Definition: annotator.h:21
int TreeliteModelBuilderGetTree(ModelBuilderHandle handle, int index, TreeBuilderHandle *out)
Get a reference to a tree in the ensemble.
Definition: c_api.cc:429
void Save(std::ostream &fo) const
save branch annotation to a JSON file
Definition: annotator.cc:257
Collection of front-end methods to load or construct ensemble model.
int TreeliteLoadXGBoostModel(const char *filename, ModelHandle *out)
load a model file generated by XGBoost (dmlc/xgboost). The model file must contain a decision tree en...
Definition: c_api.cc:123
int TreeliteDumpAsJSON(ModelHandle handle, int pretty_print, const char **out_json_str)
Dump a model object as a JSON string.
Definition: c_api.cc:223
#define API_BEGIN()
macro to guard beginning and end section of all functions
Definition: c_api_error.h:14
int TreeliteFreeModel(ModelHandle handle)
delete model from memory
Definition: c_api.cc:232
int TreeliteAnnotationSave(AnnotationHandle handle, const char *path)
save branch annotation to a JSON file
Definition: c_api.cc:53
int TreeliteQueryNumTree(ModelHandle handle, size_t *out)
Query the number of trees in the model.
Definition: c_api.cc:254
tree builder class
Definition: frontend.h:210
int TreeliteLoadSKLearnGradientBoostingRegressor(int n_estimators, int n_features, const int64_t *node_count, const int64_t **children_left, const int64_t **children_right, const int64_t **feature, const double **threshold, const double **value, const int64_t **n_node_samples, const double **impurity, ModelHandle *out)
Load a scikit-learn gradient boosting regressor model from a collection of arrays. Refer to https://scikit-learn.org/stable/auto_examples/tree/plot_unveil_tree_structure.html to learn the mearning of the arrays in detail.
Definition: c_api.cc:177
int TreeliteModelBuilderDeleteTree(ModelBuilderHandle handle, int index)
Remove a tree from the ensemble.
Definition: c_api.cc:439
parameters for tree compiler
Input data structure of Treelite.
int TreeliteDeserializeModel(const char *filename, ModelHandle *out)
Deserialize (load) a model object from disk.
Definition: c_api.cc:213
int TreeliteLoadXGBoostJSON(const char *filename, ModelHandle *out)
load a json model file generated by XGBoost (dmlc/xgboost). The model file must contain a decision tr...
Definition: c_api.cc:130
int TreeliteDeleteModelBuilder(ModelBuilderHandle handle)
Delete a model builder from memory.
Definition: c_api.cc:412
int TreeliteTreeBuilderSetCategoricalTestNode(TreeBuilderHandle handle, int node_key, unsigned feature_id, const unsigned int *left_categories, size_t left_categories_len, int default_left, int left_child_key, int right_child_key)
Turn an empty node into a test node with categorical split. A list defines all categories that would ...
Definition: c_api.cc:352
model structure for tree ensemble
logging facility for Treelite
int TreeliteAnnotationFree(AnnotationHandle handle)
delete branch annotation from memory
Definition: c_api.cc:62
int TreeliteTreeBuilderSetNumericalTestNode(TreeBuilderHandle handle, int node_key, unsigned feature_id, const char *opname, ValueHandle threshold, int default_left, int left_child_key, int right_child_key)
Turn an empty node into a test node with numerical split. The test is in the form [feature value] OP ...
Definition: c_api.cc:340
interface of compiler
Definition: compiler.h:53
int TreeliteLoadSKLearnRandomForestClassifier(int n_estimators, int n_features, int n_classes, const int64_t *node_count, const int64_t **children_left, const int64_t **children_right, const int64_t **feature, const double **threshold, const double **value, const int64_t **n_node_samples, const double **impurity, ModelHandle *out)
Load a scikit-learn random forest classifier model from a collection of arrays. Refer to https://scik...
Definition: c_api.cc:164
int TreeliteAnnotateBranch(ModelHandle model, DMatrixHandle dmat, int nthread, int verbose, AnnotationHandle *out)
annotate branches in a given model using frequency patterns in the training data. ...
Definition: c_api.cc:41
int TreeliteTreeBuilderCreateValue(const void *init_value, const char *type, ValueHandle *out)
Create a new Value object. Some model builder API functions accept this Value type to accommodate val...
Definition: c_api.cc:285
Interface of compiler that compiles a tree ensemble model.
int TreeliteSetTreeLimit(ModelHandle handle, size_t limit)
keep first N trees of model, limit must smaller than number of trees.
Definition: c_api.cc:275
model builder class
Definition: frontend.h:299
void * ValueHandle
handle to a polymorphic value type, used in the model builder API
Definition: c_api.h:33
int TreeliteModelBuilderInsertTree(ModelBuilderHandle handle, TreeBuilderHandle tree_builder_handle, int index)
Insert a tree at specified location.
Definition: c_api.cc:418
void * DMatrixHandle
handle to a data matrix
Definition: c_api_common.h:30
Cross-platform wrapper for common filesystem functions.
int TreeliteTreeBuilderSetRootNode(TreeBuilderHandle handle, int node_key)
Set a node as the root of a tree.
Definition: c_api.cc:332
int TreeliteCompilerCreateV2(const char *name, const char *params_json_str, CompilerHandle *out)
Create a compiler with a given name.
Definition: c_api.cc:68
void * TreeBuilderHandle
handle to tree builder class
Definition: c_api.h:25
Error handling for C API.
int TreeliteDeleteTreeBuilder(TreeBuilderHandle handle)
Delete a tree builder from memory.
Definition: c_api.cc:310
int TreeliteCreateTreeBuilder(const char *threshold_type, const char *leaf_output_type, TreeBuilderHandle *out)
Create a new tree builder.
Definition: c_api.cc:299
void * AnnotationHandle
handle to branch annotation data
Definition: c_api.h:29
int TreeliteModelBuilderCommitModel(ModelBuilderHandle handle, ModelHandle *out)
finalize the model and produce the in-memory representation
Definition: c_api.cc:447
General Tree Inference Library (GTIL), providing a reference implementation for predicting with decis...
int TreeliteTreeBuilderSetLeafNode(TreeBuilderHandle handle, int node_key, ValueHandle leaf_value)
Turn an empty node into a leaf node.
Definition: c_api.cc:369
int TreeliteCompilerGenerateCodeV2(CompilerHandle compiler, ModelHandle model, const char *dirpath)
Generate prediction code from a tree ensemble model. The code will be C99 compliant. One header file (.h) will be generated, along with one or more source files (.c).
Definition: c_api.cc:75
int TreeliteCreateModelBuilder(int num_feature, int num_class, int average_tree_output, const char *threshold_type, const char *leaf_output_type, ModelBuilderHandle *out)
Create a new model builder.
Definition: c_api.cc:392
int TreeliteLoadSKLearnGradientBoostingClassifier(int n_estimators, int n_features, int n_classes, const int64_t *node_count, const int64_t **children_left, const int64_t **children_right, const int64_t **feature, const double **threshold, const double **value, const int64_t **n_node_samples, const double **impurity, ModelHandle *out)
Load a scikit-learn gradient boosting classifier model from a collection of arrays. Refer to https://scikit-learn.org/stable/auto_examples/tree/plot_unveil_tree_structure.html to learn the mearning of the arrays in detail.
Definition: c_api.cc:190
virtual compiler::CompiledModel Compile(const Model &model)=0
convert tree ensemble model
virtual compiler::CompilerParam QueryParam() const =0
Query the parameters used to intiailize the compiler.
int TreeliteLoadXGBoostModelFromMemoryBuffer(const void *buf, size_t len, ModelHandle *out)
load an XGBoost model from a memory buffer.
Definition: c_api.cc:144
void * ModelHandle
handle to a decision tree ensemble model
Definition: c_api.h:23
int TreeliteLoadLightGBMModel(const char *filename, ModelHandle *out)
load a model file generated by LightGBM (Microsoft/LightGBM). The model file must contain a decision ...
Definition: c_api.cc:116
TypeInfo GetTypeInfoByName(const std::string &str)
conversion table from string to TypeInfo, defined in tables.cc
Definition: typeinfo.cc:16
int TreeliteTreeBuilderDeleteValue(ValueHandle handle)
Delete a Value object from memory.
Definition: c_api.cc:293
Branch annotation tools.
int TreeliteTreeBuilderDeleteNode(TreeBuilderHandle handle, int node_key)
Remove a node from a tree.
Definition: c_api.cc:324
thin wrapper for tree ensemble model
Definition: tree.h:647
int TreeliteQueryNumFeature(ModelHandle handle, size_t *out)
Query the number of features used in the model.
Definition: c_api.cc:261
void * ModelBuilderHandle
handle to ensemble builder class
Definition: c_api.h:27
int TreeliteSerializeModel(const char *filename, ModelHandle handle)
Serialize (persist) a model object to disk.
Definition: c_api.cc:203
int TreeliteTreeBuilderSetLeafVectorNode(TreeBuilderHandle handle, int node_key, const ValueHandle *leaf_vector, size_t leaf_vector_len)
Turn an empty node into a leaf vector node The leaf vector (collection of multiple leaf weights per l...
Definition: c_api.cc:377
A thread-local storage.
Definition: thread_local.h:17
int verbose
if >0, produce extra messages
void * CompilerHandle
handle to compiler class
Definition: c_api.h:31
static Compiler * Create(const std::string &name, const char *param_json_str)
create a compiler from given name
Definition: compiler.cc:16
int TreeliteLoadXGBoostJSONString(const char *json_str, size_t length, ModelHandle *out)
load a model stored as JSON stringby XGBoost (dmlc/xgboost). The model json must contain a decision t...
Definition: c_api.cc:137
int TreeliteCompilerFree(CompilerHandle handle)
delete compiler from memory
Definition: c_api.cc:110
#define API_END()
every function starts with API_BEGIN(); and finishes with API_END() or API_END_HANDLE_ERROR ...
Definition: c_api_error.h:17
int TreeliteTreeBuilderCreateNode(TreeBuilderHandle handle, int node_key)
Create an empty node within a tree.
Definition: c_api.cc:316