Skip to content

Improve examples README. #344

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.

Sign up for GitHub

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

Open
nnethercote wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Improve examples README. #344

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
27 changes: 20 additions & 7 deletions examples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,36 @@
# CUDA + Rust examples

The examples in here showcase both the GPU side and the CPU side of writing a tool which uses the GPU.
The examples in here showcase both the GPU side and the CPU side of writing a tool which uses the
GPU.

## Available Examples

### [vecadd](vecadd)

A simple vector addition example demonstrating basic CUDA kernel usage.

### [gemm](gemm)

General Matrix Multiplication (GEMM) implementation showing more complex CUDA operations.

### [i128_demo](i128_demo)

A simple demo that uses 128-bit integer operations.

### [sha2_crates_io](sha2_crates_io)
Demonstrates using an existing Rust crate ([`sha2`](https://crates.io/crates/sha2) from crates.io) on both CPU and GPU without modification. Shows that the same cryptographic hashing code can run on CUDA, producing identical results to the CPU implementation.

### [Interactive Path Tracer](path_tracer)
A very simple interactive Path Tracer inspired by [Ray Tracing In One Weekend](https://raytracing.github.io/books/RayTracingInOneWeekend.html)
which runs on CPU or GPU, with the additional option of running OptiX denoising.
Demonstrates using an existing Rust crate ([`sha2`](https://crates.io/crates/sha2) from crates.io)
on both CPU and GPU without modification. Shows that the same cryptographic hashing code can run on
CUDA, producing identical results to the CPU implementation.

### [Interactive Path Tracer](../crates/optix/examples/path_tracer/)

A very simple interactive Path Tracer inspired by [Ray Tracing In One
Weekend](https://raytracing.github.io/books/RayTracingInOneWeekend.html) which runs on CPU or GPU,
with the additional option of running OptiX denoising.

![Path Tracer](assets/path_tracer.png)

The Path Tracer uses cuda_builder to compile the core path tracer for the GPU and GPU (hardware raytracing), and uses the core path tracer as a normal crate
for CPU rendering and sharing structures.
The Path Tracer uses `cuda_builder` to compile the core path tracer for the GPU and GPU (hardware
raytracing), and uses the core path tracer as a normal crate for CPU rendering and sharing
structures.