You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/development/writingzeppelininterpreter.md
+17-22Lines changed: 17 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,10 +32,8 @@ All Interpreters in the same interpreter group are launched in a single, separat
32
32
### Make your own Interpreter
33
33
34
34
Creating a new interpreter is quite simple. Just extend [org.apache.zeppelin.interpreter](https://github.com/apache/incubator-zeppelin/blob/master/zeppelin-interpreter/src/main/java/org/apache/zeppelin/interpreter/Interpreter.java) abstract class and implement some methods.
35
-
36
-
You can include org.apache.zeppelin:zeppelin-interpreter:[VERSION] artifact in your build system.
37
-
38
-
Your interpreter name is derived from the static register method
35
+
You can include `org.apache.zeppelin:zeppelin-interpreter:[VERSION]` artifact in your build system.
36
+
Your interpreter name is derived from the static register method.
39
37
40
38
```
41
39
static {
@@ -44,12 +42,11 @@ static {
44
42
```
45
43
46
44
The name will appear later in the interpreter name option box during the interpreter configuration process.
47
-
48
45
The name of the interpreter is what you later write to identify a paragraph which should be interpreted using this interpreter.
49
46
50
47
```
51
48
%MyInterpreterName
52
-
some interpreter spesific code...
49
+
some interpreter specific code...
53
50
```
54
51
### Install your interpreter binary
55
52
@@ -63,33 +60,33 @@ Once you have build your interpreter, you can place your interpreter under direc
63
60
64
61
To configure your interpreter you need to follow these steps:
65
62
66
-
1.create conf/zeppelin-site.xml by copying conf/zeppelin-site.xml.template to conf/zeppelin-site.xml
63
+
1.Create conf/zeppelin-site.xml by copying conf/zeppelin-site.xml.template to `conf/zeppelin-site.xml `.
67
64
68
-
2. Add your interpreter class name to the zeppelin.interpreters property in conf/zeppelin-site.xml
65
+
2. Add your interpreter class name to the zeppelin.interpreters property in `conf/zeppelin-site.xml`.
69
66
70
-
Property value is comma separated [INTERPRETER_CLASS_NAME]
71
-
for example,
67
+
Property value is comma separated [INTERPRETER\_CLASS\_NAME].
3.start zeppelin by running ```./bin/zeppelin-deamon start```
76
+
3.Start zeppelin by running `./bin/zeppelin-daemon start`.
80
77
81
-
4.in the interpreter page, click the +Create button and configure your interpreter properties.
78
+
4.In the interpreter page, click the +Create button and configure your interpreter properties.
82
79
Now you are done and ready to use your interpreter.
83
80
84
-
Note that the interpreters shipped with zeppelin have a [default configuration](https://github.com/apache/incubator-zeppelin/blob/master/zeppelin-zengine/src/main/java/org/apache/zeppelin/conf/ZeppelinConfiguration.java#L397) which is used when there is no zeppelin-site.xml.
81
+
Note that the interpreters shipped with zeppelin have a [default configuration](https://github.com/apache/incubator-zeppelin/blob/master/zeppelin-zengine/src/main/java/org/apache/zeppelin/conf/ZeppelinConfiguration.java#L397) which is used when there is no `conf/zeppelin-site.xml`.
85
82
86
83
### Use your interpreter
87
84
88
85
#### 0.5.0
89
-
Inside of a notebook, %[INTERPRETER_NAME] directive will call your interpreter.
86
+
Inside of a notebook, `%[INTERPRETER_NAME]` directive will call your interpreter.
90
87
Note that the first interpreter configuration in zeppelin.interpreters will be the default one.
91
88
92
-
for example
89
+
For example,
93
90
94
91
```
95
92
%myintp
@@ -100,16 +97,14 @@ println(a)
100
97
101
98
<br />
102
99
#### 0.6.0 and later
103
-
Inside of a notebook, %[INTERPRETER\_GROUP].[INTERPRETER\_NAME] directive will call your interpreter.
100
+
Inside of a notebook, `%[INTERPRETER_GROUP].[INTERPRETER_NAME]` directive will call your interpreter.
104
101
Note that the first interpreter configuration in zeppelin.interpreters will be the default one.
105
102
106
-
You can omit either [INTERPRETER\_GROUP] or [INTERPRETER\_NAME]. Omit [INTERPRETER\_NAME] selects first available interpreter in the [INTERPRETER\_GROUP].
107
-
Omit '[INTERPRETER\_GROUP]' will selects [INTERPRETER\_NAME] from default interpreter group.
108
-
103
+
You can omit either [INTERPRETER\_GROUP] or [INTERPRETER\_NAME]. If you omit [INTERPRETER\_NAME], then first available interpreter will be selected in the [INTERPRETER\_GROUP].
104
+
Likewise, if you skip [INTERPRETER\_GROUP], then [INTERPRETER\_NAME] will be chosen from default interpreter group.
109
105
110
-
For example, if you have two interpreter myintp1 and myintp2 in group mygrp,
111
106
112
-
you can call myintp1 like
107
+
For example, if you have two interpreter myintp1 and myintp2 in group mygrp, you can call myintp1 like
113
108
114
109
```
115
110
%mygrp.myintp1
@@ -125,7 +120,7 @@ and you can call myintp2 like
125
120
codes for myintp2
126
121
```
127
122
128
-
If you omit your interpreter name, it'll selects first available interpreter in the group (myintp1)
123
+
If you omit your interpreter name, it'll select first available interpreter in the group (myintp1 ).
0 commit comments