Restructure example dir

rapidsai · Feb 8, 2024 · 10a016a · 10a016a
1 parent 2f2f192
commit 10a016a
Show file tree

Hide file tree

Showing 11 changed files with 46 additions and 37 deletions.
diff --git a/cpp/examples/README.md b/cpp/examples/README.md
@@ -4,17 +4,24 @@ Example codes on how to use libcugraph.
 
 ## Contents
 
-- single_gpu_application: example code on how to use libgraph to run different graph algorithms on a single-GPU node.
+- simple
 
-- multi_gpu_application: example code on how to use libgraph to run different graph algorithms on a multi-GPU node.
+  - single_gpu_application: example code on how to use libgraph to run different graph algorithms on a single-GPU node.
 
--  graph_partition: code to explain vertex and edge partitioning in cugraph.
+  - multi_gpu_application: example code on how to use libgraph to run different graph algorithms on a multi-GPU node.
 
--  cugraph_operations: example code for using cugraph primitives for simple graph operations needed to implement graph algorithms. 
+- advanced
+  -  graph_partition: code to explain vertex and edge partitioning in cugraph.
+
+  -  cugraph_operations: example code for using cugraph primitives for simple graph operations needed to implement graph algorithms. 
 
 ## Build instructions:
 
-Run `build.sh` to build the above listed examples.
+Run `build.sh` to from examples dir to build the above listed examples.
+
+```sh
+~/cugraph/cpp/examples$./build.sh
+```
 
 ## Run instructions
 
@@ -26,6 +33,8 @@ For multi_gpu, graph_partitioning and cugraph_operations
 
 `mpirun -np 2 path_to_executable  path_to_a_csv_graph_file [memory allocation mode]`
 
+NOTE: The example codes a
+
 Memory allocation mode can be one of the followings -
 
 - cuda

diff --git a/...xamples/cugraph_operations/CMakeLists.txt → ...dvanced/cugraph_operations/CMakeLists.txt b/...xamples/cugraph_operations/CMakeLists.txt → ...dvanced/cugraph_operations/CMakeLists.txt
@@ -22,18 +22,18 @@ project(
   LANGUAGES CXX CUDA
 )
 
-include(../fetch_dependencies.cmake)
+include(../../fetch_dependencies.cmake)
 
 find_package(MPI REQUIRED COMPONENTS CXX)
-include(../../cmake/thirdparty/get_nccl.cmake)
+include(../../../cmake/thirdparty/get_nccl.cmake)
 
-add_library(csvfileutil STATIC ../../tests/utilities/csv_file_utilities.cu)
+add_library(csvfileutil STATIC ../../../tests/utilities/csv_file_utilities.cu)
 target_include_directories(csvfileutil
   PUBLIC
-    "../../../thirdparty/mmio"
-    "../../tests"
-    "../../include"
-    "../../src"
+    "../../../../thirdparty/mmio"
+    "../../../tests"
+    "../../../include"
+    "../../../src"
 )
 set_target_properties(csvfileutil PROPERTIES CUDA_ARCHITECTURES "native")
 target_link_libraries(csvfileutil PUBLIC cugraph::cugraph NCCL::NCCL MPI::MPI_CXX)

diff --git a/...es/cugraph_operations/graph_operations.cu → ...ed/cugraph_operations/graph_operations.cu b/...es/cugraph_operations/graph_operations.cu → ...ed/cugraph_operations/graph_operations.cu
diff --git a/cpp/examples/graph_partition/CMakeLists.txt → ...s/advanced/graph_partition/CMakeLists.txt b/cpp/examples/graph_partition/CMakeLists.txt → ...s/advanced/graph_partition/CMakeLists.txt
@@ -22,18 +22,18 @@ project(
   LANGUAGES CXX CUDA
 )
 
-include(../fetch_dependencies.cmake)
+include(../../fetch_dependencies.cmake)
 
 find_package(MPI REQUIRED COMPONENTS CXX)
-include(../../cmake/thirdparty/get_nccl.cmake)
+include(../../../cmake/thirdparty/get_nccl.cmake)
 
-add_library(csvfileutil STATIC ../../tests/utilities/csv_file_utilities.cu)
+add_library(csvfileutil STATIC ../../../tests/utilities/csv_file_utilities.cu)
 target_include_directories(csvfileutil
   PUBLIC
-    "../../../thirdparty/mmio"
-    "../../tests"
-    "../../include"
-    "../../src"
+    "../../../../thirdparty/mmio"
+    "../../../tests"
+    "../../../include"
+    "../../../src"
 )
 set_target_properties(csvfileutil PROPERTIES CUDA_ARCHITECTURES "native")
 target_link_libraries(csvfileutil PUBLIC cugraph::cugraph NCCL::NCCL MPI::MPI_CXX)

