c_api.h

Go to the documentation of this file.

 
/* Note: Make sure to use slash-asterisk form of comments in this file
   (like this one). Do not use double-slash (//). */
 
#ifndef TREELITE_C_API_H_
#define TREELITE_C_API_H_
 
#ifdef __cplusplus
#define TREELITE_EXTERN_C extern "C"
#include <cstdint>
#include <cstdio>
#else
#define TREELITE_EXTERN_C
#include <stdint.h>
#include <stdio.h>
#endif
 
/* Special symbols for DLL library on Windows */
#if defined(_MSC_VER) || defined(_WIN32)
#define TREELITE_DLL TREELITE_EXTERN_C __declspec(dllexport)
#define TREELITE_DLL_STRUCT TREELITE_EXTERN_C struct __declspec(dllexport)
#else
#define TREELITE_DLL TREELITE_EXTERN_C __attribute__((visibility("default")))
#define TREELITE_DLL_STRUCT TREELITE_EXTERN_C struct __attribute__((visibility("default")))
#endif
 
typedef void* TreeliteModelHandle;
typedef void* TreeliteModelBuilderHandle;
typedef void* TreeliteGTILConfigHandle;
TREELITE_DLL_STRUCT TreelitePyBufferFrame {
  void* buf;
  char* format;
  size_t itemsize;
  size_t nitem;
};
#ifndef __cplusplus
typedef struct TreelitePyBufferFrame TreelitePyBufferFrame;
#endif
 
TREELITE_DLL int TreeliteLoadXGBoostModelLegacyBinary(
    char const* filename, char const* config_json, TreeliteModelHandle* out);
TREELITE_DLL int TreeliteLoadXGBoostModelLegacyBinaryFromMemoryBuffer(
    void const* buf, size_t len, char const* config_json, TreeliteModelHandle* out);
TREELITE_DLL int TreeliteLoadXGBoostModel(
    char const* filename, char const* config_json, TreeliteModelHandle* out);
TREELITE_DLL int TreeliteLoadXGBoostModelFromString(
    char const* json_str, size_t length, char const* config_json, TreeliteModelHandle* out);
TREELITE_DLL int TreeliteLoadLightGBMModel(
    char const* filename, char const* config_json, TreeliteModelHandle* out);
TREELITE_DLL int TreeliteLoadLightGBMModelFromString(
    char const* model_str, char const* config_json, TreeliteModelHandle* out);
TREELITE_DLL int TreeliteLoadSKLearnRandomForestRegressor(int n_estimators, int n_features,
    int n_targets, int64_t const* node_count, int64_t const** children_left,
    int64_t const** children_right, int64_t const** feature, double const** threshold,
    double const** value, int64_t const** n_node_samples, double const** weighted_n_node_samples,
    double const** impurity, TreeliteModelHandle* out);
TREELITE_DLL int TreeliteLoadSKLearnIsolationForest(int n_estimators, int n_features,
    int64_t const* node_count, int64_t const** children_left, int64_t const** children_right,
    int64_t const** feature, double const** threshold, double const** value,
    int64_t const** n_node_samples, double const** weighted_n_node_samples, double const** impurity,
    double ratio_c, TreeliteModelHandle* out);
TREELITE_DLL int TreeliteLoadSKLearnRandomForestClassifier(int n_estimators, int n_features,
    int n_targets, int32_t const* n_classes, int64_t const* node_count,
    int64_t const** children_left, int64_t const** children_right, int64_t const** feature,
    double const** threshold, double const** value, int64_t const** n_node_samples,
    double const** weighted_n_node_samples, double const** impurity, TreeliteModelHandle* out);
TREELITE_DLL int TreeliteLoadSKLearnGradientBoostingRegressor(int n_iter, int n_features,
    int64_t const* node_count, int64_t const** children_left, int64_t const** children_right,
    int64_t const** feature, double const** threshold, double const** value,
    int64_t const** n_node_samples, double const** weighted_n_node_samples, double const** impurity,
    double const* base_scores, TreeliteModelHandle* out);
TREELITE_DLL int TreeliteLoadSKLearnGradientBoostingClassifier(int n_iter, int n_features,
    int n_classes, int64_t const* node_count, int64_t const** children_left,
    int64_t const** children_right, int64_t const** feature, double const** threshold,
    double const** value, int64_t const** n_node_samples, double const** weighted_n_node_samples,
    double const** impurity, double const* base_scores, TreeliteModelHandle* out);
 
TREELITE_DLL int TreeliteLoadSKLearnHistGradientBoostingRegressor(int n_iter, int n_features,
    int64_t const* node_count, void const** nodes, int expected_sizeof_node_struct,
    uint32_t n_categorical_splits, uint32_t const** raw_left_cat_bitsets,
    uint32_t const* known_cat_bitsets, uint32_t const* known_cat_bitsets_offset_map,
    int32_t const* features_map, int64_t const** categories_map, double const* base_scores,
    TreeliteModelHandle* out);
 
TREELITE_DLL int TreeliteLoadSKLearnHistGradientBoostingClassifier(int n_iter, int n_features,
    int n_classes, int64_t const* node_count, void const** nodes, int expected_sizeof_node_struct,
    uint32_t n_categorical_splits, uint32_t const** raw_left_cat_bitsets,
    uint32_t const* known_cat_bitsets, uint32_t const* known_cat_bitsets_offset_map,
    int32_t const* features_map, int64_t const** categories_map, double const* base_scores,
    TreeliteModelHandle* out);
