MXNet.Core.Base

Interfaces in core module of MXNet.

Data type definitions

Type alias

type MXUInt = CUInt

Handle size_t type.

MXUint type alias.

type MXFloat = CFloat

MXFloat type alias.

Handlers and Creators

data NDArrayHandle

Handle to NDArray.

Instances

Storable NDArrayHandle

Methods

sizeOf :: NDArrayHandle -> Int

alignment :: NDArrayHandle -> Int

peekElemOff :: Ptr NDArrayHandle -> Int -> IO NDArrayHandle

pokeElemOff :: Ptr NDArrayHandle -> Int -> NDArrayHandle -> IO ()

peekByteOff :: Ptr b -> Int -> IO NDArrayHandle

pokeByteOff :: Ptr b -> Int -> NDArrayHandle -> IO ()

peek :: Ptr NDArrayHandle -> IO NDArrayHandle

poke :: Ptr NDArrayHandle -> NDArrayHandle -> IO ()

data FunctionHandle

Handle to a mxnet narray function that changes NDArray.

Instances

Storable FunctionHandle

Methods

sizeOf :: FunctionHandle -> Int

alignment :: FunctionHandle -> Int

peekElemOff :: Ptr FunctionHandle -> Int -> IO FunctionHandle

pokeElemOff :: Ptr FunctionHandle -> Int -> FunctionHandle -> IO ()

peekByteOff :: Ptr b -> Int -> IO FunctionHandle

pokeByteOff :: Ptr b -> Int -> FunctionHandle -> IO ()

peek :: Ptr FunctionHandle -> IO FunctionHandle

poke :: Ptr FunctionHandle -> FunctionHandle -> IO ()

data AtomicSymbolCreator

Handle to a function that takes param and creates symbol.

Instances

Storable AtomicSymbolCreator

Methods

sizeOf :: AtomicSymbolCreator -> Int

alignment :: AtomicSymbolCreator -> Int

peekElemOff :: Ptr AtomicSymbolCreator -> Int -> IO AtomicSymbolCreator

pokeElemOff :: Ptr AtomicSymbolCreator -> Int -> AtomicSymbolCreator -> IO ()

peekByteOff :: Ptr b -> Int -> IO AtomicSymbolCreator

pokeByteOff :: Ptr b -> Int -> AtomicSymbolCreator -> IO ()

peek :: Ptr AtomicSymbolCreator -> IO AtomicSymbolCreator

poke :: Ptr AtomicSymbolCreator -> AtomicSymbolCreator -> IO ()

data SymbolHandle

Handle to a symbol that can be bind as operator.

Instances

Storable SymbolHandle

Methods

sizeOf :: SymbolHandle -> Int

alignment :: SymbolHandle -> Int

peekElemOff :: Ptr SymbolHandle -> Int -> IO SymbolHandle

pokeElemOff :: Ptr SymbolHandle -> Int -> SymbolHandle -> IO ()

peekByteOff :: Ptr b -> Int -> IO SymbolHandle

pokeByteOff :: Ptr b -> Int -> SymbolHandle -> IO ()

peek :: Ptr SymbolHandle -> IO SymbolHandle

poke :: Ptr SymbolHandle -> SymbolHandle -> IO ()

data AtomicSymbolHandle

Handle to a AtomicSymbol.

Instances

Storable AtomicSymbolHandle

Methods

sizeOf :: AtomicSymbolHandle -> Int

alignment :: AtomicSymbolHandle -> Int

peekElemOff :: Ptr AtomicSymbolHandle -> Int -> IO AtomicSymbolHandle

pokeElemOff :: Ptr AtomicSymbolHandle -> Int -> AtomicSymbolHandle -> IO ()

peekByteOff :: Ptr b -> Int -> IO AtomicSymbolHandle

pokeByteOff :: Ptr b -> Int -> AtomicSymbolHandle -> IO ()

peek :: Ptr AtomicSymbolHandle -> IO AtomicSymbolHandle

poke :: Ptr AtomicSymbolHandle -> AtomicSymbolHandle -> IO ()

data ExecutorHandle

Instances

Storable ExecutorHandle

Handle to an Executor.

Methods

sizeOf :: ExecutorHandle -> Int

alignment :: ExecutorHandle -> Int

peekElemOff :: Ptr ExecutorHandle -> Int -> IO ExecutorHandle

