[
https://issues.apache.org/jira/browse/FLINK-2857?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=14960953#comment-14960953
]
ASF GitHub Bot commented on FLINK-2857:
---------------------------------------
GitHub user vasia opened a pull request:
https://github.com/apache/flink/pull/1263
[FLINK-2857] [gelly] API improvements
This PR:
- renames the mapper parameter in creation methods to `vertexInitializer`,
so that its purpose is easier to understand.
- add `fromTuple2DataSet` methods to easily create graphs from `Tuple2`
datasets, i.e. edges with no values.
- replaces the mapper UDFs in the `joinWith*` with `VertexJoinFunction` and
`EdgeJoinFunction`. These have flattened parameters and their purpose is more
intuitive.
- improves the java/scala docs of several methods.
- updates docs accordingly.
You can merge this pull request into a Git repository by running:
$ git pull https://github.com/vasia/flink flink-2857
Alternatively you can review and apply these changes as the patch at:
https://github.com/apache/flink/pull/1263.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 #1263
----
commit c1ddbf032d492fd5c9d937ec3bcf8c89d96a5c0f
Author: vasia <[email protected]>
Date: 2015-10-16T09:11:40Z
[FLINK-2857] [gelly] improve javadocs of Graph creation methods; add
fromTuple2 creation methods;
rename mapper parameters to vertexInitializer.
commit 59d6eece651c7edff166de48a5485752353c0238
Author: vasia <[email protected]>
Date: 2015-10-16T14:44:14Z
[FLINK-2857] [gelly] improve javadocs and parameter names of joinWith*
methods
commit edb7384837dc640f61d53454df7ff6c01efb1634
Author: vasia <[email protected]>
Date: 2015-10-16T15:45:50Z
[FLINK-2857] [gelly] improve javadocs of neighborhood methods
commit e23a92dc23329737ae5a7aed7423e6fd5493db2a
Author: vasia <[email protected]>
Date: 2015-10-16T16:05:08Z
[FLINK-2857] [gelly] [docs] update docs to reflect api changes
----
> 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)
