Skip to content

Commit 917b9ad

Browse files
committed
add a CUDA.jl reference page
1 parent 46bd934 commit 917b9ad

File tree

2 files changed

+41
-2
lines changed

2 files changed

+41
-2
lines changed

docs/make.jl

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
using Documenter, Flux, NNlib, Functors, MLUtils, BSON, Optimisers, OneHotArrays, Zygote, ChainRulesCore, Plots, MLDatasets, Statistics, DataFrames
1+
using Documenter, Flux, NNlib, Functors, MLUtils, BSON, Optimisers, OneHotArrays, Zygote, ChainRulesCore, Plots, MLDatasets, Statistics, DataFrames, CUDA
22

33

44
DocMeta.setdocmeta!(Flux, :DocTestSetup, :(using Flux); recursive = true)
55

66
makedocs(
7-
modules = [Flux, NNlib, Functors, MLUtils, BSON, Optimisers, OneHotArrays, Zygote, ChainRulesCore, Base, Plots, MLDatasets, Statistics, DataFrames],
7+
modules = [Flux, NNlib, Functors, MLUtils, BSON, Optimisers, OneHotArrays, Zygote, ChainRulesCore, Base, Plots, MLDatasets, Statistics, DataFrames, CUDA],
88
doctest = false,
99
sitename = "Flux",
1010
# strict = [:cross_references,],
@@ -35,6 +35,7 @@ makedocs(
3535
"Shape Inference 📚" => "outputsize.md",
3636
"Flat vs. Nested 📚" => "destructure.md",
3737
"Callback Helpers 📚" => "training/callbacks.md",
38+
"CUDA.jl 📚 (`cu`, `CuIterator`, ...)" => "CUDA.md",
3839
"NNlib.jl 📚 (`softmax`, `conv`, ...)" => "models/nnlib.md",
3940
"Zygote.jl 📚 (`gradient`, ...)" => "training/zygote.md",
4041
"MLUtils.jl 📚 (`DataLoader`, ...)" => "data/mlutils.md",

docs/src/CUDA.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# CUDA.jl
2+
3+
I'm not entirely sure this page should be separate from the gpu.md page.
4+
5+
6+
## Arrays
7+
8+
```@docs
9+
CUDA.cu
10+
CUDA.AbstractGPUArray
11+
CUDA.CuIterator
12+
```
13+
14+
```@docs
15+
CUDA.allowscalar
16+
```
17+
18+
```@docs
19+
Flux.gpu
20+
Flux.cpu
21+
```
22+
23+
24+
## Devices
25+
26+
```@docs
27+
CUDA.functional
28+
CUDA.device
29+
CUDA.device!
30+
```
31+
32+
33+
## Benchmarking
34+
35+
```@docs
36+
CUDA.@time
37+
CUDA.@sync
38+
```

0 commit comments

Comments
 (0)