pokeElemOff :: Ptr ExecutorHandle -> Int -> ExecutorHandle -> IO ()

peekByteOff :: Ptr b -> Int -> IO ExecutorHandle

pokeByteOff :: Ptr b -> Int -> ExecutorHandle -> IO ()

peek :: Ptr ExecutorHandle -> IO ExecutorHandle

poke :: Ptr ExecutorHandle -> ExecutorHandle -> IO ()

data DataIterCreator

Handle a dataiter creator.

Instances

Storable DataIterCreator

Methods

sizeOf :: DataIterCreator -> Int

alignment :: DataIterCreator -> Int

peekElemOff :: Ptr DataIterCreator -> Int -> IO DataIterCreator

pokeElemOff :: Ptr DataIterCreator -> Int -> DataIterCreator -> IO ()

peekByteOff :: Ptr b -> Int -> IO DataIterCreator

pokeByteOff :: Ptr b -> Int -> DataIterCreator -> IO ()

peek :: Ptr DataIterCreator -> IO DataIterCreator

poke :: Ptr DataIterCreator -> DataIterCreator -> IO ()

data DataIterHandle

Handle to a DataIterator.

Instances

Storable DataIterHandle

Methods

sizeOf :: DataIterHandle -> Int

alignment :: DataIterHandle -> Int

peekElemOff :: Ptr DataIterHandle -> Int -> IO DataIterHandle

pokeElemOff :: Ptr DataIterHandle -> Int -> DataIterHandle -> IO ()

peekByteOff :: Ptr b -> Int -> IO DataIterHandle

pokeByteOff :: Ptr b -> Int -> DataIterHandle -> IO ()

peek :: Ptr DataIterHandle -> IO DataIterHandle

poke :: Ptr DataIterHandle -> DataIterHandle -> IO ()

data KVStoreHandle

Handle to KVStore.

Instances

Storable KVStoreHandle

Methods

sizeOf :: KVStoreHandle -> Int

alignment :: KVStoreHandle -> Int

peekElemOff :: Ptr KVStoreHandle -> Int -> IO KVStoreHandle

pokeElemOff :: Ptr KVStoreHandle -> Int -> KVStoreHandle -> IO ()

peekByteOff :: Ptr b -> Int -> IO KVStoreHandle

pokeByteOff :: Ptr b -> Int -> KVStoreHandle -> IO ()

peek :: Ptr KVStoreHandle -> IO KVStoreHandle

poke :: Ptr KVStoreHandle -> KVStoreHandle -> IO ()

data RecordIOHandle

Handle to RecordIO.

Instances

Storable RecordIOHandle

Methods

sizeOf :: RecordIOHandle -> Int

alignment :: RecordIOHandle -> Int

peekElemOff :: Ptr RecordIOHandle -> Int -> IO RecordIOHandle

pokeElemOff :: Ptr RecordIOHandle -> Int -> RecordIOHandle -> IO ()

peekByteOff :: Ptr b -> Int -> IO RecordIOHandle

pokeByteOff :: Ptr b -> Int -> RecordIOHandle -> IO ()

peek :: Ptr RecordIOHandle -> IO RecordIOHandle

poke :: Ptr RecordIOHandle -> RecordIOHandle -> IO ()

data RtcHandle

Handle to MXRtc.

Instances

Storable RtcHandle

Methods

sizeOf :: RtcHandle -> Int

alignment :: RtcHandle -> Int

peekElemOff :: Ptr RtcHandle -> Int -> IO RtcHandle

pokeElemOff :: Ptr RtcHandle -> Int -> RtcHandle -> IO ()

peekByteOff :: Ptr b -> Int -> IO RtcHandle

pokeByteOff :: Ptr b -> Int -> RtcHandle -> IO ()

peek :: Ptr RtcHandle -> IO RtcHandle

poke :: Ptr RtcHandle -> RtcHandle -> IO ()

Callback types

data ExecutorMonitorCallback

Callback: ExecutorMonitorCallback.

data CustomOpPropCreator

Callback: CustomOpPropCreator.

type MXKVStoreUpdater

Arguments

 = Int

The key.

-> NDArrayHandle

The pushed value on the key.

-> NDArrayHandle

The value stored on local on the key.

-> Ptr ()

The additional handle to the updater.

-> IO Int

Callback: MXKVStoreUpdater, user-defined updater for the kvstore.

