io.jenkins.plugins.ml.jupyter

Class JupyterKernelInterpreter

java.lang.Object

org.apache.zeppelin.interpreter.Interpreter

org.apache.zeppelin.interpreter.AbstractInterpreter

io.jenkins.plugins.ml.jupyter.JupyterKernelInterpreter

public class JupyterKernelInterpreter
extends org.apache.zeppelin.interpreter.AbstractInterpreter

Jupyter Kernel Interpreter for Zeppelin. One instance of this class represents one Jupyter Kernel. You can enhance the jupyter kernel by extending this class. e.g. IPythonInterpreter. Copied from org.apache.zeppelin.jupyter Process Launcher will be launching with given working directory

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	JupyterKernelInterpreter.JupyterKernelProcessLauncher

Nested classes/interfaces inherited from class org.apache.zeppelin.interpreter.Interpreter

org.apache.zeppelin.interpreter.Interpreter.FormType, org.apache.zeppelin.interpreter.Interpreter.RegisteredInterpreter, org.apache.zeppelin.interpreter.Interpreter.SchedulingMode

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.zeppelin.jupyter.JupyterKernelClient	jupyterKernelClient
protected File	kernelWorkDir
protected org.apache.zeppelin.interpreter.ZeppelinContext	z

Fields inherited from class org.apache.zeppelin.interpreter.Interpreter

logger, properties, userName

Constructor Summary

Constructors

Constructor and Description
JupyterKernelInterpreter(Properties properties)
JupyterKernelInterpreter(String kernel, Properties properties)

Method Summary

Modifier and Type	Method and Description
protected org.apache.zeppelin.interpreter.ZeppelinContext	buildZeppelinContext()
void	cancel(org.apache.zeppelin.interpreter.InterpreterContext context)
String	checkKernelPrerequisite(String pythonExec) non-empty return value mean the errors when checking kernel prerequisite.
void	close()
List<org.apache.zeppelin.interpreter.thrift.InterpreterCompletion>	completion(String buf, int cursor, org.apache.zeppelin.interpreter.InterpreterContext interpreterContext)
org.apache.zeppelin.interpreter.Interpreter.FormType	getFormType()
String	getKernelName()
JupyterKernelInterpreter.JupyterKernelProcessLauncher	getKernelProcessLauncher()
int	getProgress(org.apache.zeppelin.interpreter.InterpreterContext context)
List<String>	getRequiredPackages()
org.apache.zeppelin.interpreter.ZeppelinContext	getZeppelinContext()
org.apache.zeppelin.interpreter.InterpreterResult	internalInterpret(String st, org.apache.zeppelin.interpreter.InterpreterContext context)
void	open()
protected Map<String,String>	setupKernelEnv()

Methods inherited from class org.apache.zeppelin.interpreter.AbstractInterpreter

interpret, isInterpolate

Methods inherited from class org.apache.zeppelin.interpreter.Interpreter

executePrecode, getClassloaderUrls, getClassName, getHook, getHook, getInterpreterGroup, getInterpreterInTheSameSessionByClassName, getInterpreterInTheSameSessionByClassName, getProperties, getProperty, getProperty, getScheduler, getUserName, interpolate, registerHook, registerHook, setClassloaderUrls, setInterpreterGroup, setProperties, setProperty, setUserName, unregisterHook, unregisterHook

Methods inherited from class java.lang.Object

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

Field Detail

jupyterKernelClient

protected org.apache.zeppelin.jupyter.JupyterKernelClient jupyterKernelClient

z

protected org.apache.zeppelin.interpreter.ZeppelinContext z

kernelWorkDir

protected File kernelWorkDir

Constructor Detail

JupyterKernelInterpreter

public JupyterKernelInterpreter(String kernel,
                                Properties properties)

JupyterKernelInterpreter

public JupyterKernelInterpreter(Properties properties)

Method Detail

getKernelName

public String getKernelName()

getRequiredPackages

public List<String> getRequiredPackages()

buildZeppelinContext

protected org.apache.zeppelin.interpreter.ZeppelinContext buildZeppelinContext()

open

public void open()
          throws org.apache.zeppelin.interpreter.InterpreterException

Specified by:

open in class org.apache.zeppelin.interpreter.Interpreter

Throws:

org.apache.zeppelin.interpreter.InterpreterException

checkKernelPrerequisite

public String checkKernelPrerequisite(String pythonExec)

non-empty return value mean the errors when checking kernel prerequisite. empty value mean kernel prerequisite is met.

Parameters:

pythonExec - string for python executable

Returns:

check result of checking kernel prerequisite.

setupKernelEnv

protected Map<String,String> setupKernelEnv()
                                     throws IOException

Throws:

IOException

getKernelProcessLauncher

public JupyterKernelInterpreter.JupyterKernelProcessLauncher getKernelProcessLauncher()

close

public void close()
           throws org.apache.zeppelin.interpreter.InterpreterException

Specified by:

close in class org.apache.zeppelin.interpreter.Interpreter

Throws:

org.apache.zeppelin.interpreter.InterpreterException

internalInterpret

public org.apache.zeppelin.interpreter.InterpreterResult internalInterpret(String st,
                                                                           org.apache.zeppelin.interpreter.InterpreterContext context)
                                                                    throws org.apache.zeppelin.interpreter.InterpreterException

Specified by:

internalInterpret in class org.apache.zeppelin.interpreter.AbstractInterpreter

Throws:

org.apache.zeppelin.interpreter.InterpreterException

cancel

public void cancel(org.apache.zeppelin.interpreter.InterpreterContext context)
            throws org.apache.zeppelin.interpreter.InterpreterException

Specified by:

cancel in class org.apache.zeppelin.interpreter.Interpreter

Throws:

org.apache.zeppelin.interpreter.InterpreterException

getFormType

public org.apache.zeppelin.interpreter.Interpreter.FormType getFormType()

Specified by:

getFormType in class org.apache.zeppelin.interpreter.Interpreter

getProgress

public int getProgress(org.apache.zeppelin.interpreter.InterpreterContext context)
                throws org.apache.zeppelin.interpreter.InterpreterException

Specified by:

getProgress in class org.apache.zeppelin.interpreter.Interpreter

Throws:

org.apache.zeppelin.interpreter.InterpreterException

completion

public List<org.apache.zeppelin.interpreter.thrift.InterpreterCompletion> completion(String buf,
                                                                                     int cursor,
                                                                                     org.apache.zeppelin.interpreter.InterpreterContext interpreterContext)

Overrides:

completion in class org.apache.zeppelin.interpreter.AbstractInterpreter

getZeppelinContext

public org.apache.zeppelin.interpreter.ZeppelinContext getZeppelinContext()

Specified by:

getZeppelinContext in class org.apache.zeppelin.interpreter.AbstractInterpreter