org.apache.tvm.rpc

Class RPCSession

java.lang.Object

org.apache.tvm.rpc.RPCSession

public class RPCSession
extends Object

RPC Client session module. Do not directly create the object, use Client.connect.

Method Summary

Modifier and Type	Method and Description
TVMContext	cl() Construct remote OpenCL device.
TVMContext	cl(int devId) Construct remote OpenCL device.
TVMContext	context(int devType) Construct a remote context.
TVMContext	context(int devType, int devId) Construct a remote context.
TVMContext	context(String devType) Construct a remote context.
TVMContext	context(String devType, int devId) Construct a remote context.
TVMContext	cpu() Construct remote CPU device.
TVMContext	cpu(int devId) Construct remote CPU device.
byte[]	download(String path) Download file from remote temp folder.
Function	getFunction(String name) Get function from the session.
TVMContext	gpu() Construct remote GPU device.
TVMContext	gpu(int devId) Construct remote GPU device.
Module	loadModule(String path) Load a remote module, the file need to be uploaded first.
TVMContext	metal() Construct remote Metal device.
TVMContext	metal(int devId) Construct remote Metal device.
void	upload(byte[] data, String target) Upload binary to remote runtime temp folder.
void	upload(File data) Upload file to remote runtime temp folder.
void	upload(File data, String target) Upload file to remote runtime temp folder.
TVMContext	vulkan() Construct remote OpenCL device.
TVMContext	vulkan(int devId) Construct remote OpenCL device.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getFunction

public Function getFunction(String name)

Get function from the session.

Parameters:

name - The name of the function.

Returns:

The result function.

context

public TVMContext context(String devType,
                          int devId)

Construct a remote context.

Parameters:

devType - device type.

devId - device id.

Returns:

The corresponding encoded remote context.

context

public TVMContext context(String devType)

Construct a remote context.

Parameters:

devType - device type.

Returns:

The corresponding encoded remote context.

context

public TVMContext context(int devType,
                          int devId)

Construct a remote context.

Parameters:

devType - device type.

devId - device id.

Returns:

The corresponding encoded remote context.

context

public TVMContext context(int devType)

Construct a remote context.

Parameters:

devType - device type.

Returns:

The corresponding encoded remote context.

cpu

public TVMContext cpu(int devId)

Construct remote CPU device.

Parameters:

devId - device id.

Returns:

Remote CPU context.

cpu

public TVMContext cpu()

Construct remote CPU device.

Returns:

Remote CPU context.

gpu

public TVMContext gpu(int devId)

Construct remote GPU device.

Parameters:

devId - device id.

Returns:

Remote GPU context.

gpu

public TVMContext gpu()

Construct remote GPU device.

Returns:

Remote GPU context.

cl

public TVMContext cl(int devId)

Construct remote OpenCL device.

Parameters:

devId - device id.

Returns:

Remote OpenCL context.

cl

public TVMContext cl()

Construct remote OpenCL device.

Returns:

Remote OpenCL context.

vulkan

public TVMContext vulkan(int devId)

Construct remote OpenCL device.

Parameters:

devId - device id.

Returns:

Remote OpenCL context.

vulkan

public TVMContext vulkan()

Construct remote OpenCL device.

Returns:

Remote OpenCL context.

metal

public TVMContext metal(int devId)

Construct remote Metal device.

Parameters:

devId - device id.

Returns:

Remote metal context.

metal

public TVMContext metal()

Construct remote Metal device.

Returns:

Remote metal context.

upload

public void upload(byte[] data,
                   String target)

Upload binary to remote runtime temp folder.

Parameters:

data - The binary in local to upload.

target - The path in remote, cannot be null.

upload

public void upload(File data,
                   String target)
            throws IOException

Upload file to remote runtime temp folder.

Parameters:

data - The file in local to upload.

target - The path in remote.

Throws:

IOException - for network failure.

upload

public void upload(File data)
            throws IOException

Upload file to remote runtime temp folder.

Parameters:

data - The file in local to upload.

Throws:

IOException - for network failure.

download

public byte[] download(String path)

Download file from remote temp folder.

Parameters:

path - The relative location to remote temp folder.

Returns:

The result blob from the file.

loadModule

public Module loadModule(String path)

Load a remote module, the file need to be uploaded first.

Parameters:

path - The relative location to remote temp folder.

Returns:

The remote module containing remote function.