type MXKVStoreServerController

Arguments

 = Int

The head of the command.

-> Ptr CChar

The body of the command.

-> Ptr ()

Helper handle for implementing controller.

-> IO Int

Callback: MXKVStoreServerController, the prototype of a server controller.

Error handling.

mxGetLastError :: IO String

Handle size_t type.

Get the string message of last error.

Global State setups

mxRandomSeed :: Int -> IO Int

Seed the global random number generators in mxnet.

mxNotifyShutdown :: IO Int

Notify the engine about a shutdown.

mxSetProfilerConfig

Arguments

:: Int

Mode, indicate the working mode of profiler, record anly symbolic operator when mode == 0, record all operator when mode == 1.

-> String

Filename, where to save trace file.

-> IO Int

Set up configuration of profiler.

mxSetProfilerState

Arguments

:: Int

State, indicate the working state of profiler, profiler not running when state == 0, profiler running when state == 1.

-> IO Int

Set up state of profiler.

mxDumpProfile :: IO Int

Save profile and stop profiler.

NDArray creation and deletion

mxNDArrayCreateNone

Arguments

:: IO (Int, NDArrayHandle)

The returned NDArrayHandle.

Create a NDArray handle that is not initialized.

mxNDArrayCreate

Arguments

:: [MXUInt]

The shape of NDArray.

-> MXUInt

The dimension of the shape.

-> Int

Device type, specify device we want to take.

-> Int

The device id of the specific device.

-> Int

Whether to delay allocation until.

-> IO (Int, NDArrayHandle)

The returing handle.

Create a NDArray with specified shape.

mxNDArrayCreateEx

Arguments

:: [MXUInt]

-> MXUInt

-> Int

Device type, specify device we want to take.

-> Int

The device id of the specific device.

-> Int

Whether to delay allocation until.

-> Int

Data type of created array.

-> IO (Int, NDArrayHandle)

The returing handle.

Create a NDArray with specified shape and data type.

mxNDArrayLoadFromRawBytes

Arguments

:: Ptr ()

The head of the raw bytes.

-> CSize

Size of the raw bytes.

-> IO (Int, NDArrayHandle)

Create a NDArray handle that is loaded from raw bytes.

mxNDArraySaveRawBytes

Arguments

:: NDArrayHandle

The NDArray handle.

-> IO (Int, CSize, Ptr CChar)

Save the NDArray into raw bytes.

mxNDArraySave

Arguments

:: String

Name of the file.

-> MXUInt

Number of arguments to save.

-> [NDArrayHandle]

the array of NDArrayHandles to be saved.

-> [String]

names of the NDArrays to save.

-> IO Int

Save list of narray into the file.

mxNDArrayLoad

Arguments

:: String

Name of the file.

-> IO (Int, MXUInt, [NDArrayHandle], MXUInt, [String])

The size of ndarray handles, ndarray handles the number of names and the returned names.

Load list of narray from the file.

mxNDArraySyncCopyFromCPU

Arguments

:: NDArrayHandle

The NDArrayHandle.

-> Ptr ()

The raw data source to copy from.

-> CSize

The memory size want to copy from.

-> IO Int

Perform a synchronize copy from a continugous CPU memory region. This is useful to copy data from existing memory region that are not wrapped by NDArray (thus dependency not being tracked).

mxNDArraySyncCopyToCPU

Arguments

:: NDArrayHandle

The NDArrayHandle.

-> Ptr ()

The raw data source to copy into.

-> CSize

The memory size want to copy into.

-> IO Int

Perform a synchronize copy to a continugous CPU memory region.

mxNDArrayWaitToRead :: NDArrayHandle -> IO Int

Wait until all the pending writes with respect NDArray are finished.

mxNDArrayWaitToWrite :: NDArrayHandle -> IO Int

Wait until all the pending read/write with respect NDArray are finished.

mxNDArrayWaitAll :: IO Int

Wait until all delayed operations in the system is completed.

mxNDArrayFree :: NDArrayHandle -> IO Int

Free the narray handle.

mxNDArraySlice

Arguments

:: NDArrayHandle

The handle to the NDArray.

-> MXUInt

The beginning index of slice.

-> MXUInt

The ending index of slice.

-> IO (Int, NDArrayHandle)

The NDArrayHandle of sliced NDArray.

Slice the NDArray along axis 0.

