C API: Functions to serialize model objects

Functions
int	TreeliteSerializeModelToFile (TreeliteModelHandle handle, char const *filename)
	Serialize (persist) a model object to disk. More...
int	TreeliteDeserializeModelFromFile (char const *filename, TreeliteModelHandle *out)
	Deserialize (load) a model object from disk. More...
int	TreeliteSerializeModelToBytes (TreeliteModelHandle handle, char const **out_bytes, size_t *out_bytes_len)
	Serialize (persist) a model object to a byte sequence. More...
int	TreeliteDeserializeModelFromBytes (char const *bytes, size_t bytes_len, TreeliteModelHandle *out)
	Deserialize (load) a model object from a byte sequence. More...
int	TreeliteSerializeModelToPyBuffer (TreeliteModelHandle handle, TreelitePyBufferFrame **out_frames, size_t *out_num_frames)
	Serialize a model object using the Python buffer protocol (PEP 3118). More...
int	TreeliteDeserializeModelFromPyBuffer (TreelitePyBufferFrame *frames, size_t num_frames, TreeliteModelHandle *out)
	Deserialize a model object using the Python buffer protocol (PEP 3118). More...

Detailed Description

Function Documentation

TreeliteDeserializeModelFromBytes()

int TreeliteDeserializeModelFromBytes	(	char const *	bytes,
		size_t	bytes_len,
		TreeliteModelHandle *	out
	)

Deserialize (load) a model object from a byte sequence.

Parameters

bytes	Byte sequence containing serialized model. The string should be created by a call to TreeliteSerializeModelToBytes.
bytes_len	Length of bytes
out	Loaded model

Returns

0 for success, -1 for failure

TreeliteDeserializeModelFromFile()

int TreeliteDeserializeModelFromFile	(	char const *	filename,
		TreeliteModelHandle *	out
	)

Deserialize (load) a model object from disk.

Parameters

filename	Name of the file from which to deserialize the model. The file should be created by a call to TreeliteSerializeModelToFile.
out	Handle to the model object

Returns

0 for success, -1 for failure

TreeliteDeserializeModelFromPyBuffer()

int TreeliteDeserializeModelFromPyBuffer	(	TreelitePyBufferFrame *	frames,
		size_t	num_frames,
		TreeliteModelHandle *	out
	)

Deserialize a model object using the Python buffer protocol (PEP 3118).

Parameters

frames	Buffer frames
num_frames	Number of buffer frames
out	Loaded model

Returns

0 for success, -1 for failure

TreeliteSerializeModelToBytes()

int TreeliteSerializeModelToBytes	(	TreeliteModelHandle	handle,
		char const **	out_bytes,
		size_t *	out_bytes_len
	)

Serialize (persist) a model object to a byte sequence.

Parameters

handle	Handle to the model object
out_bytes	Byte sequence containing serialized model
out_bytes_len	Length of out_bytes

Returns

0 for success, -1 for failure

TreeliteSerializeModelToFile()

int TreeliteSerializeModelToFile	(	TreeliteModelHandle	handle,
		char const *	filename
	)

Serialize (persist) a model object to disk.

Parameters

handle	Handle to the model object
filename	Name of the file to which to serialize the model. The file will be using a binary format that's optimized to store the Treelite model object efficiently.

Returns

0 for success, -1 for failure

TreeliteSerializeModelToPyBuffer()

int TreeliteSerializeModelToPyBuffer	(	TreeliteModelHandle	handle,
		TreelitePyBufferFrame **	out_frames,
		size_t *	out_num_frames
	)

Serialize a model object using the Python buffer protocol (PEP 3118).

Parameters

handle	Handle to the model object
out_frames	Pointer to buffer frames
out_num_frames	Number of buffer frames

Returns

0 for success, -1 for failure