[jira] [Commented] (FLINK-1462) Add documentation guide for the graph API
[ https://issues.apache.org/jira/browse/FLINK-1462?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanelfocusedCommentId=14338653#comment-14338653 ] ASF GitHub Bot commented on FLINK-1462: --- Github user tillrohrmann commented on the pull request: https://github.com/apache/flink/pull/430#issuecomment-76210625 What prevents us from merging this PR? Martin Neumann would like to use gelly and has asked for documentation. Add documentation guide for the graph API - Key: FLINK-1462 URL: https://issues.apache.org/jira/browse/FLINK-1462 Project: Flink Issue Type: Task Components: Documentation Affects Versions: 0.9 Reporter: Vasia Kalavri Assignee: Vasia Kalavri Labels: documentation We should write a guide for Gelly, describing what methods are provided and how they can be used. It should at least cover the following: graph creation, mutations, transformations, neighborhood functions, vertex-centric iteration, validation and the library methods. We can use a format similar to the Flink streaming guide, which I like a lot :) -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Commented] (FLINK-1462) Add documentation guide for the graph API
[ https://issues.apache.org/jira/browse/FLINK-1462?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanelfocusedCommentId=14338731#comment-14338731 ] ASF GitHub Bot commented on FLINK-1462: --- Github user vasia commented on the pull request: https://github.com/apache/flink/pull/430#issuecomment-76223366 Nothing prevent us really, I just need to address your comments! I'll try to do this later tonight and then I'll merge ;) Add documentation guide for the graph API - Key: FLINK-1462 URL: https://issues.apache.org/jira/browse/FLINK-1462 Project: Flink Issue Type: Task Components: Documentation Affects Versions: 0.9 Reporter: Vasia Kalavri Assignee: Vasia Kalavri Labels: documentation We should write a guide for Gelly, describing what methods are provided and how they can be used. It should at least cover the following: graph creation, mutations, transformations, neighborhood functions, vertex-centric iteration, validation and the library methods. We can use a format similar to the Flink streaming guide, which I like a lot :) -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Commented] (FLINK-1462) Add documentation guide for the graph API
[
https://issues.apache.org/jira/browse/FLINK-1462?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanelfocusedCommentId=14338183#comment-14338183
]
ASF GitHub Bot commented on FLINK-1462:
---
Github user tillrohrmann commented on a diff in the pull request:
https://github.com/apache/flink/pull/430#discussion_r25416065
--- Diff: docs/gelly_guide.md ---
@@ -0,0 +1,425 @@
+---
+title: Gelly: Flink Graph API
+---
+!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+License); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+AS IS BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+--
+
+* This will be replaced by the TOC
+{:toc}
+
+a href=#top/a
+
+Introduction
+
+
+Gelly is a Java Graph API for Flink. It contains a set of methods and
utilities which aim to simplify the development of graph analysis applications
in Flink. In Gelly, graphs can be transformed and modified using high-level
functions similar to the ones provided by the batch processing API. Gelly
provides methods to create, transform and modify graphs, as well as a library
of graph algorithms.
+
+Using Gelly
+---
+
+Gelly is currently part of the *staging* Maven project. All relevant
classes are located in the *org.apache.flink.graph* package.
+
+Add the following dependency to your `pom.xml` to use Gelly.
+
+~~~xml
+dependency
+groupIdorg.apache.flink/groupId
+artifactIdflink-gelly/artifactId
+version{{site.FLINK_VERSION_SHORT}}/version
+/dependency
+~~~
+
+The remaining sections provide a description of available methods and
present several examples of how to use Gelly and how to mix it with the Flink
Java API. After reading this guide, you might also want to check the {% gh_link
/flink-staging/flink-gelly/src/main/java/org/apache/flink/graph/example/ Gelly
examples %}.
+
+Graph Representation
+---
+
+In Gelly, a `Graph` is represented by a `DataSet` of vertices and a
`DataSet` of edges.
+
+The `Graph` nodes are represented by the `Vertex` type. A `Vertex` is
defined by a unique ID and a value. `Vertex` IDs should implement the
`Comparable` interface. Vertices without value can be represented by setting
the value type to `NullValue`.
+
+{% highlight java %}
+// create a new vertex with a Long ID and a String value
+VertexLong, String v = new VertexLong, String(1L, foo);
+
+// create a new vertex with a Long ID and no value
+VertexLong, NullValue v = new VertexLong, NullValue(1L,
NullValue.getInstance());
+{% endhighlight %}
+
+The graph edges are represented by the `Edge` type. An `Edge` is defined
by a source ID (the ID of the source `Vertex`), a target ID (the ID of the
target `Vertex`) and an optional value. The source and target IDs should be of
the same type as the `Vertex` IDs. Edges with no value have a `NullValue` value
type.
+
+{% highlight java %}
+EdgeLong, Double e = new EdgeLong, Double(1L, 2L, 0.5);
+
+// reverse the source and target of this edge
+EdgeLong, Double reversed = e.reverse();
+
+Double weight = e.getValue(); // weight = 0.5
+{% endhighlight %}
+
+[Back to top](#top)
+
+Graph Creation
+---
+
+You can create a `Graph` in the following ways:
+
+* from a `DataSet` of edges and an optional `DataSet` of vertices:
+
+{% highlight java %}
+ExecutionEnvironment env = ExecutionEnvironment.getExecutionEnvironment();
+
+DataSetVertexString, Long vertices = ...
+
+DataSetEdgeString, Double edges = ...
+
+GraphString, Long, Double graph = Graph.fromDataSet(vertices, edges,
env);
+{% endhighlight %}
+
+* from a `DataSet` of `Tuple3` and an optional `DataSet` of `Tuple2`. In
this case, Gelly will convert each `Tuple3` to an `Edge`, where the first field
will be the source ID, the second field will be the target ID and the third
field will be the edge value. Equivalently, each `Tuple2` will be converted to
a `Vertex`, where the first field will be the vertex ID and the second field
will be the vertex value:
+
+{%
[jira] [Commented] (FLINK-1462) Add documentation guide for the graph API
[ https://issues.apache.org/jira/browse/FLINK-1462?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanelfocusedCommentId=14338187#comment-14338187 ] ASF GitHub Bot commented on FLINK-1462: --- Github user tillrohrmann commented on the pull request: https://github.com/apache/flink/pull/430#issuecomment-76153180 Really good documentation. Add documentation guide for the graph API - Key: FLINK-1462 URL: https://issues.apache.org/jira/browse/FLINK-1462 Project: Flink Issue Type: Task Components: Documentation Affects Versions: 0.9 Reporter: Vasia Kalavri Assignee: Vasia Kalavri Labels: documentation We should write a guide for Gelly, describing what methods are provided and how they can be used. It should at least cover the following: graph creation, mutations, transformations, neighborhood functions, vertex-centric iteration, validation and the library methods. We can use a format similar to the Flink streaming guide, which I like a lot :) -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Commented] (FLINK-1462) Add documentation guide for the graph API
[
https://issues.apache.org/jira/browse/FLINK-1462?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanelfocusedCommentId=14338167#comment-14338167
]
ASF GitHub Bot commented on FLINK-1462:
---
Github user tillrohrmann commented on a diff in the pull request:
https://github.com/apache/flink/pull/430#discussion_r25415172
--- Diff: docs/gelly_guide.md ---
@@ -0,0 +1,425 @@
+---
+title: Gelly: Flink Graph API
+---
+!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+License); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+AS IS BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+--
+
+* This will be replaced by the TOC
+{:toc}
+
+a href=#top/a
+
+Introduction
+
+
+Gelly is a Java Graph API for Flink. It contains a set of methods and
utilities which aim to simplify the development of graph analysis applications
in Flink. In Gelly, graphs can be transformed and modified using high-level
functions similar to the ones provided by the batch processing API. Gelly
provides methods to create, transform and modify graphs, as well as a library
of graph algorithms.
+
+Using Gelly
+---
+
+Gelly is currently part of the *staging* Maven project. All relevant
classes are located in the *org.apache.flink.graph* package.
+
+Add the following dependency to your `pom.xml` to use Gelly.
+
+~~~xml
+dependency
+groupIdorg.apache.flink/groupId
+artifactIdflink-gelly/artifactId
+version{{site.FLINK_VERSION_SHORT}}/version
+/dependency
+~~~
+
+The remaining sections provide a description of available methods and
present several examples of how to use Gelly and how to mix it with the Flink
Java API. After reading this guide, you might also want to check the {% gh_link
/flink-staging/flink-gelly/src/main/java/org/apache/flink/graph/example/ Gelly
examples %}.
+
+Graph Representation
+---
+
+In Gelly, a `Graph` is represented by a `DataSet` of vertices and a
`DataSet` of edges.
+
+The `Graph` nodes are represented by the `Vertex` type. A `Vertex` is
defined by a unique ID and a value. `Vertex` IDs should implement the
`Comparable` interface. Vertices without value can be represented by setting
the value type to `NullValue`.
+
+{% highlight java %}
+// create a new vertex with a Long ID and a String value
+VertexLong, String v = new VertexLong, String(1L, foo);
+
+// create a new vertex with a Long ID and no value
+VertexLong, NullValue v = new VertexLong, NullValue(1L,
NullValue.getInstance());
+{% endhighlight %}
+
+The graph edges are represented by the `Edge` type. An `Edge` is defined
by a source ID (the ID of the source `Vertex`), a target ID (the ID of the
target `Vertex`) and an optional value. The source and target IDs should be of
the same type as the `Vertex` IDs. Edges with no value have a `NullValue` value
type.
+
+{% highlight java %}
+EdgeLong, Double e = new EdgeLong, Double(1L, 2L, 0.5);
+
+// reverse the source and target of this edge
+EdgeLong, Double reversed = e.reverse();
+
+Double weight = e.getValue(); // weight = 0.5
+{% endhighlight %}
+
+[Back to top](#top)
+
+Graph Creation
+---
+
+You can create a `Graph` in the following ways:
+
+* from a `DataSet` of edges and an optional `DataSet` of vertices:
+
+{% highlight java %}
+ExecutionEnvironment env = ExecutionEnvironment.getExecutionEnvironment();
+
+DataSetVertexString, Long vertices = ...
+
+DataSetEdgeString, Double edges = ...
+
+GraphString, Long, Double graph = Graph.fromDataSet(vertices, edges,
env);
+{% endhighlight %}
+
+* from a `DataSet` of `Tuple3` and an optional `DataSet` of `Tuple2`. In
this case, Gelly will convert each `Tuple3` to an `Edge`, where the first field
will be the source ID, the second field will be the target ID and the third
field will be the edge value. Equivalently, each `Tuple2` will be converted to
a `Vertex`, where the first field will be the vertex ID and the second field
will be the vertex value:
+
+{%
[jira] [Commented] (FLINK-1462) Add documentation guide for the graph API
[ https://issues.apache.org/jira/browse/FLINK-1462?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanelfocusedCommentId=14338203#comment-14338203 ] ASF GitHub Bot commented on FLINK-1462: --- Github user vasia commented on the pull request: https://github.com/apache/flink/pull/430#issuecomment-76155327 Awesome! Thanks a lot for the careful reading @tillrohrmann ^^ Add documentation guide for the graph API - Key: FLINK-1462 URL: https://issues.apache.org/jira/browse/FLINK-1462 Project: Flink Issue Type: Task Components: Documentation Affects Versions: 0.9 Reporter: Vasia Kalavri Assignee: Vasia Kalavri Labels: documentation We should write a guide for Gelly, describing what methods are provided and how they can be used. It should at least cover the following: graph creation, mutations, transformations, neighborhood functions, vertex-centric iteration, validation and the library methods. We can use a format similar to the Flink streaming guide, which I like a lot :) -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Commented] (FLINK-1462) Add documentation guide for the graph API
[
https://issues.apache.org/jira/browse/FLINK-1462?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanelfocusedCommentId=14338177#comment-14338177
]
ASF GitHub Bot commented on FLINK-1462:
---
Github user tillrohrmann commented on a diff in the pull request:
https://github.com/apache/flink/pull/430#discussion_r25415850
--- Diff: docs/gelly_guide.md ---
@@ -0,0 +1,425 @@
+---
+title: Gelly: Flink Graph API
+---
+!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+License); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+AS IS BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+--
+
+* This will be replaced by the TOC
+{:toc}
+
+a href=#top/a
+
+Introduction
+
+
+Gelly is a Java Graph API for Flink. It contains a set of methods and
utilities which aim to simplify the development of graph analysis applications
in Flink. In Gelly, graphs can be transformed and modified using high-level
functions similar to the ones provided by the batch processing API. Gelly
provides methods to create, transform and modify graphs, as well as a library
of graph algorithms.
+
+Using Gelly
+---
+
+Gelly is currently part of the *staging* Maven project. All relevant
classes are located in the *org.apache.flink.graph* package.
+
+Add the following dependency to your `pom.xml` to use Gelly.
+
+~~~xml
+dependency
+groupIdorg.apache.flink/groupId
+artifactIdflink-gelly/artifactId
+version{{site.FLINK_VERSION_SHORT}}/version
+/dependency
+~~~
+
+The remaining sections provide a description of available methods and
present several examples of how to use Gelly and how to mix it with the Flink
Java API. After reading this guide, you might also want to check the {% gh_link
/flink-staging/flink-gelly/src/main/java/org/apache/flink/graph/example/ Gelly
examples %}.
+
+Graph Representation
+---
+
+In Gelly, a `Graph` is represented by a `DataSet` of vertices and a
`DataSet` of edges.
+
+The `Graph` nodes are represented by the `Vertex` type. A `Vertex` is
defined by a unique ID and a value. `Vertex` IDs should implement the
`Comparable` interface. Vertices without value can be represented by setting
the value type to `NullValue`.
+
+{% highlight java %}
+// create a new vertex with a Long ID and a String value
+VertexLong, String v = new VertexLong, String(1L, foo);
+
+// create a new vertex with a Long ID and no value
+VertexLong, NullValue v = new VertexLong, NullValue(1L,
NullValue.getInstance());
+{% endhighlight %}
+
+The graph edges are represented by the `Edge` type. An `Edge` is defined
by a source ID (the ID of the source `Vertex`), a target ID (the ID of the
target `Vertex`) and an optional value. The source and target IDs should be of
the same type as the `Vertex` IDs. Edges with no value have a `NullValue` value
type.
+
+{% highlight java %}
+EdgeLong, Double e = new EdgeLong, Double(1L, 2L, 0.5);
+
+// reverse the source and target of this edge
+EdgeLong, Double reversed = e.reverse();
+
+Double weight = e.getValue(); // weight = 0.5
+{% endhighlight %}
+
+[Back to top](#top)
+
+Graph Creation
+---
+
+You can create a `Graph` in the following ways:
+
+* from a `DataSet` of edges and an optional `DataSet` of vertices:
+
+{% highlight java %}
+ExecutionEnvironment env = ExecutionEnvironment.getExecutionEnvironment();
+
+DataSetVertexString, Long vertices = ...
+
+DataSetEdgeString, Double edges = ...
+
+GraphString, Long, Double graph = Graph.fromDataSet(vertices, edges,
env);
+{% endhighlight %}
+
+* from a `DataSet` of `Tuple3` and an optional `DataSet` of `Tuple2`. In
this case, Gelly will convert each `Tuple3` to an `Edge`, where the first field
will be the source ID, the second field will be the target ID and the third
field will be the edge value. Equivalently, each `Tuple2` will be converted to
a `Vertex`, where the first field will be the vertex ID and the second field
will be the vertex value:
+
+{%
[jira] [Commented] (FLINK-1462) Add documentation guide for the graph API
[
https://issues.apache.org/jira/browse/FLINK-1462?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanelfocusedCommentId=14338186#comment-14338186
]
ASF GitHub Bot commented on FLINK-1462:
---
Github user tillrohrmann commented on a diff in the pull request:
https://github.com/apache/flink/pull/430#discussion_r25416336
--- Diff: docs/gelly_guide.md ---
@@ -0,0 +1,425 @@
+---
+title: Gelly: Flink Graph API
+---
+!--
+Licensed to the Apache Software Foundation (ASF) under one
+or more contributor license agreements. See the NOTICE file
+distributed with this work for additional information
+regarding copyright ownership. The ASF licenses this file
+to you under the Apache License, Version 2.0 (the
+License); you may not use this file except in compliance
+with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing,
+software distributed under the License is distributed on an
+AS IS BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+KIND, either express or implied. See the License for the
+specific language governing permissions and limitations
+under the License.
+--
+
+* This will be replaced by the TOC
+{:toc}
+
+a href=#top/a
+
+Introduction
+
+
+Gelly is a Java Graph API for Flink. It contains a set of methods and
utilities which aim to simplify the development of graph analysis applications
in Flink. In Gelly, graphs can be transformed and modified using high-level
functions similar to the ones provided by the batch processing API. Gelly
provides methods to create, transform and modify graphs, as well as a library
of graph algorithms.
+
+Using Gelly
+---
+
+Gelly is currently part of the *staging* Maven project. All relevant
classes are located in the *org.apache.flink.graph* package.
+
+Add the following dependency to your `pom.xml` to use Gelly.
+
+~~~xml
+dependency
+groupIdorg.apache.flink/groupId
+artifactIdflink-gelly/artifactId
+version{{site.FLINK_VERSION_SHORT}}/version
+/dependency
+~~~
+
+The remaining sections provide a description of available methods and
present several examples of how to use Gelly and how to mix it with the Flink
Java API. After reading this guide, you might also want to check the {% gh_link
/flink-staging/flink-gelly/src/main/java/org/apache/flink/graph/example/ Gelly
examples %}.
+
+Graph Representation
+---
+
+In Gelly, a `Graph` is represented by a `DataSet` of vertices and a
`DataSet` of edges.
+
+The `Graph` nodes are represented by the `Vertex` type. A `Vertex` is
defined by a unique ID and a value. `Vertex` IDs should implement the
`Comparable` interface. Vertices without value can be represented by setting
the value type to `NullValue`.
+
+{% highlight java %}
+// create a new vertex with a Long ID and a String value
+VertexLong, String v = new VertexLong, String(1L, foo);
+
+// create a new vertex with a Long ID and no value
+VertexLong, NullValue v = new VertexLong, NullValue(1L,
NullValue.getInstance());
+{% endhighlight %}
+
+The graph edges are represented by the `Edge` type. An `Edge` is defined
by a source ID (the ID of the source `Vertex`), a target ID (the ID of the
target `Vertex`) and an optional value. The source and target IDs should be of
the same type as the `Vertex` IDs. Edges with no value have a `NullValue` value
type.
+
+{% highlight java %}
+EdgeLong, Double e = new EdgeLong, Double(1L, 2L, 0.5);
+
+// reverse the source and target of this edge
+EdgeLong, Double reversed = e.reverse();
+
+Double weight = e.getValue(); // weight = 0.5
+{% endhighlight %}
+
+[Back to top](#top)
+
+Graph Creation
+---
+
+You can create a `Graph` in the following ways:
+
+* from a `DataSet` of edges and an optional `DataSet` of vertices:
+
+{% highlight java %}
+ExecutionEnvironment env = ExecutionEnvironment.getExecutionEnvironment();
+
+DataSetVertexString, Long vertices = ...
+
+DataSetEdgeString, Double edges = ...
+
+GraphString, Long, Double graph = Graph.fromDataSet(vertices, edges,
env);
+{% endhighlight %}
+
+* from a `DataSet` of `Tuple3` and an optional `DataSet` of `Tuple2`. In
this case, Gelly will convert each `Tuple3` to an `Edge`, where the first field
will be the source ID, the second field will be the target ID and the third
field will be the edge value. Equivalently, each `Tuple2` will be converted to
a `Vertex`, where the first field will be the vertex ID and the second field
will be the vertex value:
+
+{%
[jira] [Commented] (FLINK-1462) Add documentation guide for the graph API
[ https://issues.apache.org/jira/browse/FLINK-1462?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanelfocusedCommentId=14334992#comment-14334992 ] ASF GitHub Bot commented on FLINK-1462: --- Github user ktzoumas commented on the pull request: https://github.com/apache/flink/pull/430#issuecomment-75775383 Reads very very well. Big +1 as well Add documentation guide for the graph API - Key: FLINK-1462 URL: https://issues.apache.org/jira/browse/FLINK-1462 Project: Flink Issue Type: Task Components: Documentation Affects Versions: 0.9 Reporter: Vasia Kalavri Assignee: Vasia Kalavri Labels: documentation We should write a guide for Gelly, describing what methods are provided and how they can be used. It should at least cover the following: graph creation, mutations, transformations, neighborhood functions, vertex-centric iteration, validation and the library methods. We can use a format similar to the Flink streaming guide, which I like a lot :) -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Commented] (FLINK-1462) Add documentation guide for the graph API
[ https://issues.apache.org/jira/browse/FLINK-1462?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanelfocusedCommentId=14330385#comment-14330385 ] ASF GitHub Bot commented on FLINK-1462: --- GitHub user vasia opened a pull request: https://github.com/apache/flink/pull/430 [FLINK-1462] Gelly documentation Hi, here's the first draft of the gelly-guide. I have also included the changes introduced by #402. Let me know what you think, whether everything is clear, whether I should add more examples and figures. Thanks! -V. You can merge this pull request into a Git repository by running: $ git pull https://github.com/vasia/flink gelly-guide Alternatively you can review and apply these changes as the patch at: https://github.com/apache/flink/pull/430.patch To close this pull request, make a commit to your master/trunk branch with (at least) the following in the commit message: This closes #430 commit 8db66cefc0810f8621e2042dbf073768db591284 Author: vasia vasilikikala...@gmail.com Date: 2015-01-29T15:46:51Z [FLINK-1462][gelly][docs] added gelly guide Add documentation guide for the graph API - Key: FLINK-1462 URL: https://issues.apache.org/jira/browse/FLINK-1462 Project: Flink Issue Type: Task Components: Documentation Affects Versions: 0.9 Reporter: Vasia Kalavri Assignee: Vasia Kalavri Labels: documentation We should write a guide for Gelly, describing what methods are provided and how they can be used. It should at least cover the following: graph creation, mutations, transformations, neighborhood functions, vertex-centric iteration, validation and the library methods. We can use a format similar to the Flink streaming guide, which I like a lot :) -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Commented] (FLINK-1462) Add documentation guide for the graph API
[ https://issues.apache.org/jira/browse/FLINK-1462?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanelfocusedCommentId=14306036#comment-14306036 ] Vasia Kalavri commented on FLINK-1462: -- I'm definitely planning to add some pictures for the more complex operations. I'm on it.. quite slowly because of limited time this week, but it will soon be ready. And the GraphX guide is indeed very nice! I have a practical question though: which editor would you people recommend for writing the guide? I'm using UberWriter but the preview doesn't work so well. Also, is there a reference for the markdown flavor we're using for the programming guides? For now, I'm using the existing guides as an example, but it would be nice to have a full syntax reference. Thanks! Add documentation guide for the graph API - Key: FLINK-1462 URL: https://issues.apache.org/jira/browse/FLINK-1462 Project: Flink Issue Type: Task Components: Documentation Affects Versions: 0.9 Reporter: Vasia Kalavri Assignee: Vasia Kalavri Labels: documentation We should write a guide for Gelly, describing what methods are provided and how they can be used. It should at least cover the following: graph creation, mutations, transformations, neighborhood functions, vertex-centric iteration, validation and the library methods. We can use a format similar to the Flink streaming guide, which I like a lot :) -- This message was sent by Atlassian JIRA (v6.3.4#6332)
[jira] [Commented] (FLINK-1462) Add documentation guide for the graph API
[ https://issues.apache.org/jira/browse/FLINK-1462?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanelfocusedCommentId=14300263#comment-14300263 ] Henry Saputra commented on FLINK-1462: -- Would love to see some pictures to visualize how it works underneath. Graph processing usually a bit hard to explain especially with complex structure. I like how Spark GarphX [1] doc explain how it works. [1] https://spark.apache.org/docs/latest/graphx-programming-guide.html Add documentation guide for the graph API - Key: FLINK-1462 URL: https://issues.apache.org/jira/browse/FLINK-1462 Project: Flink Issue Type: Task Components: Documentation Affects Versions: 0.9 Reporter: Vasia Kalavri Assignee: Vasia Kalavri Labels: documentation We should write a guide for Gelly, describing what methods are provided and how they can be used. It should at least cover the following: graph creation, mutations, transformations, neighborhood functions, vertex-centric iteration, validation and the library methods. We can use a format similar to the Flink streaming guide, which I like a lot :) -- This message was sent by Atlassian JIRA (v6.3.4#6332)