mxNDArrayAt

Arguments

:: NDArrayHandle

The handle to the NDArray.

-> MXUInt

The index.

-> IO (Int, NDArrayHandle)

The NDArrayHandle of output NDArray.

Index the NDArray along axis 0.

mxNDArrayReshape

Arguments

:: NDArrayHandle

The handle to the NDArray.

-> Int

Number of dimensions of new shape.

-> [Int]

New sizes of every dimension.

-> IO (Int, NDArrayHandle)

The new shape data and the NDArrayHandle of reshaped NDArray.

Reshape the NDArray.

mxNDArrayGetShape

Arguments

:: NDArrayHandle

-> IO (Int, MXUInt, [MXUInt])

The output dimension and it's shape.

mxNDArrayGetData

Arguments

:: NDArrayHandle

The NDArray handle.

-> IO (Int, Ptr MXFloat)

Pointer holder to get pointer of data.

Get the content of the data in NDArray.

mxNDArrayGetDType

Arguments

:: NDArrayHandle

The NDArray handle.

-> IO (Int, Int)

The type of data in this NDArray handle.

Get the type of the data in NDArray

mxNDArrayGetContext

Arguments

:: NDArrayHandle

The NDArray handle.

-> IO (Int, Int, Int)

The device type and device id.

Get the context of the NDArray.

Functions on NDArray

mxListFunctions

Arguments

:: IO (Int, MXUInt, [FunctionHandle])

The output function handle array.

List all the available functions handles.

mxGetFunction

Arguments

:: String

The name of the function.

-> IO (Int, FunctionHandle)

The corresponding function handle.

Get the function handle by name.

mxFuncGetInfo

Arguments

:: FunctionHandle

The target function handle.

-> IO (Int, String, String, MXUInt, [String], [String], [String], String)

The name of returned function, it's description, the number of it's arguments, argument name, type and descriptions, as well as the return type of this function.

Get the information of the function handle.

mxFuncDescribe

Arguments

:: FunctionHandle

-> IO (Int, MXUInt, MXUInt, MXUInt, Int)

The number of NDArrays, scalar variables and mutable NDArrays to be passed in, and the type mask of this function.

Get the argument requirements of the function.

mxFuncInvoke

Arguments

:: FunctionHandle

The function to invoke.

-> [NDArrayHandle]

The normal NDArrays arguments.

-> [MXFloat]

The scalar arguments.

-> [NDArrayHandle]

The mutable NDArrays arguments.

-> IO Int

Invoke a function, the array size of passed in arguments must match the values in the fun function.

mxFuncInvokeEx

Arguments

:: FunctionHandle

The function to invoke.

-> [NDArrayHandle]

The normal NDArrays arguments.

-> [MXFloat]

The scalar arguments.

-> [NDArrayHandle]

The mutable NDArrays arguments.

-> Int

Number of keyword parameters.

-> [String]

Keys for keyword parameters.

-> [String]

Values for keyword parameters.

-> IO Int

Invoke a function, the array size of passed in arguments must match the values in the fun function.

mxImperativeInvoke :: a

Invoke a nnvm op and imperative function. FIXME

Symbolic configuration generation

mxSymbolListAtomicSymbolCreators

Arguments

:: IO (Int, MXUInt, [AtomicSymbolCreator])

The number of atomic symbol creators and the atomic symbol creators list.

List all the available AtomicSymbolCreator.

mxSymbolGetAtomicSymbolName

Arguments

:: AtomicSymbolCreator

-> IO (Int, String)

Name of the target atomic symbol.

Get the name of an atomic symbol.

mxSymbolGetAtomicSymbolInfo

Arguments

:: AtomicSymbolCreator

-> [String]

TODO document for this argument. The keyword arguments for specifying variable number of arguments.

-> IO (Int, String, String, MXUInt, [String], [String], [String], String)

Return the name and description of the symbol, the name, type and description of it's arguments, as well as the return type of this symbol.

Get the detailed information about atomic symbol.

mxSymbolCreateAtomicSymbol

Arguments

:: AtomicSymbolCreator

The atomic symbol creator.

-> MXUInt

The number of parameters.

-> [String]

The keys of the parameters.

-> [String]

The values of the parameters.

-> IO (Int, SymbolHandle)

The created symbol.

Create an AtomicSymbol.

mxSymbolCreateVariable

Arguments

:: String

