Skip to content
This repository was archived by the owner on Aug 4, 2023. It is now read-only.

[WIP] Update readme to include intro notebooks #368

Open
wants to merge 2 commits into
base: branch-22.12
Choose a base branch
from
Open
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: 21 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,34 @@
# RAPIDS Notebooks

- [cuML Notebooks](https://github.com/rapidsai/cuml/tree/branch-22.12/notebooks)
- [cuGraph Notebooks](https://github.com/rapidsai/cugraph/tree/branch-22.12/notebooks)
- [CLX Notebooks](https://github.com/rapidsai/clx/tree/branch-22.12/notebooks)
- [cuSpatial Notebooks](https://github.com/rapidsai/cuspatial/tree/branch-22.12/notebooks)
- [cuxfilter Notebooks](https://github.com/rapidsai/cuxfilter/tree/branch-22.12/notebooks)
- [XGBoost Notebooks](https://github.com/rapidsai/xgboost-conda/tree/branch-22.12/notebooks)

## Intro

These notebooks provide examples of how to use RAPIDS. These notebooks are designed to be self-contained with the `runtime` version of the [RAPIDS Docker Container](https://hub.docker.com/r/rapidsai/rapidsai/) and [RAPIDS Nightly Docker Containers](https://hub.docker.com/r/rapidsai/rapidsai-nightly) and can run on air-gapped systems. You can quickly get this container using the install guide from the [RAPIDS.ai Getting Started page](https://rapids.ai/start.html#get-rapids)

## Quick Start

- [10 Minutes to cuDF](cudf/10min.ipynb) - Intro to GPU Accelerated Dataframes and ETL using [cuDF](https://github.com/rapidsai/cudf)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 This will be the right path for the cuDF intro notebook after #369 merges.

- [Estimator Intro](cuml/estimator_intro.ipynb) - Intro to GPU Accelerated Machine Learning using [cuML](https://github.com/rapidsai/cuml)
- [10 Minutes to cuGraph]() - GPU Accelerated Graph Analytics using [cuSpatial](https://github.com/rapidsai/cugraph)
- [10 Minutes to cuXFilter](cuxfilter/10_minutes_to_cuxfilter.ipynb) - Intro to GPU Accelerated, Interactive Data Visualations using [cuXFilter](https://github.com/rapidsai/cuxfilter)
- [cuSpatial API Examples]() - Intro to GPU Accelerated Spatial Analytics using [cuSpatial](https://github.com/rapidsai/cusignal)
- [10 Minutes to cuSignal]() - Intro to GPU Accelerated Signal Analytics using [cuSignal](https://github.com/rapidsai/cusignal)
- [10 Minutes to CLX](cuxfilter/10minu.ipynb) - Intro to Cyber Security Log Analytics using [CLX](https://github.com/rapidsai/cls) (if installed)

## Usage

This repository serves as a convenience for our developers and users as a colocation of all RAPIDS notebooks.

To get the latest notebook repo updates, run `./update.sh` or use the following command:

`git submodule update --init --remote --no-single-branch --depth 1`

## Repo Notebook Folder Locations

- [cuDF Notebooks](https://github.com/rapidsai/cudf/tree/branch-22.10/notebooks)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Update all these to say 22.12 instead of 22.10? We should point to the latest branch, I think. That way if we fix something it's reflected immediately in the notebooks.

- [cuML Notebooks](https://github.com/rapidsai/cuml/tree/branch-22.10/notebooks)
- [cuGraph Notebooks](https://github.com/rapidsai/cugraph/tree/branch-22.10/notebooks)
- [cuSpatial Notebooks](https://github.com/rapidsai/cuspatial/tree/branch-22.10/notebooks)
- [cuSignal Notebooks](https://github.com/rapidsai/cusignal/tree/branch-22.10/notebooks)
- [cuxfilter Notebooks](https://github.com/rapidsai/cuxfilter/tree/branch-22.10/notebooks)
- [XGBoost Notebooks](https://github.com/rapidsai/xgboost-conda/tree/branch-22.10/notebooks)
- [CLX Notebooks](https://github.com/rapidsai/clx/tree/branch-22.10/notebooks) (if installed)