diff --git a/...ph_partition/vertex_and_edge_partition.cu → ...ph_partition/vertex_and_edge_partition.cu b/...ph_partition/vertex_and_edge_partition.cu → ...ph_partition/vertex_and_edge_partition.cu
diff --git a/cpp/examples/build.sh b/cpp/examples/build.sh
@@ -26,8 +26,8 @@ build_example() {
   cmake --build ${build_dir} -j${PARALLEL_LEVEL}
 }
 
-build_example single_gpu_application
-build_example multi_gpu_application
-build_example graph_partition
-build_example cugraph_operations
+build_example simple/single_gpu_application
+build_example simple/multi_gpu_application
+build_example advanced/graph_partition
+build_example advanced/cugraph_operations
 
diff --git a/cpp/examples/fetch_dependencies.cmake b/cpp/examples/fetch_dependencies.cmake
@@ -29,5 +29,5 @@ CPMFindPackage(
     cpp
 )
 
-include(../../../fetch_rapids.cmake)
+include(../../../../fetch_rapids.cmake)
 include(rapids-find)
diff --git a/...ples/multi_gpu_application/CMakeLists.txt → ...mple/multi_gpu_application/CMakeLists.txt b/...ples/multi_gpu_application/CMakeLists.txt → ...mple/multi_gpu_application/CMakeLists.txt
@@ -22,19 +22,19 @@ project(
   LANGUAGES CXX CUDA
 )
 
-include(../fetch_dependencies.cmake)
+include(../../fetch_dependencies.cmake)
 
 find_package(MPI REQUIRED COMPONENTS CXX)
-include(../../cmake/thirdparty/get_nccl.cmake)
+include(../../../cmake/thirdparty/get_nccl.cmake)
 
-add_library(csvfileutil STATIC ../../tests/utilities/csv_file_utilities.cu)
+add_library(csvfileutil STATIC ../../../tests/utilities/csv_file_utilities.cu)
 target_include_directories(csvfileutil
   PUBLIC
-    "../../../thirdparty/mmio"
-    "../../tests"
+    "../../../../thirdparty/mmio"
+    "../../../tests"
   PRIVATE
-    "../../include"
-    "../../src"
+    "../../../include"
+    "../../../src"
 )
 set_target_properties(csvfileutil PROPERTIES CUDA_ARCHITECTURES "native")
 target_link_libraries(csvfileutil PUBLIC cugraph::cugraph NCCL::NCCL MPI::MPI_CXX)

diff --git a/...i_gpu_application/mg_graph_algorithms.cpp → ...i_gpu_application/mg_graph_algorithms.cpp b/...i_gpu_application/mg_graph_algorithms.cpp → ...i_gpu_application/mg_graph_algorithms.cpp
diff --git a/...les/single_gpu_application/CMakeLists.txt → ...ple/single_gpu_application/CMakeLists.txt b/...les/single_gpu_application/CMakeLists.txt → ...ple/single_gpu_application/CMakeLists.txt
@@ -22,16 +22,16 @@ project(
   LANGUAGES CXX CUDA
 )
 
-include(../fetch_dependencies.cmake)
+include(../../fetch_dependencies.cmake)
 
-add_library(csvfileutil STATIC ../../tests/utilities/csv_file_utilities.cu)
+add_library(csvfileutil STATIC ../../../tests/utilities/csv_file_utilities.cu)
 target_include_directories(csvfileutil
 PUBLIC
-"../../../thirdparty/mmio"
-"../../tests"
+"../../../../thirdparty/mmio"
+"../../../tests"
 PRIVATE
-"../../include"
-"../../src"
+"../../../include"
+"../../../src"
 )
 set_target_properties(csvfileutil PROPERTIES CUDA_ARCHITECTURES "native")
 target_link_libraries(csvfileutil PUBLIC cugraph::cugraph)

diff --git a/...e_gpu_application/sg_graph_algorithms.cpp → ...e_gpu_application/sg_graph_algorithms.cpp b/...e_gpu_application/sg_graph_algorithms.cpp → ...e_gpu_application/sg_graph_algorithms.cpp