Name of the variable.

-> IO (Int, SymbolHandle)

The created variable symbol.

Create a Variable Symbol.

mxSymbolCreateGroup

Arguments

:: MXUInt

Number of symbols to be grouped.

-> [SymbolHandle]

-> IO (Int, SymbolHandle)

The created symbol group.

Create a Symbol by grouping list of symbols together.

mxSymbolCreateFromFile

Arguments

:: String

The file name

-> IO (Int, SymbolHandle)

Load a symbol from a json file.

mxSymbolCreateFromJSON

Arguments

:: String

The json string.

-> IO (Int, SymbolHandle)

Load a symbol from a json string.

mxSymbolSaveToFile

Arguments

:: SymbolHandle

The symbol to save.

-> String

The target file name.

-> IO Int

Save a symbol into a json file.

mxSymbolSaveToJSON

Arguments

:: SymbolHandle

The symbol to save.

-> IO (Int, String)

The result json string.

Save a symbol into a json string.

mxSymbolFree :: SymbolHandle -> IO Int

Free the symbol handle.

mxSymbolCopy :: SymbolHandle -> IO (Int, SymbolHandle)

Copy the symbol to another handle.

mxSymbolPrint

Arguments

:: SymbolHandle

The symbol handle to print.

-> IO (Int, String)

Print the content of symbol, used for debug.

mxSymbolGetName

Arguments

:: SymbolHandle

-> IO (Int, String, Int)

The name of the symbol and whether the call is successful.

Get string name from symbol

mxSymbolGetAttr

Arguments

:: SymbolHandle

The source symbol.

-> String

The key of this attribute.

-> IO (Int, String, Int)

The value of this attribute and whether the call is successful.

Get string attribute from symbol.

mxSymbolSetAttr

Arguments

:: SymbolHandle

The source symbol.

-> String

The name of the attribute.

-> String

The value of the attribute.

-> IO Int

Set string attribute from symbol. Setting attribute to a symbol can affect the semantics (mutable/immutable) of symbolic graph.

mxSymbolListAttr

Arguments

:: SymbolHandle

-> IO (Int, MXUInt, [String])

The number of attributes and attributes list.

Get all attributes from symbol, including all descendents.

mxSymbolListAttrShallow

Arguments

:: SymbolHandle

-> IO (Int, MXUInt, [String])

The number of attributes and attributes list.

Get all attributes from symbol, excluding descendents.

mxSymbolListArguments

Arguments

:: SymbolHandle

-> IO (Int, MXUInt, [String])

The number of arguments and list of arguments' names.

List arguments in the symbol.

mxSymbolListOutputs

Arguments

:: SymbolHandle

-> IO (Int, MXUInt, [String])

The number of outputs and list of outputs' names.

List returns in the symbol.

mxSymbolGetInternals

Arguments

:: SymbolHandle

-> IO (Int, SymbolHandle)

The output symbol whose outputs are all the internals.

Get a symbol that contains all the internals.

mxSymbolGetOutput

Arguments

:: SymbolHandle

The symbol.

-> MXUInt

Index of the output.

-> IO (Int, SymbolHandle)

The output symbol whose outputs are the index-th symbol.

Get index-th outputs of the symbol.

mxSymbolListAuxiliaryStates

Arguments

:: SymbolHandle

-> IO (Int, MXUInt, [String])

The output size and the output string array.

List auxiliary states in the symbol.

mxSymbolCompose

Arguments

:: SymbolHandle

The symbol to apply.

-> String

Name of the symbol.

-> MXUInt

Number of arguments.

-> [String]

Key of keyword arguments, optional.

-> [SymbolHandle]

Arguments.

-> IO Int

Compose the symbol on other symbols.

mxSymbolGrad

Arguments

:: SymbolHandle

The symbol to get gradient.

-> MXUInt

Number of arguments to get gradient.

-> [String]

Names of the arguments to get gradient.

-> IO (Int, SymbolHandle)

Return the symbol that has gradient.

Get the gradient graph of the symbol.

mxSymbolInferShape

Arguments

:: SymbolHandle

Symbol handle.

-> MXUInt

Number of input arguments.

-> [String]

Number of input arguments.

-> Ptr MXUInt

Keys of keyword arguments, optional.

-> Ptr MXUInt

The head pointer of the rows in CSR

