|
6 | 6 | //! provides unsafe functions for retrieving and setting handles to raw CUDA objects. |
7 | 7 | //! This allows advanced users to embed libraries that rely on CUDA, such as OptiX. |
8 | 8 | //! |
9 | | -//! # CUDA Terminology: |
| 9 | +//! # CUDA Terminology |
10 | 10 | //! |
11 | | -//! ## Devices and Hosts: |
| 11 | +//! ## Devices and Hosts |
12 | 12 | //! |
13 | 13 | //! This crate and its documentation uses the terms "device" and "host" frequently, so it's worth |
14 | 14 | //! explaining them in more detail. A device refers to a CUDA-capable GPU or similar device and its |
15 | 15 | //! associated external memory space. The host is the CPU and its associated memory space. Data |
16 | 16 | //! must be transferred from host memory to device memory before the device can use it for |
17 | 17 | //! computations, and the results must then be transferred back to host memory. |
18 | 18 | //! |
19 | | -//! ## Contexts, Modules, Streams and Functions: |
| 19 | +//! ## Contexts, Modules, Streams and Functions |
20 | 20 | //! |
21 | 21 | //! A CUDA context is akin to a process on the host - it contains all of the state for working with |
22 | 22 | //! a device, all memory allocations, etc. Each context is associated with a single device. |
|
30 | 30 | //! stream. Work within a single stream will execute sequentially in the order that it was |
31 | 31 | //! submitted, and may interleave with work from other streams. |
32 | 32 | //! |
33 | | -//! ## Grids, Blocks and Threads: |
| 33 | +//! ## Grids, Blocks and Threads |
34 | 34 | //! |
35 | 35 | //! CUDA devices typically execute kernel functions on many threads in parallel. These threads can |
36 | 36 | //! be grouped into thread blocks, which share an area of fast hardware memory known as shared |
|
44 | 44 | //! hand, if the thread blocks are too small each processor will be under-utilized and the |
45 | 45 | //! code will be unable to make effective use of shared memory. |
46 | 46 | //! |
47 | | -//! # Usage: |
| 47 | +//! # Usage |
48 | 48 | //! |
49 | 49 | //! Before using cust, you must install the CUDA development libraries for your system. Version |
50 | 50 | //! 9.0 or newer is required. You must also have a CUDA-capable GPU installed with the appropriate |
|
0 commit comments