Skip to content

Commit ad03340

Browse files
author
Yucheng Low
committed
Added more documentation
1 parent a1645bc commit ad03340

File tree

12 files changed

+327
-150
lines changed

12 files changed

+327
-150
lines changed

Doxyfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ PROJECT_NAME = "GraphLab: Distributed Graph-Parallel API"
3131
# This could be handy for archiving the generated documentation or
3232
# if some version control system is used.
3333

34-
PROJECT_NUMBER = 2.1
34+
PROJECT_NUMBER = 2.2
3535

3636
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
3737
# base path where the generated documentation will be put.

Doxyfile_internal

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ PROJECT_NAME = "GraphLab: Distributed Graph-Parallel API"
3131
# This could be handy for archiving the generated documentation or
3232
# if some version control system is used.
3333

34-
PROJECT_NUMBER = 2.0
34+
PROJECT_NUMBER = 2.2
3535

3636
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
3737
# base path where the generated documentation will be put.

demoapps/pagerank/CMakeLists.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@ project(GraphLab)
33

44
add_graphlab_executable(simple_pagerank simple_pagerank.cpp)
55

6-
add_graphlab_executable(warp_pagerank warp_pagerank.cpp)
6+
add_graphlab_executable(warp_parfor_pagerank warp_parfor_pagerank.cpp)
77

88
add_graphlab_executable(warp_engine_pagerank warp_engine_pagerank.cpp)

demoapps/pagerank/warp_engine_pagerank.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ using namespace graphlab;
3030

3131
// The graph type is determined by the vertex and edge data types
3232
typedef distributed_graph<float , graphlab::empty> graph_type;
33-
typedef warp_engine<graph_type> warp_engine_type;
33+
typedef warp::warp_engine<graph_type> warp_engine_type;
3434

3535
/*
3636
* A simple function used by graph.transform_vertices(init_vertex);

demoapps/pagerank/warp_parfor_pagerank.cpp

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -43,22 +43,13 @@ void init_vertex(graph_type::vertex_type& vertex) { vertex.data() = 1; }
4343
float pagerank_map(graph_type::edge_type edge, graph_type::vertex_type other) {
4444
return other.data() / other.num_out_edges();
4545
}
46-
void transform_edge(graph_type::edge_type edge, graph_type::vertex_type other) {
47-
edge.data() = other.data();
48-
}
4946

5047
void pagerank(graph_type::vertex_type vertex) {
5148
vertex.data() = 0.15 + 0.85 * warp::map_reduce_neighborhood(vertex,
5249
IN_EDGES,
5350
pagerank_map);
54-
warp::transform_neighborhood(vertex, OUT_EDGES, transform_edge);
5551
}
5652

57-
58-
59-
60-
61-
6253
/*
6354
* We want to save the final graph so we define a write which will be
6455
* used in graph.save("path/prefix", pagerank_writer()) to save the graph.

src/graphlab/docs/overview.dox

Lines changed: 20 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -14,33 +14,35 @@
1414
The GraphLab project started in 2009 to develop a new parallel
1515
computation abstraction tailored to machine learning. GraphLab 1.0
1616
represents our first shared memoy design which, through the addition
17-
of several matrix factorization toolkits contributed by our post-doc
18-
Danny Bickson, started to grow a community of users.
17+
of several matrix factorization toolkits, started to grow a community of users.
1918

2019
In the last couple of years, we have focused our development effort
2120
on the distributed environment. Unfortunately, it took nearly a year
2221
to figure out that distributing the GraphLab 1 abstraction was
2322
excessively complicated and is unable to scale up to power-law
2423
graphs commonly seen in the real world.
2524

26-
GraphLab 2.1 represents the latest evolution of the GraphLab
27-
abstraction and is a complete redesign of the GraphLab 1 framework
25+
In GraphLab 2.1, we completely redesign of the GraphLab 1 framework
2826
for the distributed environment. The implementation is distributed
2927
by design and a "shared-memory" execution is essentially running a
30-
distributed system on a cluster of 1 machine. Not all toolkits from
31-
GraphLab 1 have been ported over yet; some complex algorithms may
32-
take some time.
33-
34-
There are two starting points where one may begin using GraphLab.
35-
\li \ref toolkits "Toolkits" You can lookup the toolkit documentation here if you have a
36-
computation task which is already implemented by one of our toolkits.
37-
\li \ref using_graphlab "GraphLab C++ Tutorial" If you have a computation task which is
38-
not implemented by our toolkits, you could try implementing yourself! For now
39-
a certain degree of C++ knowledge is required. However, we are trying to
40-
provide an interface to other languages such as Javascript and Python.
41-
Contact the developers (here) if you want to beta-test these interfaces, or
42-
come back in a couple of months when we may have something stable.
43-
28+
distributed system on a cluster of 1 machine.
29+
30+
And in this new release of GraphLab 2.2, we introduce the new \ref warp
31+
which through the use of fine-grained user-mode threading, introduces a new
32+
API which brings about a major increase in useability, and will allow us to
33+
provide new capabilities more easily in the future.
34+
35+
There are two starting points where one may begin using GraphLab. \li \ref
36+
toolkits "Toolkits" You can lookup the toolkit documentation here if you have
37+
a computation task which is already implemented by one of our toolkits. \li
38+
\ref using_graphlab "GraphLab C++ Tutorial" If you have a computation task
39+
which is not implemented by our toolkits, you could try implementing
40+
yourself! For now a certain degree of C++ knowledge is required.
41+
42+
The new GraphLab 2.2 \ref warp is available for experimentation. A
43+
\ref using_warp tutorial is provided, and we are are looking for feedback
44+
to continue extending and improving the Warp system. Performance tuning is
45+
also underway.
4446

4547
Software Stack
4648
=============

0 commit comments

Comments
 (0)