-> IO (Int, (MXUInt, [MXUInt], [Ptr MXUInt]), (MXUInt, [MXUInt], [Ptr MXUInt]), (MXUInt, [MXUInt], [Ptr MXUInt]), Int)

Return the in, out and auxiliary shape size, ndim and data (array of pointers to head of the input shape), and whether infer shape completes or more information is needed.

Infer shape of unknown input shapes given the known one.

mxSymbolInferShapePartial

Arguments

:: SymbolHandle

Symbol handle.

-> MXUInt

Number of input arguments.

-> [String]

Number of input arguments.

-> Ptr MXUInt

Keys of keyword arguments, optional.

-> Ptr MXUInt

The head pointer of the rows in CSR

-> IO (Int, (MXUInt, [MXUInt], [Ptr MXUInt]), (MXUInt, [MXUInt], [Ptr MXUInt]), (MXUInt, [MXUInt], [Ptr MXUInt]), Int)

Return the in, out and auxiliary array's shape size, ndim and data (array of pointers to head of the input shape), and whether infer shape completes or more information is needed.

Partially infer shape of unknown input shapes given the known one.

mxSymbolInferType

Arguments

:: SymbolHandle

Symbol handle.

-> MXUInt

Number of input arguments.

-> [String]

Key of keyword arguments, optional.

-> Ptr CInt

The content of the CSR.

-> IO (Int, MXUInt, MXUInt, MXUInt, Int)

Return the size and an array of pointers to head the input, output and auxiliary type, as well as whether infer type completes or more information is needed.

Infer type of unknown input types given the known one.

Executor interface

mxExecutorFree

Arguments

:: ExecutorHandle

The executor handle.

-> IO Int

Delete the executor.

mxExecutorPrint

Arguments

:: ExecutorHandle

The executor handle.

-> IO (Int, String)

Print the content of execution plan, used for debug.

mxExecutorForward

Arguments

:: ExecutorHandle

The executor handle.

-> Int

int value to indicate whether the forward pass is for evaluation.

-> IO Int

Executor forward method.

mxExecutorBackward

Arguments

:: ExecutorHandle

The executor handle.

-> MXUInt

Length.

-> [NDArrayHandle]

NDArray handle for heads' gradient.

-> IO Int

Excecutor run backward.

mxExecutorOutputs

Arguments

:: ExecutorHandle

The executor handle.

-> IO (Int, [NDArrayHandle])

The handles for outputs.

Get executor's head NDArray.

mxExecutorBind

Arguments

:: SymbolHandle

The symbol handle.

-> Int

Device type.

-> Int

Device id.

-> MXUInt

Length of arrays in arguments.

-> [NDArrayHandle]

In array.

-> [NDArrayHandle]

Grads handle array.

-> [MXUInt]

Grad req array.

-> MXUInt

Length of auxiliary states.

-> [NDArrayHandle]

Auxiliary states array.

-> IO (Int, ExecutorHandle)

Generate Executor from symbol.

mxExecutorBindX

Arguments

:: SymbolHandle

The symbol handle.

-> Int

Device type of default context.

-> Int

Device id of default context.

-> MXUInt

Size of group2ctx map.

-> [String]

Keys of group2ctx map.

-> [Int]

Device type of group2ctx map.

-> [Int]

Device id of group2ctx map.

-> MXUInt

Length of arrays in arguments.

-> [NDArrayHandle]

In array.

-> [NDArrayHandle]

Grads handle array.

-> [MXUInt]

Grad req array.

-> MXUInt

Length of auxiliary states.

-> [NDArrayHandle]

Auxiliary states array.

-> IO (Int, ExecutorHandle)

Generate Executor from symbol. This is advanced function, allow specify group2ctx map. The user can annotate "ctx_group" attribute to name each group.

mxExecutorBindEX

Arguments

:: SymbolHandle

The symbol handle.

-> Int

Device type of default context.

-> Int

Device id of default context.

-> MXUInt

Size of group2ctx map.

-> [String]

Keys of group2ctx map.

-> [Int]

Device type of group2ctx map.

-> [Int]

Device id of group2ctx map.

-> MXUInt

Length of arrays in arguments.

-> [NDArrayHandle]

In array.

-> [NDArrayHandle]

Grads handle array.

-> [MXUInt]

Grad req array.

-> MXUInt

Length of auxiliary states.

-> [NDArrayHandle]

Auxiliary states array.

