[
https://issues.apache.org/jira/browse/FLINK-2857?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14963260#comment-14963260
]
ASF GitHub Bot commented on FLINK-2857:
---------------------------------------
Github user fhueske commented on a diff in the pull request:
https://github.com/apache/flink/pull/1263#discussion_r42366708
--- Diff: docs/libs/gelly_guide.md ---
@@ -424,8 +448,8 @@ graph.subgraph((vertex => vertex.getValue > 0), (edge
=> edge.getValue < 0))
<img alt="Filter Transformations" width="80%"
src="fig/gelly-filter.png"/>
</p>
-* <strong>Join</strong>: Gelly provides specialized methods for joining
the vertex and edge datasets with other input datasets. `joinWithVertices`
joins the vertices with a `Tuple2` input data set. The join is performed using
the vertex ID and the first field of the `Tuple2` input as the join keys. The
method returns a new `Graph` where the vertex values have been updated
according to a provided user-defined map function.
-Similarly, an input dataset can be joined with the edges, using one of
three methods. `joinWithEdges` expects an input `DataSet` of `Tuple3` and joins
on the composite key of both source and target vertex IDs.
`joinWithEdgesOnSource` expects a `DataSet` of `Tuple2` and joins on the source
key of the edges and the first attribute of the input dataset and
`joinWithEdgesOnTarget` expects a `DataSet` of `Tuple2` and joins on the target
key of the edges and the first attribute of the input dataset. All three
methods apply a map function on the edge and the input data set values.
+* <strong>Join</strong>: Gelly provides specialized methods for joining
the vertex and edge datasets with other input datasets. `joinWithVertices`
joins the vertices with a `Tuple2` input data set. The join is performed using
the vertex ID and the first field of the `Tuple2` input as the join keys. The
method returns a new `Graph` where the vertex values have been updated
according to a provided user-defined tranformation function.
--- End diff --
tranSformation function.
> Gelly API improvements
> ----------------------
>
> Key: FLINK-2857
> URL: https://issues.apache.org/jira/browse/FLINK-2857
> Project: Flink
> Issue Type: Improvement
> Components: Gelly
> Reporter: Vasia Kalavri
> Assignee: Vasia Kalavri
>
> During the Flink Forward Gelly School training, I got some really valuable
> feedback from participants on what they found hard to grasp or non-intuitive
> in the API.
> Based on that, I propose we make the following improvements:
> - rename the mapper in creation methods to {{VertexInitializer}}, so that
> its purpose is easier to understand.
> - add a {{fromTuple2DataSet}} method to easily create graphs from {{Tuple2}}
> datasets, i.e. edges with no values.
> - in {{joinWith*}} methods, it is hard to understand what are the parameters
> in the mapper and what will be the output. I suggest we flatten them, try to
> give intuitive names and improve the javadocs.
> - in neighborhood methods, it is hard to understand what are the arguments of
> the {{EdgeFunction.iterateEdges}} and {{ReduceEdgesFunction.reduceEdges}}.
> Javadocs and parameter names could be improved here too.
--
This message was sent by Atlassian JIRA
(v6.3.4#6332)
