Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

first copy of general cugraph tutorial. #4396

Merged
merged 7 commits into from
May 29, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 28 additions & 0 deletions docs/cugraph/source/tutorials/basic_cugraph.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
## Required hardware/software

CuGraph is part of [Rapids](https://docs.rapids.ai/user-guide)
acostadon marked this conversation as resolved.
Show resolved Hide resolved
It has the following system requirements
acostadon marked this conversation as resolved.
Show resolved Hide resolved
* NVIDIA GPU, Volta architecture or later, with [compute capability](https://developer.nvidia.com/cuda-gpus) 7.0+
* CUDA 11.2, 11.4, 11.5, 11.8, 12.0 or 12.2
* Python version 3.9, 3.10, or 3.11
* NetworkX >= version 3.0 (version 3.3 or higher recommended) **This if for use of nx-cuGraph, [see below](#cugraph-using-networkx-code).**
acostadon marked this conversation as resolved.
Show resolved Hide resolved

## Installation
The latest RAPIDS System Requirements documentation is located [here](https://docs.rapids.ai/install#system-req)
This includes several ways to set up for cuGraph
* From Unix
* [Conda](https://docs.rapids.ai/install#wsl-conda)
* [Docker](https://docs.rapids.ai/install#wsl-docker)
* [pip](https://docs.rapids.ai/install#wsl-pip)
* To use RAPIDS in windows you must install [WSL2](https://learn.microsoft.com/en-us/windows/wsl/install)
* [Conda](https://docs.rapids.ai/install#wsl-conda)
* [Docker](https://docs.rapids.ai/install#wsl-docker)
* [pip](https://docs.rapids.ai/install#wsl-pip)
Build From Source

## CuGraph Using NetworkX Code
While the steps above are required to use the full suite of cuGraph graph analytics, cuGraph is now supported as a NetworkX backend using [nx-cugraph](https://docs.rapids.ai/api/cugraph/nightly/nx_cugraph/nx_cugraph/).
This is much simpler but limits users to the current but growing list of suppored algorithms.
acostadon marked this conversation as resolved.
Show resolved Hide resolved


## Cugraph API demo
2 changes: 1 addition & 1 deletion docs/cugraph/source/tutorials/how_to_guides.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# How To Guides
- Basic use of cuGraph, on the page
- [Basic use of cuGraph](./basic_cugraph.md)
- Property graph with analytic flow
- GNN – model building
- cuGraph Service – client/server setup and use (ucx)
Expand Down
Loading