io.ray.streaming.python

Class PythonFunction

java.lang.Object

io.ray.streaming.python.PythonFunction

All Implemented Interfaces:

Function, Serializable

public class PythonFunction
extends Object
implements Function

Represents a user defined python function.

Python worker can use information in this class to create a function object.

If this object is constructed from serialized python function, python worker can deserialize it to create python function directly. If this object is constructed from moduleName and className/functionName, python worker will use `importlib` to load python function.

If the python data stream api is invoked from python, `function` will be not null.

If the python data stream api is invoked from java, `moduleName` and `functionName` will be not null.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PythonFunction.FunctionInterface

Constructor Summary

Constructors

Constructor and Description
PythonFunction(byte[] function) Create a PythonFunction from a serialized streaming python function.
PythonFunction(String moduleName, String functionName) Create a PythonFunction from a moduleName and streaming function name.

Method Summary

Modifier and Type	Method and Description
byte[]	getFunction()
String	getFunctionInterface()
String	getFunctionName()
String	getModuleName()
void	setFunctionInterface(PythonFunction.FunctionInterface functionInterface)
String	toSimpleString()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.ray.streaming.api.function.Function

loadCheckpoint, saveCheckpoint

Constructor Detail

PythonFunction

public PythonFunction(byte[] function)

Create a PythonFunction from a serialized streaming python function.

Parameters:

function - serialized streaming python function from python driver.

PythonFunction

public PythonFunction(String moduleName,
                      String functionName)

Create a PythonFunction from a moduleName and streaming function name.

Parameters:

moduleName - module name of streaming function.

functionName - function name of streaming function. functionName is the name of a python function, or class name of subclass of `ray.streaming.function.`

Method Detail

setFunctionInterface

public void setFunctionInterface(PythonFunction.FunctionInterface functionInterface)

getFunction

public byte[] getFunction()

getModuleName

public String getModuleName()

getFunctionName

public String getFunctionName()

getFunctionInterface

public String getFunctionInterface()

toSimpleString

public String toSimpleString()

toString

public String toString()

Overrides:

toString in class Object