Functions
cuml_api.cpp File Reference
#include "cumlHandle.hpp"
#include <cuml/common/utils.hpp>
#include <cuml/cuml_api.h>
#include <raft/util/cudart_utils.hpp>
#include <cstddef>
#include <functional>
Include dependency graph for cuml_api.cpp:

Functions

const char * cumlGetErrorString (cumlError_t error)
 Get a human readable error string for the passed in error code. More...
 
cumlError_t cumlCreate (cumlHandle_t *handle, cudaStream_t stream)
 Creates a cumlHandle_t. More...
 
cumlError_t cumlGetStream (cumlHandle_t handle, cudaStream_t *stream)
 sets the stream to which all cuML work issued via the passed handle should be ordered. More...
 
cumlError_t cumlDestroy (cumlHandle_t handle)
 Release all resource internally managed by cumlHandle_t. More...
 

Function Documentation

◆ cumlCreate()

cumlError_t cumlCreate ( cumlHandle_t handle,
cudaStream_t  stream 
)

Creates a cumlHandle_t.

Parameters
[in,out]handlepointer to the handle to create.
[in]streamthe stream to which cuML work should be ordered.
Returns
CUML_SUCCESS on success,
Todo:
: add more error codes

◆ cumlDestroy()

cumlError_t cumlDestroy ( cumlHandle_t  handle)

Release all resource internally managed by cumlHandle_t.

Parameters
[in,out]handlethe cumlHandle_t to destroy.
Returns
CUML_SUCCESS on success,
Todo:
: add more error codes

◆ cumlGetErrorString()

const char* cumlGetErrorString ( cumlError_t  error)

Get a human readable error string for the passed in error code.

Parameters
[in]errorthe error code to decipher.
Returns
a string with a human readable error message.

◆ cumlGetStream()

cumlError_t cumlGetStream ( cumlHandle_t  handle,
cudaStream_t *  stream 
)

sets the stream to which all cuML work issued via the passed handle should be ordered.

Parameters
[in,out]handlehandle to set the stream for.
[in]streamthe stream to which cuML work should be ordered.
Returns
CUML_SUCCESS on success,
Todo:
: add more error codes