-> ExecutorHandle

Input executor handle for memory sharing.

-> IO (Int, ExecutorHandle)

Generate Executor from symbol. This is advanced function, allow specify group2ctx map. The user can annotate "ctx_group" attribute to name each group.

mxExecutorSetMonitorCallback

Arguments

:: ExecutorHandle

The executor handle.

-> ExecutorMonitorCallback

-> Ptr ()

-> IO Int

Set a call back to notify the completion of operation.

IO Interface

mxListDataIters

Arguments

:: IO (Int, [DataIterCreator])

The output iterator entries.

List all the available iterator entries.

mxDataIterCreateIter

Arguments

:: DataIterCreator

The handle pointer to the data iterator.

-> MXUInt

Size of arrays in arguments.

-> [String]

Parameter keys.

-> [String]

Parameter values.

-> IO (Int, DataIterHandle)

Init an iterator, init with parameters the array size of passed in arguments.

mxDataIterGetIterInfo

Arguments

:: DataIterCreator

The handle pointer to the data iterator.

-> IO (Int, String, String, MXUInt, [String], [String], [String])

Return the name and description of the data iter creator, the name, type and description of it's arguments, as well as the return type of this symbol.

Get the detailed information about data iterator.

mxDataIterFree

Arguments

:: DataIterHandle

The handle pointer to the data iterator.

-> IO Int

Get the detailed information about data iterator.

Free the handle to the IO module.

mxDataIterNext

Arguments

:: DataIterHandle

The handle pointer to the data iterator.

-> IO (Int, Int)

Move iterator to next position.

mxDataIterBeforeFirst

Arguments

:: DataIterHandle

The handle pointer to the data iterator.

-> IO Int

Call iterator.Reset.

mxDataIterGetData

Arguments

:: DataIterHandle

The handle pointer to the data iterator.

-> IO (Int, NDArrayHandle)

Get the handle to the NDArray of underlying data.

mxDataIterGetIndex

Arguments

:: DataIterHandle

The handle pointer to the data iterator.

-> IO (Int, [CULong])

Output indices of the array.

Get the image index by array.

mxDataIterGetPadNum

Arguments

:: DataIterHandle

The handle pointer to the data iterator.

-> IO (Int, Int)

Get the padding number in current data batch.

mxDataIterGetLabel

Arguments

:: DataIterHandle

The handle pointer to the data iterator.

-> IO (Int, NDArrayHandle)

Get the handle to the NDArray of underlying label.

Basic KVStore interface

mxInitPSEnv

Arguments

:: MXUInt

Number of variables to initialize.

-> [String]

Environment keys.

-> [String]

Environment values.

-> IO Int

Initialized ps-lite environment variables.

mxKVStoreCreate

Arguments

:: String

The type of KVStore.

-> IO (Int, KVStoreHandle)

Create a kvstore.

mxKVStoreFree

Arguments

:: KVStoreHandle

Handle to the kvstore.

-> IO Int

Delete a KVStore handle.

mxKVStoreInit

Arguments

:: KVStoreHandle

Handle to the kvstore.

-> MXUInt

The number of key-value pairs.

-> [Int]

The list of keys.

-> [NDArrayHandle]

The list of values.

-> IO Int

Init a list of (key,value) pairs in kvstore.

mxKVStorePush

Arguments

:: KVStoreHandle

Handle to the kvstore.

-> MXUInt

The number of key-value pairs.

-> [Int]

The list of keys.

-> [NDArrayHandle]

The list of values.

-> Int

The priority of the action.

-> IO Int

Push a list of (key,value) pairs to kvstore.

mxKVStorePull

Arguments

:: KVStoreHandle

Handle to the kvstore.

-> MXUInt

The number of key-value pairs.

-> [Int]

The list of keys.

-> [NDArrayHandle]

The list of values.

-> Int

The priority of the action.

-> IO Int

FIXME Pull a list of (key, value) pairs from the kvstore.

mxKVStoreSetUpdater :: a

FIXME Register an push updater.

mxKVStoreGetType

Arguments

:: KVStoreHandle

Handle to the KVStore.

-> IO (Int, String)

Get the type of the kvstore.

Advanced KVStore for multi-machines

mxKVStoreGetRank

Arguments

:: KVStoreHandle

Handle to the KVStore.

-> IO (Int, Int)

