add a CUDA.jl reference page

FluxML · Nov 28, 2022 · 917b9ad · 917b9ad
1 parent 46bd934
commit 917b9ad
Show file tree

Hide file tree

Showing 2 changed files with 41 additions and 2 deletions.
diff --git a/docs/make.jl b/docs/make.jl
@@ -1,10 +1,10 @@
-using Documenter, Flux, NNlib, Functors, MLUtils, BSON, Optimisers, OneHotArrays, Zygote, ChainRulesCore, Plots, MLDatasets, Statistics, DataFrames
+using Documenter, Flux, NNlib, Functors, MLUtils, BSON, Optimisers, OneHotArrays, Zygote, ChainRulesCore, Plots, MLDatasets, Statistics, DataFrames, CUDA
 
 
 DocMeta.setdocmeta!(Flux, :DocTestSetup, :(using Flux); recursive = true)
 
 makedocs(
-    modules = [Flux, NNlib, Functors, MLUtils, BSON, Optimisers, OneHotArrays, Zygote, ChainRulesCore, Base, Plots, MLDatasets, Statistics, DataFrames],
+    modules = [Flux, NNlib, Functors, MLUtils, BSON, Optimisers, OneHotArrays, Zygote, ChainRulesCore, Base, Plots, MLDatasets, Statistics, DataFrames, CUDA],
     doctest = false,
     sitename = "Flux",
     # strict = [:cross_references,],
@@ -35,6 +35,7 @@ makedocs(
             "Shape Inference 📚" => "outputsize.md",
             "Flat vs. Nested 📚" => "destructure.md",
             "Callback Helpers 📚" => "training/callbacks.md",
+            "CUDA.jl 📚 (`cu`, `CuIterator`, ...)" => "CUDA.md",
             "NNlib.jl 📚 (`softmax`, `conv`, ...)" => "models/nnlib.md",
             "Zygote.jl 📚 (`gradient`, ...)" => "training/zygote.md",
             "MLUtils.jl 📚 (`DataLoader`, ...)" => "data/mlutils.md",

diff --git a/docs/src/CUDA.md b/docs/src/CUDA.md
@@ -0,0 +1,38 @@
+# CUDA.jl
+
+I'm not entirely sure this page should be separate from the gpu.md page. 
+
+
+## Arrays
+
+```@docs
+CUDA.cu
+CUDA.AbstractGPUArray
+CUDA.CuIterator
+```
+
+```@docs
+CUDA.allowscalar
+```
+
+```@docs
+Flux.gpu
+Flux.cpu
+```
+
+
+## Devices
+
+```@docs
+CUDA.functional
+CUDA.device
+CUDA.device!
+```
+
+
+## Benchmarking
+
+```@docs
+CUDA.@time
+CUDA.@sync
+```