TREELITE_DLL int TreeliteGetModelBuilder(char const* json_str, TreeliteModelBuilderHandle* out);
TREELITE_DLL int TreeliteDeleteModelBuilder(TreeliteModelBuilderHandle model_builder);
TREELITE_DLL int TreeliteModelBuilderStartTree(TreeliteModelBuilderHandle model_builder);
TREELITE_DLL int TreeliteModelBuilderEndTree(TreeliteModelBuilderHandle model_builder);
TREELITE_DLL int TreeliteModelBuilderStartNode(
    TreeliteModelBuilderHandle model_builder, int node_key);
TREELITE_DLL int TreeliteModelBuilderEndNode(TreeliteModelBuilderHandle model_builder);
TREELITE_DLL int TreeliteModelBuilderNumericalTest(TreeliteModelBuilderHandle model_builder,
    int32_t split_index, double threshold, int default_left, char const* cmp, int left_child_key,
    int right_child_key);
TREELITE_DLL int TreeliteModelBuilderCategoricalTest(TreeliteModelBuilderHandle model_builder,
    int32_t split_index, int default_left, uint32_t const* category_list, size_t category_list_len,
    int category_list_right_child, int left_child_key, int right_child_key);
TREELITE_DLL int TreeliteModelBuilderLeafScalar(
    TreeliteModelBuilderHandle model_builder, double leaf_value);
TREELITE_DLL int TreeliteModelBuilderLeafVectorFloat32(
    TreeliteModelBuilderHandle model_builder, float const* leaf_vector, size_t leaf_vector_len);
TREELITE_DLL int TreeliteModelBuilderLeafVectorFloat64(
    TreeliteModelBuilderHandle model_builder, double const* leaf_vector, size_t leaf_vector_len);
TREELITE_DLL int TreeliteModelBuilderGain(TreeliteModelBuilderHandle model_builder, double gain);
TREELITE_DLL int TreeliteModelBuilderDataCount(
    TreeliteModelBuilderHandle model_builder, uint64_t data_count);
TREELITE_DLL int TreeliteModelBuilderSumHess(
    TreeliteModelBuilderHandle model_builder, double sum_hess);
TREELITE_DLL int TreeliteModelBuilderCommitModel(
    TreeliteModelBuilderHandle model_builder, TreeliteModelHandle* out);
TREELITE_DLL int TreeliteDumpAsJSON(
    TreeliteModelHandle handle, int pretty_print, char const** out_json_str);
TREELITE_DLL int TreeliteGetInputType(TreeliteModelHandle model, char const** out_str);
TREELITE_DLL int TreeliteGetOutputType(TreeliteModelHandle model, char const** out_str);
TREELITE_DLL int TreeliteQueryNumTree(TreeliteModelHandle model, size_t* out);
TREELITE_DLL int TreeliteQueryNumFeature(TreeliteModelHandle model, int* out);
TREELITE_DLL int TreeliteConcatenateModelObjects(
    TreeliteModelHandle const* objs, size_t len, TreeliteModelHandle* out);
TREELITE_DLL int TreeliteFreeModel(TreeliteModelHandle handle);
TREELITE_DLL int TreeliteSerializeModelToFile(TreeliteModelHandle handle, char const* filename);
TREELITE_DLL int TreeliteDeserializeModelFromFile(char const* filename, TreeliteModelHandle* out);
TREELITE_DLL int TreeliteSerializeModelToBytes(
    TreeliteModelHandle handle, char const** out_bytes, size_t* out_bytes_len);
TREELITE_DLL int TreeliteDeserializeModelFromBytes(
    char const* bytes, size_t bytes_len, TreeliteModelHandle* out);
 
TREELITE_DLL int TreeliteSerializeModelToPyBuffer(
    TreeliteModelHandle handle, TreelitePyBufferFrame** out_frames, size_t* out_num_frames);
TREELITE_DLL int TreeliteDeserializeModelFromPyBuffer(
    TreelitePyBufferFrame* frames, size_t num_frames, TreeliteModelHandle* out);
TREELITE_DLL int TreeliteGTILParseConfig(char const* config_json, TreeliteGTILConfigHandle* out);
 
TREELITE_DLL int TreeliteGTILDeleteConfig(TreeliteGTILConfigHandle handle);
 
TREELITE_DLL int TreeliteGTILGetOutputShape(TreeliteModelHandle model, uint64_t num_row,
    TreeliteGTILConfigHandle config, uint64_t const** out, uint64_t* out_ndim);
 
TREELITE_DLL int TreeliteGTILPredict(TreeliteModelHandle model, void const* input,
    char const* input_type, uint64_t num_row, void* output, TreeliteGTILConfigHandle config);
 
TREELITE_DLL int TreeliteGTILPredictSparse(TreeliteModelHandle model, void const* data,
    char const* input_type, uint64_t const* col_ind, uint64_t const* row_ptr, uint64_t num_row,
    void* output, TreeliteGTILConfigHandle config);
 
TREELITE_DLL int TreeliteGetHeaderField(
    TreeliteModelHandle model, char const* name, TreelitePyBufferFrame* out_frame);
TREELITE_DLL int TreeliteGetTreeField(TreeliteModelHandle model, uint64_t tree_id, char const* name,
    TreelitePyBufferFrame* out_frame);
TREELITE_DLL int TreeliteSetHeaderField(
    TreeliteModelHandle model, char const* name, TreelitePyBufferFrame frame);
TREELITE_DLL int TreeliteSetTreeField(
    TreeliteModelHandle model, uint64_t tree_id, char const* name, TreelitePyBufferFrame frame);
TREELITE_DLL char const* TreeliteGetLastError(void);
 
TREELITE_DLL int TreeliteRegisterLogCallback(void (*callback)(char const*));
 
TREELITE_DLL int TreeliteRegisterWarningCallback(void (*callback)(char const*));
 
#ifdef __cplusplus
extern "C" {
extern char const* TREELITE_VERSION;
}
#else
extern char const* TREELITE_VERSION;
#endif
 
#endif  // TREELITE_C_API_H_