The rank of this node in its group, which is in [0, GroupSize).

mxKVStoreGetGroupSize

Arguments

:: KVStoreHandle

Handle to the KVStore.

-> IO (Int, Int)

The number of nodes in this group, which is

• number of workers if if `IsWorkerNode() == true`,
• number of servers if if `IsServerNode() == true`,
• 1 if `IsSchedulerNode() == true`.

mxKVStoreIsWorkerNode :: IO (Int, Int)

Return whether or not this process is a worker node.

mxKVStoreIsServerNode :: IO (Int, Int)

Return whether or not this process is a server node.

mxKVStoreIsSchedulerNode :: IO (Int, Int)

Return whether or not this process is a scheduler node.

mxKVStoreBarrier

Arguments

:: KVStoreHandle

Handle to the KVStore.

-> IO Int

Global barrier among all worker machines.

mxKVStoreSetBarrierBeforeExit

Arguments

:: KVStoreHandle

Handle to the KVStore.

-> Int

Whether to do barrier when kvstore finalize

-> IO Int

Whether to do barrier when finalize.

mxKVStoreRunServer :: a

FIXME Run as server (or scheduler).

mxKVStoreSendCommmandToServers

Arguments

:: KVStoreHandle

Handle to the KVStore.

-> Int

The head of the command.

-> String

The body of the command.

-> IO Int

Send a command to all server nodes.

mxKVStoreGetNumDeadNode

Arguments

:: KVStoreHandle

Handle to the kvstore.

-> Int

node id, can be a node group or a single node. kScheduler = 1, kServerGroup = 2, kWorkerGroup = 4

-> Int

A node fails to send heartbeart in {timeout_sec} seconds will be presumed as dead

-> IO (Int, Int)

Get the number of ps dead node(s) specified by {node_id}.

mxRecordIOWriterCreate

Arguments

:: String

Path to file.

-> IO (Int, RecordIOHandle)

Create a RecordIO writer object.

mxRecordIOWriterFree

Arguments

:: RecordIOHandle

Handle to RecordIO object.

-> IO Int

Delete a RecordIO writer object.

mxRecordIOWriterWriteRecord

Arguments

:: RecordIOHandle

Handle to RecordIO object.

-> Ptr CChar

Buffer to write.

-> CSize

Size of buffer.

-> IO Int

Write a record to a RecordIO object.

mxRecordIOWriterTell

Arguments

:: RecordIOHandle

Handle to RecordIO object.

-> Ptr CSize

Handle to output position.

-> IO Int

Get the current writer pointer position.

mxRecordIOReaderCreate

Arguments

:: String

Path to file.

-> IO (Int, RecordIOHandle)

Create a RecordIO reader object.

mxRecordIOReaderFree

Arguments

:: RecordIOHandle

Handle to RecordIO object.

-> IO Int

Delete a RecordIO reader object.

mxRecordIOReaderReadRecord

Arguments

:: RecordIOHandle

Handle to RecordIO object.

-> Ptr (Ptr CChar)

Pointer to return buffer.

-> IO (Int, CSize)

Write a record to a RecordIO object.

mxRecordIOReaderSeek

Arguments

:: RecordIOHandle

Handle to RecordIO object.

-> CSize

Target position.

-> IO Int

Set the current reader pointer position.

mxRtcCreate

Arguments

:: String

Name.

-> MXUInt

Number of inputs.

-> MXUInt

Number of outputs.

-> [String]

Input names.

-> [String]

Output names.

-> [NDArrayHandle]

Inputs.

-> [NDArrayHandle]

Outputs.

-> Ptr CChar

Kernel.

-> IO (Int, RtcHandle)

Create a MXRtc object.

mxRtcPush

Arguments

:: RtcHandle

Handle.

-> MXUInt

Number of inputs.

-> MXUInt

Number of outputs.

-> [NDArrayHandle]

Inputs.

-> [NDArrayHandle]

Outputs.

-> MXUInt

Grid dim x

-> MXUInt

Grid dim y

-> MXUInt

Grid dim z

-> MXUInt

Block dim x

-> MXUInt

Block dim y

-> MXUInt

Block dim z

-> IO Int

Run cuda kernel.

mxRtcFree :: RtcHandle -> IO Int

Delete a MXRtc object.

mxCustomOpRegister

Arguments

:: String

op type.

-> CustomOpPropCreator

-> IO Int