77 </p >
88
99 <h3 >
10- <a href="guide">Guide</a>
10+ <a href="https://rust-gpu.github.io/Rust-CUDA/ guide/index.html ">Guide</a>
1111 <span> | </span>
1212 <a href="guide/src/guide/getting_started.md">Getting Started</a>
1313 <span> | </span>
1414 <a href="guide/src/features.md">Features</a>
1515 </h3 >
16- <strong >⚠️ The project is still in early development, expect bugs, safety issues, and things that don't work ⚠️</strong >
16+ <strong >⚠️ The project is still in early development, expect bugs, safety issues, and things that don't work ⚠️</strong >
1717</div >
1818
19+ <br />
20+
21+ > [ !IMPORTANT]
22+ > This project is no longer dormant and is [ being
23+ > rebooted] ( https://rust-gpu.github.io/blog/2025/01/27/rust-cuda-reboot ) .
24+ > Please contribute!
25+
1926## Goal
2027
2128The Rust CUDA Project is a project aimed at making Rust a tier-1 language for extremely fast GPU computing
@@ -28,7 +35,7 @@ Historically, general purpose high performance GPU computing has been done using
2835provides a way to use Fortran/C/C++ code for GPU computing in tandem with CPU code with a single source. It also provides
2936many libraries, tools, forums, and documentation to supplement the single-source CPU/GPU code.
3037
31- CUDA is exclusively an NVIDIA-only toolkit. Many tools have been proposed for cross-platform GPU computing such as
38+ CUDA is exclusively an NVIDIA-only toolkit. Many tools have been proposed for cross-platform GPU computing such as
3239OpenCL, Vulkan Computing, and HIP. However, CUDA remains the most used toolkit for such tasks by far. This is why it is
3340imperative to make Rust a viable option for use with the CUDA toolkit.
3441
@@ -38,12 +45,12 @@ in recent years it has been shown time and time again that a specialized solutio
3845of projects such as rust-gpu (for Rust -> SPIR-V).
3946
4047Our hope is that with this project we can push the Rust GPU computing industry forward and make Rust an excellent language
41- for such tasks. Rust offers plenty of benefits such as ` __restrict__ ` performance benefits for every kernel, An excellent module/crate system,
48+ for such tasks. Rust offers plenty of benefits such as ` __restrict__ ` performance benefits for every kernel, An excellent module/crate system,
4249delimiting of unsafe areas of CPU/GPU code with ` unsafe ` , high level wrappers to low level CUDA libraries, etc.
4350
4451## Structure
4552
46- The scope of the Rust CUDA Project is quite broad, it spans the entirety of the CUDA ecosystem, with libraries and tools to make it
53+ The scope of the Rust CUDA Project is quite broad, it spans the entirety of the CUDA ecosystem, with libraries and tools to make it
4754usable using Rust. Therefore, the project contains many crates for all corners of the CUDA ecosystem.
4855
4956The current line-up of libraries is the following:
@@ -52,7 +59,7 @@ The current line-up of libraries is the following:
5259 - Generates highly optimized PTX code which can be loaded by the CUDA Driver API to execute on the GPU.
5360 - For the near future it will be CUDA-only, but it may be used to target amdgpu in the future.
5461- ` cuda_std ` for GPU-side functions and utilities, such as thread index queries, memory allocation, warp intrinsics, etc.
55- - * Not * a low level library, provides many utility functions to make it easier to write cleaner and more reliable GPU kernels.
62+ - _ Not _ a low level library, provides many utility functions to make it easier to write cleaner and more reliable GPU kernels.
5663 - Closely tied to ` rustc_codegen_nvvm ` which exposes GPU features through it internally.
5764- [ ` cudnn ` ] ( https://github.com/Rust-GPU/Rust-CUDA/tree/master/crates/cudnn ) for a collection of GPU-accelerated primitives for deep neural networks.
5865- ` cust ` for CPU-side CUDA features such as launching GPU kernels, GPU memory allocation, device queries, etc.
@@ -67,12 +74,23 @@ In addition to many "glue" crates for things such as high level wrappers for cer
6774## Related Projects
6875
6976Other projects related to using Rust on the GPU:
77+
7078- 2016: [ glassful] ( https://github.com/kmcallister/glassful ) Subset of Rust that compiles to GLSL.
7179- 2017: [ inspirv-rust] ( https://github.com/msiglreith/inspirv-rust ) Experimental Rust MIR -> SPIR-V Compiler.
7280- 2018: [ nvptx] ( https://github.com/japaric-archived/nvptx ) Rust to PTX compiler using the ` nvptx ` target for rustc (using the LLVM PTX backend).
73- - 2020: [ accel] ( https://github.com/termoshtt/accel ) Higher level library that relied on the same mechanism that ` nvptx ` does.
81+ - 2020: [ accel] ( https://github.com/termoshtt/accel ) Higher- level library that relied on the same mechanism that ` nvptx ` does.
7482- 2020: [ rlsl] ( https://github.com/MaikKlein/rlsl ) Experimental Rust -> SPIR-V compiler (predecessor to rust-gpu)
75- - 2020: [ rust-gpu] ( https://github.com/EmbarkStudios/rust-gpu ) Rustc codegen backend to compile Rust to SPIR-V for use in shaders, similar mechanism as our project.
83+ - 2020: [ rust-gpu] ( https://github.com/Rust-GPU/rust-gpu ) ` rustc ` compiler backend to compile Rust to SPIR-V for use in shaders, similar mechanism as our project.
84+
85+ ## Usage
86+ ``` bash
87+ # # setup your environment like:
88+ # ## export OPTIX_ROOT=/opt/NVIDIA-OptiX-SDK-9.0.0-linux64-x86_64
89+ # ## export OPTIX_ROOT_DIR=/opt/NVIDIA-OptiX-SDK-9.0.0-linux64-x86_64
90+
91+ # # build proj
92+ cargo build
93+ ```
7694
7795## License
7896
@@ -86,4 +104,3 @@ at your discretion.
86104### Contribution
87105
88106Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.
89-
0 commit comments