spark git commit: [SPARK-18428][DOC] Update docs for GraphX
Repository: spark
Updated Branches:
refs/heads/master c07187823 -> c31def1dd
[SPARK-18428][DOC] Update docs for GraphX
## What changes were proposed in this pull request?
1, Add link of `VertexRDD` and `EdgeRDD`
2, Notify in `Vertex and Edge RDDs` that not all methods are listed
3, `VertexID` -> `VertexId`
## How was this patch tested?
No tests, only docs is modified
Author: Zheng RuiFeng
Closes #15875 from zhengruifeng/update_graphop_doc.
Project: http://git-wip-us.apache.org/repos/asf/spark/repo
Commit: http://git-wip-us.apache.org/repos/asf/spark/commit/c31def1d
Tree: http://git-wip-us.apache.org/repos/asf/spark/tree/c31def1d
Diff: http://git-wip-us.apache.org/repos/asf/spark/diff/c31def1d
Branch: refs/heads/master
Commit: c31def1ddcbed340bfc071d54fb3dc7945cb525a
Parents: c071878
Author: Zheng RuiFeng
Authored: Mon Nov 14 21:15:39 2016 -0800
Committer: Reynold Xin
Committed: Mon Nov 14 21:15:39 2016 -0800
--
docs/graphx-programming-guide.md | 68 ++-
1 file changed, 35 insertions(+), 33 deletions(-)
--
http://git-wip-us.apache.org/repos/asf/spark/blob/c31def1d/docs/graphx-programming-guide.md
--
diff --git a/docs/graphx-programming-guide.md b/docs/graphx-programming-guide.md
index 58671e6..1097cf1 100644
--- a/docs/graphx-programming-guide.md
+++ b/docs/graphx-programming-guide.md
@@ -11,6 +11,7 @@ description: GraphX graph processing library guide for Spark
SPARK_VERSION_SHORT
[EdgeRDD]: api/scala/index.html#org.apache.spark.graphx.EdgeRDD
+[VertexRDD]: api/scala/index.html#org.apache.spark.graphx.VertexRDD
[Edge]: api/scala/index.html#org.apache.spark.graphx.Edge
[EdgeTriplet]: api/scala/index.html#org.apache.spark.graphx.EdgeTriplet
[Graph]: api/scala/index.html#org.apache.spark.graphx.Graph
@@ -89,7 +90,7 @@ with user defined objects attached to each vertex and edge.
A directed multigra
graph with potentially multiple parallel edges sharing the same source and
destination vertex. The
ability to support parallel edges simplifies modeling scenarios where there
can be multiple
relationships (e.g., co-worker and friend) between the same vertices. Each
vertex is keyed by a
-*unique* 64-bit long identifier (`VertexID`). GraphX does not impose any
ordering constraints on
+*unique* 64-bit long identifier (`VertexId`). GraphX does not impose any
ordering constraints on
the vertex identifiers. Similarly, edges have corresponding source and
destination vertex
identifiers.
@@ -130,12 +131,12 @@ class Graph[VD, ED] {
}
{% endhighlight %}
-The classes `VertexRDD[VD]` and `EdgeRDD[ED]` extend and are optimized
versions of `RDD[(VertexID,
+The classes `VertexRDD[VD]` and `EdgeRDD[ED]` extend and are optimized
versions of `RDD[(VertexId,
VD)]` and `RDD[Edge[ED]]` respectively. Both `VertexRDD[VD]` and
`EdgeRDD[ED]` provide additional
functionality built around graph computation and leverage internal
optimizations. We discuss the
-`VertexRDD` and `EdgeRDD` API in greater detail in the section on [vertex and
edge
+`VertexRDD`[VertexRDD] and `EdgeRDD`[EdgeRDD] API in greater detail in the
section on [vertex and edge
RDDs](#vertex_and_edge_rdds) but for now they can be thought of as simply RDDs
of the form:
-`RDD[(VertexID, VD)]` and `RDD[Edge[ED]]`.
+`RDD[(VertexId, VD)]` and `RDD[Edge[ED]]`.
### Example Property Graph
@@ -197,7 +198,7 @@ graph.edges.filter(e => e.srcId > e.dstId).count
{% endhighlight %}
> Note that `graph.vertices` returns an `VertexRDD[(String, String)]` which
> extends
-> `RDD[(VertexID, (String, String))]` and so we use the scala `case`
expression to deconstruct the
+> `RDD[(VertexId, (String, String))]` and so we use the scala `case`
expression to deconstruct the
> tuple. On the other hand, `graph.edges` returns an `EdgeRDD` containing
> `Edge[String]` objects.
> We could have also used the case class type constructor as in the following:
> {% highlight scala %}
@@ -287,7 +288,7 @@ class Graph[VD, ED] {
// Change the partitioning heuristic
def partitionBy(partitionStrategy: PartitionStrategy): Graph[VD, ED]
// Transform vertex and edge attributes
==
- def mapVertices[VD2](map: (VertexID, VD) => VD2): Graph[VD2, ED]
+ def mapVertices[VD2](map: (VertexId, VD) => VD2): Graph[VD2, ED]
def mapEdges[ED2](map: Edge[ED] => ED2): Graph[VD, ED2]
def mapEdges[ED2](map: (PartitionID, Iterator[Edge[ED]]) => Iterator[ED2]):
Graph[VD, ED2]
def mapTriplets[ED2](map: EdgeTriplet[VD, ED] => ED2): Graph[VD, ED2]
@@ -297,18 +298,18 @@ class Graph[VD, ED] {
def reverse: Graph[VD, ED]
def subgraph(
epred: EdgeTriplet[VD,ED] => Boolean = (x => true),
-
spark git commit: [SPARK-18428][DOC] Update docs for GraphX
Repository: spark
Updated Branches:
refs/heads/branch-2.1 27999b366 -> 649c15fae
[SPARK-18428][DOC] Update docs for GraphX
## What changes were proposed in this pull request?
1, Add link of `VertexRDD` and `EdgeRDD`
2, Notify in `Vertex and Edge RDDs` that not all methods are listed
3, `VertexID` -> `VertexId`
## How was this patch tested?
No tests, only docs is modified
Author: Zheng RuiFeng
Closes #15875 from zhengruifeng/update_graphop_doc.
(cherry picked from commit c31def1ddcbed340bfc071d54fb3dc7945cb525a)
Signed-off-by: Reynold Xin
Project: http://git-wip-us.apache.org/repos/asf/spark/repo
Commit: http://git-wip-us.apache.org/repos/asf/spark/commit/649c15fa
Tree: http://git-wip-us.apache.org/repos/asf/spark/tree/649c15fa
Diff: http://git-wip-us.apache.org/repos/asf/spark/diff/649c15fa
Branch: refs/heads/branch-2.1
Commit: 649c15fae423a415cb6165aa0ef6d97ab4949afb
Parents: 27999b3
Author: Zheng RuiFeng
Authored: Mon Nov 14 21:15:39 2016 -0800
Committer: Reynold Xin
Committed: Mon Nov 14 21:18:35 2016 -0800
--
docs/graphx-programming-guide.md | 68 ++-
1 file changed, 35 insertions(+), 33 deletions(-)
--
http://git-wip-us.apache.org/repos/asf/spark/blob/649c15fa/docs/graphx-programming-guide.md
--
diff --git a/docs/graphx-programming-guide.md b/docs/graphx-programming-guide.md
index 58671e6..1097cf1 100644
--- a/docs/graphx-programming-guide.md
+++ b/docs/graphx-programming-guide.md
@@ -11,6 +11,7 @@ description: GraphX graph processing library guide for Spark
SPARK_VERSION_SHORT
[EdgeRDD]: api/scala/index.html#org.apache.spark.graphx.EdgeRDD
+[VertexRDD]: api/scala/index.html#org.apache.spark.graphx.VertexRDD
[Edge]: api/scala/index.html#org.apache.spark.graphx.Edge
[EdgeTriplet]: api/scala/index.html#org.apache.spark.graphx.EdgeTriplet
[Graph]: api/scala/index.html#org.apache.spark.graphx.Graph
@@ -89,7 +90,7 @@ with user defined objects attached to each vertex and edge.
A directed multigra
graph with potentially multiple parallel edges sharing the same source and
destination vertex. The
ability to support parallel edges simplifies modeling scenarios where there
can be multiple
relationships (e.g., co-worker and friend) between the same vertices. Each
vertex is keyed by a
-*unique* 64-bit long identifier (`VertexID`). GraphX does not impose any
ordering constraints on
+*unique* 64-bit long identifier (`VertexId`). GraphX does not impose any
ordering constraints on
the vertex identifiers. Similarly, edges have corresponding source and
destination vertex
identifiers.
@@ -130,12 +131,12 @@ class Graph[VD, ED] {
}
{% endhighlight %}
-The classes `VertexRDD[VD]` and `EdgeRDD[ED]` extend and are optimized
versions of `RDD[(VertexID,
+The classes `VertexRDD[VD]` and `EdgeRDD[ED]` extend and are optimized
versions of `RDD[(VertexId,
VD)]` and `RDD[Edge[ED]]` respectively. Both `VertexRDD[VD]` and
`EdgeRDD[ED]` provide additional
functionality built around graph computation and leverage internal
optimizations. We discuss the
-`VertexRDD` and `EdgeRDD` API in greater detail in the section on [vertex and
edge
+`VertexRDD`[VertexRDD] and `EdgeRDD`[EdgeRDD] API in greater detail in the
section on [vertex and edge
RDDs](#vertex_and_edge_rdds) but for now they can be thought of as simply RDDs
of the form:
-`RDD[(VertexID, VD)]` and `RDD[Edge[ED]]`.
+`RDD[(VertexId, VD)]` and `RDD[Edge[ED]]`.
### Example Property Graph
@@ -197,7 +198,7 @@ graph.edges.filter(e => e.srcId > e.dstId).count
{% endhighlight %}
> Note that `graph.vertices` returns an `VertexRDD[(String, String)]` which
> extends
-> `RDD[(VertexID, (String, String))]` and so we use the scala `case`
expression to deconstruct the
+> `RDD[(VertexId, (String, String))]` and so we use the scala `case`
expression to deconstruct the
> tuple. On the other hand, `graph.edges` returns an `EdgeRDD` containing
> `Edge[String]` objects.
> We could have also used the case class type constructor as in the following:
> {% highlight scala %}
@@ -287,7 +288,7 @@ class Graph[VD, ED] {
// Change the partitioning heuristic
def partitionBy(partitionStrategy: PartitionStrategy): Graph[VD, ED]
// Transform vertex and edge attributes
==
- def mapVertices[VD2](map: (VertexID, VD) => VD2): Graph[VD2, ED]
+ def mapVertices[VD2](map: (VertexId, VD) => VD2): Graph[VD2, ED]
def mapEdges[ED2](map: Edge[ED] => ED2): Graph[VD, ED2]
def mapEdges[ED2](map: (PartitionID, Iterator[Edge[ED]]) => Iterator[ED2]):
Graph[VD, ED2]
def mapTriplets[ED2](map: EdgeTriplet[VD, ED] => ED2): Graph[VD, ED2]
@@ -297,18 +298,18 @@ class Graph[VD, ED] {
d
