From fb96d4355719d955a69abd6b1a5a334695523caa Mon Sep 17 00:00:00 2001 From: Guillaume Dalle <22795598+gdalle@users.noreply.github.com> Date: Fri, 14 Nov 2025 07:00:41 +0100 Subject: [PATCH 1/3] Add autodocs for all libraries [only docs] --- docs/Manifest.toml | 590 +++++++++++++++++++++++-- docs/Project.toml | 12 + docs/make.jl | 56 ++- docs/src/lib/cublas.md | 15 + docs/src/lib/{driver.md => cudadrv.md} | 0 docs/src/lib/cudnn.md | 15 + docs/src/lib/cufft.md | 15 + docs/src/lib/cupti.md | 15 + docs/src/lib/curand.md | 15 + docs/src/lib/cusolver.md | 15 + docs/src/lib/cusparse.md | 15 + docs/src/lib/custatevec.md | 15 + docs/src/lib/cutensor.md | 15 + docs/src/lib/cutensornet.md | 15 + docs/src/lib/nvml.md | 15 + docs/src/lib/utils.md | 15 + 16 files changed, 787 insertions(+), 51 deletions(-) create mode 100644 docs/src/lib/cublas.md rename docs/src/lib/{driver.md => cudadrv.md} (100%) create mode 100644 docs/src/lib/cudnn.md create mode 100644 docs/src/lib/cufft.md create mode 100644 docs/src/lib/cupti.md create mode 100644 docs/src/lib/curand.md create mode 100644 docs/src/lib/cusolver.md create mode 100644 docs/src/lib/cusparse.md create mode 100644 docs/src/lib/custatevec.md create mode 100644 docs/src/lib/cutensor.md create mode 100644 docs/src/lib/cutensornet.md create mode 100644 docs/src/lib/nvml.md create mode 100644 docs/src/lib/utils.md diff --git a/docs/Manifest.toml b/docs/Manifest.toml index 417b39ad92..d59f3f95c8 100644 --- a/docs/Manifest.toml +++ b/docs/Manifest.toml @@ -1,19 +1,44 @@ # This file is machine-generated - editing it directly is not advised -julia_version = "1.11.1" +julia_version = "1.11.7" manifest_format = "2.0" -project_hash = "6c410e1592b1ac84dd1503e3fcd6e926ea9ab085" +project_hash = "a22688fbedb65f7da8b47016f9ddd4744524f500" [[deps.ANSIColoredPrinters]] git-tree-sha1 = "574baf8110975760d391c710b6341da1afa48d8c" uuid = "a4c015fc-c6ff-483c-b24f-f7ea428134e9" version = "0.0.1" +[[deps.AbstractFFTs]] +deps = ["LinearAlgebra"] +git-tree-sha1 = "d92ad398961a3ed262d8bf04a1a2b8340f915fef" +uuid = "621f4979-c628-5d54-868e-fcf4e3e8185c" +version = "1.5.0" + + [deps.AbstractFFTs.extensions] + AbstractFFTsChainRulesCoreExt = "ChainRulesCore" + AbstractFFTsTestExt = "Test" + + [deps.AbstractFFTs.weakdeps] + ChainRulesCore = "d360d2e6-b24c-11e9-a2a3-2a2ae2dbcce4" + Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40" + [[deps.AbstractTrees]] git-tree-sha1 = "2d9c9a55f9c93e8887ad391fbae72f8ef55e1177" uuid = "1520ce14-60c1-5f80-bbc7-55ef81b5835c" version = "0.4.5" +[[deps.Adapt]] +deps = ["LinearAlgebra", "Requires"] +git-tree-sha1 = "7e35fca2bdfba44d797c53dfe63a51fabf39bfc0" +uuid = "79e6a3ab-5dfb-504d-930d-738a2a938a0e" +version = "4.4.0" +weakdeps = ["SparseArrays", "StaticArrays"] + + [deps.Adapt.extensions] + AdaptSparseArraysExt = "SparseArrays" + AdaptStaticArraysExt = "StaticArrays" + [[deps.ArgTools]] uuid = "0dad84c5-d112-42e6-8d28-ef12dabb789f" version = "1.1.2" @@ -22,43 +47,178 @@ version = "1.1.2" uuid = "56f22d72-fd6d-98f1-02f0-08ddc0907c33" version = "1.11.0" +[[deps.Atomix]] +deps = ["UnsafeAtomics"] +git-tree-sha1 = "29bb0eb6f578a587a49da16564705968667f5fa8" +uuid = "a9b6321e-bd34-4604-b9c9-b65b8de01458" +version = "1.1.2" + + [deps.Atomix.extensions] + AtomixCUDAExt = "CUDA" + AtomixMetalExt = "Metal" + AtomixOpenCLExt = "OpenCL" + AtomixoneAPIExt = "oneAPI" + + [deps.Atomix.weakdeps] + CUDA = "052768ef-5323-5732-b1bb-66c8b64840ba" + Metal = "dde4c033-4e86-420c-a63e-0dd931031962" + OpenCL = "08131aa3-fb12-5dee-8b74-c09406e224a2" + oneAPI = "8f75cd03-7ff8-4ecb-9b8f-daf728133b1b" + +[[deps.BFloat16s]] +deps = ["LinearAlgebra", "Printf", "Random"] +git-tree-sha1 = "0a6d6d072cb5f2baeba7667023075801f6ea4a7d" +uuid = "ab4f0b2a-ad5b-11e8-123f-65d77653426b" +version = "0.6.0" + [[deps.Base64]] uuid = "2a0f44e3-6c83-55bd-87e4-b1978d98bd5f" version = "1.11.0" [[deps.BenchmarkTools]] -deps = ["JSON", "Logging", "Printf", "Profile", "Statistics", "UUIDs"] -git-tree-sha1 = "f1dff6729bc61f4d49e140da1af55dcd1ac97b2f" +deps = ["Compat", "JSON", "Logging", "Printf", "Profile", "Statistics", "UUIDs"] +git-tree-sha1 = "7fecfb1123b8d0232218e2da0c213004ff15358d" uuid = "6e4b80f9-dd63-53aa-95a3-0cdb28fa8baf" -version = "1.5.0" +version = "1.6.3" + +[[deps.CEnum]] +git-tree-sha1 = "389ad5c84de1ae7cf0e28e381131c98ea87d54fc" +uuid = "fa961155-64e5-5f13-b03f-caf6b980ea82" +version = "0.5.0" + +[[deps.CUDA]] +deps = ["AbstractFFTs", "Adapt", "BFloat16s", "CEnum", "CUDA_Compiler_jll", "CUDA_Driver_jll", "CUDA_Runtime_Discovery", "CUDA_Runtime_jll", "Crayons", "DataFrames", "ExprTools", "GPUArrays", "GPUCompiler", "GPUToolbox", "KernelAbstractions", "LLVM", "LLVMLoopInfo", "LazyArtifacts", "Libdl", "LinearAlgebra", "Logging", "NVTX", "Preferences", "PrettyTables", "Printf", "Random", "Random123", "RandomNumbers", "Reexport", "Requires", "SparseArrays", "StaticArrays", "Statistics", "demumble_jll"] +path = ".." +uuid = "052768ef-5323-5732-b1bb-66c8b64840ba" +version = "5.9.3" + + [deps.CUDA.extensions] + ChainRulesCoreExt = "ChainRulesCore" + EnzymeCoreExt = "EnzymeCore" + SparseMatricesCSRExt = "SparseMatricesCSR" + SpecialFunctionsExt = "SpecialFunctions" + + [deps.CUDA.weakdeps] + ChainRulesCore = "d360d2e6-b24c-11e9-a2a3-2a2ae2dbcce4" + EnzymeCore = "f151be2c-9106-41f4-ab19-57ee4f262869" + SparseMatricesCSR = "a0a7dd2c-ebf4-11e9-1f05-cf50bc540ca1" + SpecialFunctions = "276daf66-3868-5448-9aa4-cd146d93841b" + +[[deps.CUDA_Compiler_jll]] +deps = ["Artifacts", "CUDA_Driver_jll", "CUDA_Runtime_jll", "JLLWrappers", "LazyArtifacts", "Libdl", "TOML"] +git-tree-sha1 = "b63428872a0f60d87832f5899369837cd930b76d" +uuid = "d1e2174e-dfdc-576e-b43e-73b79eb1aca8" +version = "0.3.0+0" + +[[deps.CUDA_Driver_jll]] +deps = ["Artifacts", "JLLWrappers", "Libdl", "Pkg"] +git-tree-sha1 = "2023be0b10c56d259ea84a94dbfc021aa452f2c6" +uuid = "4ee394cb-3365-5eb0-8335-949819d2adfc" +version = "13.0.2+0" + +[[deps.CUDA_Runtime_Discovery]] +deps = ["Libdl"] +git-tree-sha1 = "f9a521f52d236fe49f1028d69e549e7f2644bb72" +uuid = "1af6417a-86b4-443c-805f-a4643ffb695f" +version = "1.0.0" + +[[deps.CUDA_Runtime_jll]] +deps = ["Artifacts", "CUDA_Driver_jll", "JLLWrappers", "LazyArtifacts", "Libdl", "TOML"] +git-tree-sha1 = "92cd84e2b760e471d647153ea5efc5789fc5e8b2" +uuid = "76a88914-d11a-5bdc-97e0-2f5a05c973a2" +version = "0.19.2+0" + +[[deps.CUDNN_jll]] +deps = ["Artifacts", "CUDA_Runtime_jll", "JLLWrappers", "LazyArtifacts", "Libdl", "TOML"] +git-tree-sha1 = "cf92130f820a5c92607e2a333d2d86d9bf30a694" +uuid = "62b44479-cb7b-5706-934f-f13b2eb2e645" +version = "9.13.0+0" + +[[deps.CUTENSOR_jll]] +deps = ["Artifacts", "CUDA_Runtime_jll", "CompilerSupportLibraries_jll", "JLLWrappers", "LazyArtifacts", "Libdl", "TOML"] +git-tree-sha1 = "70d3e03b381c8ed5ea385930078d6240b575cd8a" +uuid = "35b6c64b-1ee1-5834-92a3-3f624899209a" +version = "2.3.1+0" [[deps.CodecZlib]] deps = ["TranscodingStreams", "Zlib_jll"] -git-tree-sha1 = "bce6804e5e6044c6daab27bb533d1295e4a2e759" +git-tree-sha1 = "962834c22b66e32aa10f7611c08c8ca4e20749a9" uuid = "944b1d66-785c-5afd-91f1-9de20f533193" -version = "0.7.6" +version = "0.7.8" + +[[deps.ColorTypes]] +deps = ["FixedPointNumbers", "Random"] +git-tree-sha1 = "67e11ee83a43eb71ddc950302c53bf33f0690dfe" +uuid = "3da002f7-5984-5a60-b8a6-cbb66c0b333f" +version = "0.12.1" +weakdeps = ["StyledStrings"] + + [deps.ColorTypes.extensions] + StyledStringsExt = "StyledStrings" + +[[deps.Colors]] +deps = ["ColorTypes", "FixedPointNumbers", "Reexport"] +git-tree-sha1 = "37ea44092930b1811e666c3bc38065d7d87fcc74" +uuid = "5ae59095-9a9b-59fe-a467-6f913c188581" +version = "0.13.1" + +[[deps.Compat]] +deps = ["TOML", "UUIDs"] +git-tree-sha1 = "9d8a54ce4b17aa5bdce0ea5c34bc5e7c340d16ad" +uuid = "34da2185-b29b-5c13-b0c7-acf172513d20" +version = "4.18.1" +weakdeps = ["Dates", "LinearAlgebra"] + + [deps.Compat.extensions] + CompatLinearAlgebraExt = "LinearAlgebra" [[deps.CompilerSupportLibraries_jll]] deps = ["Artifacts", "Libdl"] uuid = "e66e0078-7015-5450-92f7-15fbd957f2ae" version = "1.1.1+0" +[[deps.Crayons]] +git-tree-sha1 = "249fe38abf76d48563e2f4556bebd215aa317e15" +uuid = "a8cc5b0e-0ffa-5ad4-8c14-923d3ee1735f" +version = "4.1.1" + +[[deps.DataAPI]] +git-tree-sha1 = "abe83f3a2f1b857aac70ef8b269080af17764bbe" +uuid = "9a962f9c-6df0-11e9-0e5d-c546b8b5ee8a" +version = "1.16.0" + +[[deps.DataFrames]] +deps = ["Compat", "DataAPI", "DataStructures", "Future", "InlineStrings", "InvertedIndices", "IteratorInterfaceExtensions", "LinearAlgebra", "Markdown", "Missings", "PooledArrays", "PrecompileTools", "PrettyTables", "Printf", "Random", "Reexport", "SentinelArrays", "SortingAlgorithms", "Statistics", "TableTraits", "Tables", "Unicode"] +git-tree-sha1 = "d8928e9169ff76c6281f39a659f9bca3a573f24c" +uuid = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0" +version = "1.8.1" + +[[deps.DataStructures]] +deps = ["OrderedCollections"] +git-tree-sha1 = "e357641bb3e0638d353c4b29ea0e40ea644066a6" +uuid = "864edb3b-99cc-5e75-8d2d-829cb0a9cfe8" +version = "0.19.3" + +[[deps.DataValueInterfaces]] +git-tree-sha1 = "bfc1187b79289637fa0ef6d4436ebdfe6905cbd6" +uuid = "e2d170a0-9d28-54be-80f0-106bbe20a464" +version = "1.0.0" + [[deps.Dates]] deps = ["Printf"] uuid = "ade2ca70-3891-5945-98fb-dc099432e06a" version = "1.11.0" [[deps.DocStringExtensions]] -deps = ["LibGit2"] -git-tree-sha1 = "2fb1e02f2b635d0845df5d7c167fec4dd739b00d" +git-tree-sha1 = "7442a5dfe1ebb773c29cc2962a8980f47221d76c" uuid = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae" -version = "0.9.3" +version = "0.9.5" [[deps.Documenter]] -deps = ["ANSIColoredPrinters", "AbstractTrees", "Base64", "CodecZlib", "Dates", "DocStringExtensions", "Downloads", "Git", "IOCapture", "InteractiveUtils", "JSON", "LibGit2", "Logging", "Markdown", "MarkdownAST", "Pkg", "PrecompileTools", "REPL", "RegistryInstances", "SHA", "TOML", "Test", "Unicode"] -git-tree-sha1 = "5a1ee886566f2fa9318df1273d8b778b9d42712d" +deps = ["ANSIColoredPrinters", "AbstractTrees", "Base64", "CodecZlib", "Dates", "DocStringExtensions", "Downloads", "Git", "IOCapture", "InteractiveUtils", "JSON", "Logging", "Markdown", "MarkdownAST", "Pkg", "PrecompileTools", "REPL", "RegistryInstances", "SHA", "TOML", "Test", "Unicode"] +git-tree-sha1 = "352b9a04e74edd16429aec79f033620cf8e780d4" uuid = "e30172f5-a6a5-5a46-863b-614d45cd2de4" -version = "1.7.0" +version = "1.15.0" [[deps.Downloads]] deps = ["ArgTools", "FileWatching", "LibCURL", "NetworkOptions"] @@ -67,25 +227,82 @@ version = "1.6.0" [[deps.Expat_jll]] deps = ["Artifacts", "JLLWrappers", "Libdl"] -git-tree-sha1 = "1c6317308b9dc757616f0b5cb379db10494443a7" +git-tree-sha1 = "27af30de8b5445644e8ffe3bcb0d72049c089cf1" uuid = "2e619515-83b5-522b-bb60-26c02a35a201" -version = "2.6.2+0" +version = "2.7.3+0" + +[[deps.ExprTools]] +git-tree-sha1 = "27415f162e6028e81c72b82ef756bf321213b6ec" +uuid = "e2ba6199-217a-4e67-a87a-7c52f15ade04" +version = "0.1.10" [[deps.FileWatching]] uuid = "7b1f6079-737a-58dc-b8bc-7a2ca5c1b5ee" version = "1.11.0" +[[deps.FixedPointNumbers]] +deps = ["Statistics"] +git-tree-sha1 = "05882d6995ae5c12bb5f36dd2ed3f61c98cbb172" +uuid = "53c48c17-4a7d-5ca2-90c5-79b7896eea93" +version = "0.8.5" + +[[deps.Future]] +deps = ["Random"] +uuid = "9fa8497b-333b-5362-9e8d-4d0656e87820" +version = "1.11.0" + +[[deps.GPUArrays]] +deps = ["Adapt", "GPUArraysCore", "KernelAbstractions", "LLVM", "LinearAlgebra", "Printf", "Random", "Reexport", "ScopedValues", "Serialization", "Statistics"] +git-tree-sha1 = "8ddb438e956891a63a5367d7fab61550fc720026" +uuid = "0c68f7d7-f131-5f86-a1c3-88cf8149b2d7" +version = "11.2.6" + + [deps.GPUArrays.extensions] + JLD2Ext = "JLD2" + + [deps.GPUArrays.weakdeps] + JLD2 = "033835bb-8acc-5ee8-8aae-3f567f8a3819" + +[[deps.GPUArraysCore]] +deps = ["Adapt"] +git-tree-sha1 = "83cf05ab16a73219e5f6bd1bdfa9848fa24ac627" +uuid = "46192b85-c4d5-4398-a991-12ede77f4527" +version = "0.2.0" + +[[deps.GPUCompiler]] +deps = ["ExprTools", "InteractiveUtils", "LLVM", "Libdl", "Logging", "PrecompileTools", "Preferences", "Scratch", "Serialization", "TOML", "Tracy", "UUIDs"] +git-tree-sha1 = "c55c2f564230f1af2a975d927a814bcb47a63a50" +uuid = "61eb1bfa-7361-4325-ad38-22787b887f55" +version = "1.7.3" + +[[deps.GPUToolbox]] +deps = ["LLVM"] +git-tree-sha1 = "9e9186b09a13b7f094f87d1a9bb266d8780e1b1c" +uuid = "096a3bc2-3ced-46d0-87f4-dd12716f4bfc" +version = "1.0.0" + [[deps.Git]] -deps = ["Git_jll"] -git-tree-sha1 = "04eff47b1354d702c3a85e8ab23d539bb7d5957e" +deps = ["Git_LFS_jll", "Git_jll", "JLLWrappers", "OpenSSH_jll"] +git-tree-sha1 = "824a1890086880696fc908fe12a17bcf61738bd8" uuid = "d7ba0133-e1db-5d97-8f8c-041e4b3a1eb2" -version = "1.3.1" +version = "1.5.0" + +[[deps.Git_LFS_jll]] +deps = ["Artifacts", "JLLWrappers", "Libdl"] +git-tree-sha1 = "bb8471f313ed941f299aa53d32a94ab3bee08844" +uuid = "020c3dae-16b3-5ae5-87b3-4cb189e250b2" +version = "3.7.0+0" [[deps.Git_jll]] deps = ["Artifacts", "Expat_jll", "JLLWrappers", "LibCURL_jll", "Libdl", "Libiconv_jll", "OpenSSL_jll", "PCRE2_jll", "Zlib_jll"] -git-tree-sha1 = "ea372033d09e4552a04fd38361cd019f9003f4f4" +git-tree-sha1 = "b6a684587ebe896d9f68ae777f648205940f0f70" uuid = "f8c6e375-362e-5223-8a59-34ff63f689eb" -version = "2.46.2+0" +version = "2.51.3+0" + +[[deps.HashArrayMappedTries]] +git-tree-sha1 = "2eaa69a7cab70a52b9687c8bf950a5a93ec895ae" +uuid = "076d061b-32b6-4027-95e0-9a2c6f6d7e74" +version = "0.2.0" [[deps.IOCapture]] deps = ["Logging", "Random"] @@ -93,27 +310,109 @@ git-tree-sha1 = "b6d6bfdd7ce25b0f9b2f6b3dd56b2673a66c8770" uuid = "b5f81e59-6552-4d32-b1f0-c071b021bf89" version = "0.2.5" +[[deps.InlineStrings]] +git-tree-sha1 = "8f3d257792a522b4601c24a577954b0a8cd7334d" +uuid = "842dd82b-1e85-43dc-bf29-5d0ee9dffc48" +version = "1.4.5" + + [deps.InlineStrings.extensions] + ArrowTypesExt = "ArrowTypes" + ParsersExt = "Parsers" + + [deps.InlineStrings.weakdeps] + ArrowTypes = "31f734f8-188a-4ce0-8406-c8a06bd891cd" + Parsers = "69de0a69-1ddd-5017-9359-2bf0b02dc9f0" + [[deps.InteractiveUtils]] deps = ["Markdown"] uuid = "b77e0a4c-d291-57a0-90e8-8db25a27a240" version = "1.11.0" +[[deps.InvertedIndices]] +git-tree-sha1 = "6da3c4316095de0f5ee2ebd875df8721e7e0bdbe" +uuid = "41ab1584-1d38-5bbf-9106-f11c6c58b48f" +version = "1.3.1" + +[[deps.IteratorInterfaceExtensions]] +git-tree-sha1 = "a3f24677c21f5bbe9d2a714f95dcd58337fb2856" +uuid = "82899510-4779-5014-852e-03e436cf321d" +version = "1.0.0" + [[deps.JLLWrappers]] deps = ["Artifacts", "Preferences"] -git-tree-sha1 = "be3dc50a92e5a386872a493a10050136d4703f9b" +git-tree-sha1 = "0533e564aae234aff59ab625543145446d8b6ec2" uuid = "692b3bcd-3c85-4b1f-b108-f13ce0eb3210" -version = "1.6.1" +version = "1.7.1" [[deps.JSON]] -deps = ["Dates", "Mmap", "Parsers", "Unicode"] -git-tree-sha1 = "31e996f0a15c7b280ba9f76636b3ff9e2ae58c9a" +deps = ["Dates", "Logging", "Parsers", "PrecompileTools", "StructUtils", "UUIDs", "Unicode"] +git-tree-sha1 = "eb04df293213df64ddd720c86de3c431f5f8ccf1" uuid = "682c06a0-de6a-54ab-a142-c8b1cf79cde6" -version = "0.21.4" +version = "1.2.1" + + [deps.JSON.extensions] + JSONArrowExt = ["ArrowTypes"] + + [deps.JSON.weakdeps] + ArrowTypes = "31f734f8-188a-4ce0-8406-c8a06bd891cd" + +[[deps.JuliaNVTXCallbacks_jll]] +deps = ["Artifacts", "JLLWrappers", "Libdl", "Pkg"] +git-tree-sha1 = "af433a10f3942e882d3c671aacb203e006a5808f" +uuid = "9c1d0b0a-7046-5b2e-a33f-ea22f176ac7e" +version = "0.2.1+0" + +[[deps.KernelAbstractions]] +deps = ["Adapt", "Atomix", "InteractiveUtils", "MacroTools", "PrecompileTools", "Requires", "StaticArrays", "UUIDs"] +git-tree-sha1 = "b5a371fcd1d989d844a4354127365611ae1e305f" +uuid = "63c18a36-062a-441e-b654-da1e3ab1ce7c" +version = "0.9.39" + + [deps.KernelAbstractions.extensions] + EnzymeExt = "EnzymeCore" + LinearAlgebraExt = "LinearAlgebra" + SparseArraysExt = "SparseArrays" + + [deps.KernelAbstractions.weakdeps] + EnzymeCore = "f151be2c-9106-41f4-ab19-57ee4f262869" + LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e" + SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf" + +[[deps.LLVM]] +deps = ["CEnum", "LLVMExtra_jll", "Libdl", "Preferences", "Printf", "Unicode"] +git-tree-sha1 = "ce8614210409eaa54ed5968f4b50aa96da7ae543" +uuid = "929cbde3-209d-540e-8aea-75f648917ca0" +version = "9.4.4" +weakdeps = ["BFloat16s"] + + [deps.LLVM.extensions] + BFloat16sExt = "BFloat16s" + +[[deps.LLVMExtra_jll]] +deps = ["Artifacts", "JLLWrappers", "LazyArtifacts", "Libdl", "TOML"] +git-tree-sha1 = "8e76807afb59ebb833e9b131ebf1a8c006510f33" +uuid = "dad2f222-ce93-54a1-a47d-0025e8a3acab" +version = "0.0.38+0" + +[[deps.LLVMLoopInfo]] +git-tree-sha1 = "2e5c102cfc41f48ae4740c7eca7743cc7e7b75ea" +uuid = "8b046642-f1f6-4319-8d3c-209ddc03c586" +version = "1.0.0" + +[[deps.LaTeXStrings]] +git-tree-sha1 = "dda21b8cbd6a6c40d9d02a73230f9d70fed6918c" +uuid = "b964fa9f-0449-5b57-a5c2-d3ea65f4040f" +version = "1.4.0" [[deps.LazilyInitializedFields]] -git-tree-sha1 = "8f7f3cabab0fd1800699663533b6d5cb3fc0e612" +git-tree-sha1 = "0f2da712350b020bc3957f269c9caad516383ee0" uuid = "0e77f7df-68c5-4e49-93ce-4cd80f5598bf" -version = "1.2.2" +version = "1.3.0" + +[[deps.LazyArtifacts]] +deps = ["Artifacts", "Pkg"] +uuid = "4af54fe1-eca0-43a8-85a7-787d91b784e3" +version = "1.11.0" [[deps.LibCURL]] deps = ["LibCURL_jll", "MozillaCACerts_jll"] @@ -140,15 +439,21 @@ deps = ["Artifacts", "Libdl", "MbedTLS_jll"] uuid = "29816b5a-b9ab-546f-933c-edad1886dfa8" version = "1.11.0+1" +[[deps.LibTracyClient_jll]] +deps = ["Artifacts", "JLLWrappers", "Libdl"] +git-tree-sha1 = "d2bc4e1034b2d43076b50f0e34ea094c2cb0a717" +uuid = "ad6e5548-8b26-5c9f-8ef3-ef0ad883f3a5" +version = "0.9.1+6" + [[deps.Libdl]] uuid = "8f399da3-3557-5675-b5ff-fb832c97cbdb" version = "1.11.0" [[deps.Libiconv_jll]] deps = ["Artifacts", "JLLWrappers", "Libdl"] -git-tree-sha1 = "f9557a255370125b405568f9767d6d195822a175" +git-tree-sha1 = "be484f5c92fad0bd8acfef35fe017900b0b73809" uuid = "94ce4f54-9a6c-5748-9c1c-f9c7231a4531" -version = "1.17.0+0" +version = "1.18.0+0" [[deps.LinearAlgebra]] deps = ["Libdl", "OpenBLAS_jll", "libblastrampoline_jll"] @@ -165,6 +470,11 @@ version = "2.20.1" uuid = "56ddb016-857b-54e1-b83d-db4d58db5568" version = "1.11.0" +[[deps.MacroTools]] +git-tree-sha1 = "1e0228a030642014fe5cfe68c2c0a818f9e3f522" +uuid = "1914dd2f-81c6-5fcd-8719-6d5c9610ff09" +version = "0.5.16" + [[deps.Markdown]] deps = ["Base64"] uuid = "d6f4376e-aef5-505a-96c1-9c027394607a" @@ -181,14 +491,28 @@ deps = ["Artifacts", "Libdl"] uuid = "c8ffd9c3-330d-5841-b78e-0817d7145fa1" version = "2.28.6+0" -[[deps.Mmap]] -uuid = "a63ad114-7e13-5084-954f-fe012c677804" -version = "1.11.0" +[[deps.Missings]] +deps = ["DataAPI"] +git-tree-sha1 = "ec4f7fbeab05d7747bdf98eb74d130a2a2ed298d" +uuid = "e1d29d7a-bbdc-5cf2-9ac0-f12de2c33e28" +version = "1.2.0" [[deps.MozillaCACerts_jll]] uuid = "14a3606d-f60d-562e-9121-12d972cd8159" version = "2023.12.12" +[[deps.NVTX]] +deps = ["Colors", "JuliaNVTXCallbacks_jll", "Libdl", "NVTX_jll"] +git-tree-sha1 = "6b573a3e66decc7fc747afd1edbf083ff78c813a" +uuid = "5da4648a-3479-48b8-97b9-01cb529c0a1f" +version = "1.0.1" + +[[deps.NVTX_jll]] +deps = ["Artifacts", "JLLWrappers", "Libdl"] +git-tree-sha1 = "af2232f69447494514c25742ba1503ec7e9877fe" +uuid = "e98f9f5b-d649-5603-91fd-7774390e6439" +version = "3.2.2+0" + [[deps.NetworkOptions]] uuid = "ca575930-c2e3-43a9-ace4-1e988b2c1908" version = "1.2.0" @@ -198,11 +522,22 @@ deps = ["Artifacts", "CompilerSupportLibraries_jll", "Libdl"] uuid = "4536629a-c528-5b80-bd46-f80d51c5b363" version = "0.3.27+1" +[[deps.OpenSSH_jll]] +deps = ["Artifacts", "JLLWrappers", "Libdl", "OpenSSL_jll", "Zlib_jll"] +git-tree-sha1 = "301412a644646fdc0ad67d0a87487466b491e53d" +uuid = "9bd350c2-7e96-507f-8002-3f2e150b4e1b" +version = "10.2.1+0" + [[deps.OpenSSL_jll]] deps = ["Artifacts", "JLLWrappers", "Libdl"] -git-tree-sha1 = "7493f61f55a6cce7325f197443aa80d32554ba10" +git-tree-sha1 = "f19301ae653233bc88b1810ae908194f07f8db9d" uuid = "458c3c95-2e84-50aa-8efc-19380b2a3a95" -version = "3.0.15+1" +version = "3.5.4+0" + +[[deps.OrderedCollections]] +git-tree-sha1 = "05868e21324cede2207c6f0f466b4bfef6d5e7ee" +uuid = "bac558e1-5e72-5ebc-8fee-abe8a469f55d" +version = "1.8.1" [[deps.PCRE2_jll]] deps = ["Artifacts", "Libdl"] @@ -211,9 +546,9 @@ version = "10.42.0+1" [[deps.Parsers]] deps = ["Dates", "PrecompileTools", "UUIDs"] -git-tree-sha1 = "8489905bcdbcfac64d1daa51ca07c0d8f0283821" +git-tree-sha1 = "7d2f8f21da5db6a806faf7b9b292296da42b2810" uuid = "69de0a69-1ddd-5017-9359-2bf0b02dc9f0" -version = "2.8.1" +version = "2.8.3" [[deps.Pkg]] deps = ["Artifacts", "Dates", "Downloads", "FileWatching", "LibGit2", "Libdl", "Logging", "Markdown", "Printf", "Random", "SHA", "TOML", "Tar", "UUIDs", "p7zip_jll"] @@ -224,6 +559,12 @@ weakdeps = ["REPL"] [deps.Pkg.extensions] REPLExt = "REPL" +[[deps.PooledArrays]] +deps = ["DataAPI", "Future"] +git-tree-sha1 = "36d8b4b899628fb92c2749eb488d884a926614d3" +uuid = "2dfb63ee-cc39-5dd5-95bd-886bf059d720" +version = "1.4.3" + [[deps.PrecompileTools]] deps = ["Preferences"] git-tree-sha1 = "5aa36f7049a63a1528fe8f7c3f2113413ffd4e1f" @@ -232,9 +573,15 @@ version = "1.2.1" [[deps.Preferences]] deps = ["TOML"] -git-tree-sha1 = "9306f6085165d270f7e3db02af26a400d580f5c6" +git-tree-sha1 = "0f27480397253da18fe2c12a4ba4eb9eb208bf3d" uuid = "21216c6a-2e73-6563-6e65-726566657250" -version = "1.4.3" +version = "1.5.0" + +[[deps.PrettyTables]] +deps = ["Crayons", "LaTeXStrings", "Markdown", "PrecompileTools", "Printf", "REPL", "Reexport", "StringManipulation", "Tables"] +git-tree-sha1 = "6b8e2f0bae3f678811678065c09571c1619da219" +uuid = "08abe8d2-0d0c-5749-adfa-8a2ac140af0d" +version = "3.1.0" [[deps.Printf]] deps = ["Unicode"] @@ -255,16 +602,57 @@ deps = ["SHA"] uuid = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c" version = "1.11.0" +[[deps.Random123]] +deps = ["Random", "RandomNumbers"] +git-tree-sha1 = "dbe5fd0b334694e905cb9fda73cd8554333c46e2" +uuid = "74087812-796a-5b5d-8853-05524746bad3" +version = "1.7.1" + +[[deps.RandomNumbers]] +deps = ["Random"] +git-tree-sha1 = "c6ec94d2aaba1ab2ff983052cf6a606ca5985902" +uuid = "e6cf234a-135c-5ec9-84dd-332b85af5143" +version = "1.6.0" + +[[deps.Reexport]] +git-tree-sha1 = "45e428421666073eab6f2da5c9d310d99bb12f9b" +uuid = "189a3867-3050-52da-a836-e630ba90ab69" +version = "1.2.2" + [[deps.RegistryInstances]] deps = ["LazilyInitializedFields", "Pkg", "TOML", "Tar"] git-tree-sha1 = "ffd19052caf598b8653b99404058fce14828be51" uuid = "2792f1a3-b283-48e8-9a74-f99dce5104f3" version = "0.1.0" +[[deps.Requires]] +deps = ["UUIDs"] +git-tree-sha1 = "62389eeff14780bfe55195b7204c0d8738436d64" +uuid = "ae029012-a4dd-5104-9daa-d747884805df" +version = "1.3.1" + [[deps.SHA]] uuid = "ea8e919c-243c-51af-8825-aaa63cd721ce" version = "0.7.0" +[[deps.ScopedValues]] +deps = ["HashArrayMappedTries", "Logging"] +git-tree-sha1 = "c3b2323466378a2ba15bea4b2f73b081e022f473" +uuid = "7e506255-f358-4e82-b7e4-beb19740aa63" +version = "1.5.0" + +[[deps.Scratch]] +deps = ["Dates"] +git-tree-sha1 = "9b81b8393e50b7d4e6d0a9f14e192294d3b7c109" +uuid = "6c6a2e73-6563-6170-7368-637461726353" +version = "1.3.0" + +[[deps.SentinelArrays]] +deps = ["Dates", "Random"] +git-tree-sha1 = "712fb0231ee6f9120e005ccd56297abbc053e7e0" +uuid = "91c51154-3ec4-41a3-a24f-3f23e20d615c" +version = "1.4.8" + [[deps.Serialization]] uuid = "9e88b42a-f829-5b0c-bbe9-9e923198166b" version = "1.11.0" @@ -273,27 +661,92 @@ version = "1.11.0" uuid = "6462fe0b-24de-5631-8697-dd941f90decc" version = "1.11.0" +[[deps.SortingAlgorithms]] +deps = ["DataStructures"] +git-tree-sha1 = "64d974c2e6fdf07f8155b5b2ca2ffa9069b608d9" +uuid = "a2af1166-a08f-5f64-846c-94a0d3cef48c" +version = "1.2.2" + +[[deps.SparseArrays]] +deps = ["Libdl", "LinearAlgebra", "Random", "Serialization", "SuiteSparse_jll"] +uuid = "2f01184e-e22b-5df5-ae63-d93ebab69eaf" +version = "1.11.0" + +[[deps.StaticArrays]] +deps = ["LinearAlgebra", "PrecompileTools", "Random", "StaticArraysCore"] +git-tree-sha1 = "b8693004b385c842357406e3af647701fe783f98" +uuid = "90137ffa-7385-5640-81b9-e52037218182" +version = "1.9.15" + + [deps.StaticArrays.extensions] + StaticArraysChainRulesCoreExt = "ChainRulesCore" + StaticArraysStatisticsExt = "Statistics" + + [deps.StaticArrays.weakdeps] + ChainRulesCore = "d360d2e6-b24c-11e9-a2a3-2a2ae2dbcce4" + Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2" + +[[deps.StaticArraysCore]] +git-tree-sha1 = "6ab403037779dae8c514bad259f32a447262455a" +uuid = "1e83bf80-4336-4d27-bf5d-d5a4f845583c" +version = "1.4.4" + [[deps.Statistics]] deps = ["LinearAlgebra"] git-tree-sha1 = "ae3bb1eb3bba077cd276bc5cfc337cc65c3075c0" uuid = "10745b16-79ce-11e8-11f9-7d13ad32a3b2" version = "1.11.1" +weakdeps = ["SparseArrays"] [deps.Statistics.extensions] SparseArraysExt = ["SparseArrays"] - [deps.Statistics.weakdeps] - SparseArrays = "2f01184e-e22b-5df5-ae63-d93ebab69eaf" +[[deps.StringManipulation]] +deps = ["PrecompileTools"] +git-tree-sha1 = "725421ae8e530ec29bcbdddbe91ff8053421d023" +uuid = "892a3eda-7b42-436c-8928-eab12a02cf0e" +version = "0.4.1" + +[[deps.StructUtils]] +deps = ["Dates", "UUIDs"] +git-tree-sha1 = "79529b493a44927dd5b13dde1c7ce957c2d049e4" +uuid = "ec057cc2-7a8d-4b58-b3b3-92acb9f63b42" +version = "2.6.0" + + [deps.StructUtils.extensions] + StructUtilsMeasurementsExt = ["Measurements"] + StructUtilsTablesExt = ["Tables"] + + [deps.StructUtils.weakdeps] + Measurements = "eff96d63-e80a-5855-80a2-b1b0885c5ab7" + Tables = "bd369af6-aec1-5ad0-b16a-f7cc5008161c" [[deps.StyledStrings]] uuid = "f489334b-da3d-4c2e-b8f0-e476e12c162b" version = "1.11.0" +[[deps.SuiteSparse_jll]] +deps = ["Artifacts", "Libdl", "libblastrampoline_jll"] +uuid = "bea87d4a-7f5b-5778-9afe-8cc45184846c" +version = "7.7.0+0" + [[deps.TOML]] deps = ["Dates"] uuid = "fa267f1f-6049-4f14-aa54-33bafae1ed76" version = "1.0.3" +[[deps.TableTraits]] +deps = ["IteratorInterfaceExtensions"] +git-tree-sha1 = "c06b2f539df1c6efa794486abfb6ed2022561a39" +uuid = "3783bdb8-4a98-5b6b-af9a-565f29a5fe9c" +version = "1.0.1" + +[[deps.Tables]] +deps = ["DataAPI", "DataValueInterfaces", "IteratorInterfaceExtensions", "OrderedCollections", "TableTraits"] +git-tree-sha1 = "f2c1efbc8f3a609aadf318094f8fc5204bdaf344" +uuid = "bd369af6-aec1-5ad0-b16a-f7cc5008161c" +version = "1.12.1" + [[deps.Tar]] deps = ["ArgTools", "SHA"] uuid = "a4e569a6-e804-4fa4-b0f3-eef7a1d5b13e" @@ -304,6 +757,18 @@ deps = ["InteractiveUtils", "Logging", "Random", "Serialization"] uuid = "8dfed614-e22c-5e08-85e1-65c5234f0b40" version = "1.11.0" +[[deps.Tracy]] +deps = ["ExprTools", "LibTracyClient_jll", "Libdl"] +git-tree-sha1 = "73e3ff50fd3990874c59fef0f35d10644a1487bc" +uuid = "e689c965-62c8-4b79-b2c5-8359227902fd" +version = "0.1.6" + + [deps.Tracy.extensions] + TracyProfilerExt = "TracyProfiler_jll" + + [deps.Tracy.weakdeps] + TracyProfiler_jll = "0c351ed6-8a68-550e-8b79-de6f926da83c" + [[deps.TranscodingStreams]] git-tree-sha1 = "0c45878dcfdcfa8480052b6ab162cdd138781742" uuid = "3bb67fe8-82b1-5028-8e26-92a6c54297fa" @@ -318,11 +783,56 @@ version = "1.11.0" uuid = "4ec0a83e-493e-50e2-b9ac-8f72acf5a8f5" version = "1.11.0" +[[deps.UnsafeAtomics]] +git-tree-sha1 = "b13c4edda90890e5b04ba24e20a310fbe6f249ff" +uuid = "013be700-e6cd-48c3-b4a1-df204f14c38f" +version = "0.3.0" +weakdeps = ["LLVM"] + + [deps.UnsafeAtomics.extensions] + UnsafeAtomicsLLVM = ["LLVM"] + [[deps.Zlib_jll]] deps = ["Libdl"] uuid = "83775a58-1f1d-513f-b197-d71354ab007a" version = "1.2.13+1" +[[deps.cuDNN]] +deps = ["CEnum", "CUDA", "CUDA_Runtime_Discovery", "CUDNN_jll"] +path = "../lib/cudnn" +uuid = "02a925ec-e4fe-4b08-9a7e-0d78e3d38ccd" +version = "1.4.6" + +[[deps.cuQuantum_jll]] +deps = ["Artifacts", "CUDA_Runtime_jll", "CUTENSOR_jll", "JLLWrappers", "LazyArtifacts", "Libdl", "TOML"] +git-tree-sha1 = "3e7921e233c7126e31f0353b8167f283e357ad79" +uuid = "b75408ef-6fdf-5d74-b65a-7df000ad18e6" +version = "25.9.0+0" + +[[deps.cuStateVec]] +deps = ["CEnum", "CUDA", "CUDA_Runtime_Discovery", "cuQuantum_jll"] +path = "../lib/custatevec" +uuid = "92f7fd98-d22e-4c0d-85a8-6ade11b672fb" +version = "1.4.0" + +[[deps.cuTENSOR]] +deps = ["CEnum", "CUDA", "CUDA_Runtime_Discovery", "CUTENSOR_jll", "LinearAlgebra", "Printf"] +path = "../lib/cutensor" +uuid = "011b41b2-24ef-40a8-b3eb-fa098493e9e1" +version = "2.3.0" + +[[deps.cuTensorNet]] +deps = ["CEnum", "CUDA", "CUDA_Runtime_Discovery", "LinearAlgebra", "cuQuantum_jll", "cuTENSOR"] +path = "../lib/cutensornet" +uuid = "448d79b3-4b49-4e06-a5ea-00c62c0dc3db" +version = "1.4.0" + +[[deps.demumble_jll]] +deps = ["Artifacts", "JLLWrappers", "Libdl"] +git-tree-sha1 = "6498e3581023f8e530f34760d18f75a69e3a4ea8" +uuid = "1e29f10c-031c-5a83-9565-69cddfc27673" +version = "1.3.0+0" + [[deps.libblastrampoline_jll]] deps = ["Artifacts", "Libdl"] uuid = "8e850b90-86db-534c-a0d3-1478176c7d93" diff --git a/docs/Project.toml b/docs/Project.toml index e3121ec581..54c74e6910 100644 --- a/docs/Project.toml +++ b/docs/Project.toml @@ -1,9 +1,21 @@ [deps] BenchmarkTools = "6e4b80f9-dd63-53aa-95a3-0cdb28fa8baf" +CUDA = "052768ef-5323-5732-b1bb-66c8b64840ba" Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4" Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306" Markdown = "d6f4376e-aef5-505a-96c1-9c027394607a" Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40" +cuDNN = "02a925ec-e4fe-4b08-9a7e-0d78e3d38ccd" +cuStateVec = "92f7fd98-d22e-4c0d-85a8-6ade11b672fb" +cuTENSOR = "011b41b2-24ef-40a8-b3eb-fa098493e9e1" +cuTensorNet = "448d79b3-4b49-4e06-a5ea-00c62c0dc3db" + +[sources] +CUDA = {path = ".."} +cuDNN = {path = "../lib/cudnn"} +cuStateVec = {path = "../lib/custatevec"} +cuTENSOR = {path = "../lib/cutensor"} +cuTensorNet = {path = "../lib/cutensornet"} [compat] Documenter = "1" diff --git a/docs/make.jl b/docs/make.jl index 3cbd62d523..452d9411cc 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -1,5 +1,7 @@ using Documenter, Literate using CUDA +using CUDA.CUBLAS, CUDA.CUFFT, CUDA.CUPTI, CUDA.CURAND, CUDA.CUSOLVER, CUDA.CUSPARSE, CUDA.NVML, CUDA.APIUtils +using cuDNN, cuStateVec, cuTENSOR, cuTensorNet const src = "https://github.com/JuliaGPU/CUDA.jl" const dst = "https://cuda.juliagpu.org/stable/" @@ -9,17 +11,23 @@ function main() @info "Building Literate.jl documentation" cd(@__DIR__) do - Literate.markdown("src/tutorials/introduction.jl", "src/tutorials"; - repo_root_url="$src/blob/master/docs") - Literate.markdown("src/tutorials/custom_structs.jl", "src/tutorials"; - repo_root_url="$src/blob/master/docs") - Literate.markdown("src/tutorials/performance.jl", "src/tutorials"; - repo_root_url="$src/blob/master/docs") + Literate.markdown( + "src/tutorials/introduction.jl", "src/tutorials"; + repo_root_url = "$src/blob/master/docs" + ) + Literate.markdown( + "src/tutorials/custom_structs.jl", "src/tutorials"; + repo_root_url = "$src/blob/master/docs" + ) + Literate.markdown( + "src/tutorials/performance.jl", "src/tutorials"; + repo_root_url = "$src/blob/master/docs" + ) end println() @info "Generating Documenter.jl site" - DocMeta.setdocmeta!(CUDA, :DocTestSetup, :(using CUDA); recursive=true) + DocMeta.setdocmeta!(CUDA, :DocTestSetup, :(using CUDA); recursive = true) makedocs( sitename = "CUDA.jl", authors = "Tim Besard", @@ -33,13 +41,27 @@ function main() ), doctest = true, warnonly = [:missing_docs], - modules = [CUDA], + modules = [ + CUDA, + CUBLAS, + CUFFT, + CUPTI, + CURAND, + CUSOLVER, + CUSPARSE, + NVML, + APIUtils, + cuDNN, + cuStateVec, + cuTENSOR, + cuTensorNet, + ], pages = Any[ "Home" => "index.md", "Tutorials" => Any[ "tutorials/introduction.md", "tutorials/custom_structs.md", - "tutorials/performance.md" + "tutorials/performance.md", ], "Installation" => Any[ "installation/overview.md", @@ -67,13 +89,25 @@ function main() "api/compiler.md", ], "Library reference" => Any[ - "lib/driver.md", + "lib/cublas.md", + "lib/cudadrv.md", + "lib/cudnn.md", + "lib/cufft.md", + "lib/cupti.md", + "lib/curand.md", + "lib/cusolver.md", + "lib/cusparse.md", + "lib/custatevec.md", + "lib/cutensor.md", + "lib/cutensornet.md", + "lib/nvml.md", + "lib/utils.md", ], "FAQ" => "faq.md", ] ) - if ci + return if ci @info "Deploying to GitHub" deploydocs( repo = "github.com/JuliaGPU/CUDA.jl.git", diff --git a/docs/src/lib/cublas.md b/docs/src/lib/cublas.md new file mode 100644 index 0000000000..25fb683589 --- /dev/null +++ b/docs/src/lib/cublas.md @@ -0,0 +1,15 @@ +# CUBLAS + +## Public + +```@autodocs +Modules = [CUBLAS] +Private = false +``` + +## Private + +```@autodocs +Modules = [CUBLAS] +Public = false +``` diff --git a/docs/src/lib/driver.md b/docs/src/lib/cudadrv.md similarity index 100% rename from docs/src/lib/driver.md rename to docs/src/lib/cudadrv.md diff --git a/docs/src/lib/cudnn.md b/docs/src/lib/cudnn.md new file mode 100644 index 0000000000..6f9bfb9135 --- /dev/null +++ b/docs/src/lib/cudnn.md @@ -0,0 +1,15 @@ +# cuDNN + +## Public + +```@autodocs +Modules = [cuDNN] +Private = false +``` + +## Private + +```@autodocs +Modules = [cuDNN] +Public = false +``` diff --git a/docs/src/lib/cufft.md b/docs/src/lib/cufft.md new file mode 100644 index 0000000000..300ca2ac07 --- /dev/null +++ b/docs/src/lib/cufft.md @@ -0,0 +1,15 @@ +# CUFFT + +## Public + +```@autodocs +Modules = [CUFFT] +Private = false +``` + +## Private + +```@autodocs +Modules = [CUFFT] +Public = false +``` diff --git a/docs/src/lib/cupti.md b/docs/src/lib/cupti.md new file mode 100644 index 0000000000..22f97b1c6c --- /dev/null +++ b/docs/src/lib/cupti.md @@ -0,0 +1,15 @@ +# CUPTI + +## Public + +```@autodocs +Modules = [CUPTI] +Private = false +``` + +## Private + +```@autodocs +Modules = [CUPTI] +Public = false +``` diff --git a/docs/src/lib/curand.md b/docs/src/lib/curand.md new file mode 100644 index 0000000000..6e0015dd94 --- /dev/null +++ b/docs/src/lib/curand.md @@ -0,0 +1,15 @@ +# CURAND + +## Public + +```@autodocs +Modules = [CURAND] +Private = false +``` + +## Private + +```@autodocs +Modules = [CURAND] +Public = false +``` diff --git a/docs/src/lib/cusolver.md b/docs/src/lib/cusolver.md new file mode 100644 index 0000000000..a8e388ad8d --- /dev/null +++ b/docs/src/lib/cusolver.md @@ -0,0 +1,15 @@ +# CUSOLVER + +## Public + +```@autodocs +Modules = [CUSOLVER] +Private = false +``` + +## Private + +```@autodocs +Modules = [CUSOLVER] +Public = false +``` diff --git a/docs/src/lib/cusparse.md b/docs/src/lib/cusparse.md new file mode 100644 index 0000000000..e918017a2b --- /dev/null +++ b/docs/src/lib/cusparse.md @@ -0,0 +1,15 @@ +# CUSPARSE + +## Public + +```@autodocs +Modules = [CUSPARSE] +Private = false +``` + +## Private + +```@autodocs +Modules = [CUSPARSE] +Public = false +``` diff --git a/docs/src/lib/custatevec.md b/docs/src/lib/custatevec.md new file mode 100644 index 0000000000..21e5d76449 --- /dev/null +++ b/docs/src/lib/custatevec.md @@ -0,0 +1,15 @@ +# cuStateVec + +## Public + +```@autodocs +Modules = [cuStateVec] +Private = false +``` + +## Private + +```@autodocs +Modules = [cuStateVec] +Public = false +``` diff --git a/docs/src/lib/cutensor.md b/docs/src/lib/cutensor.md new file mode 100644 index 0000000000..346201e1c2 --- /dev/null +++ b/docs/src/lib/cutensor.md @@ -0,0 +1,15 @@ +# cuTENSOR + +## Public + +```@autodocs +Modules = [cuTENSOR] +Private = false +``` + +## Private + +```@autodocs +Modules = [cuTENSOR] +Public = false +``` diff --git a/docs/src/lib/cutensornet.md b/docs/src/lib/cutensornet.md new file mode 100644 index 0000000000..be5c87c8bd --- /dev/null +++ b/docs/src/lib/cutensornet.md @@ -0,0 +1,15 @@ +# cuTensorNet + +## Public + +```@autodocs +Modules = [cuTensorNet] +Private = false +``` + +## Private + +```@autodocs +Modules = [cuTensorNet] +Public = false +``` diff --git a/docs/src/lib/nvml.md b/docs/src/lib/nvml.md new file mode 100644 index 0000000000..70fb7446cf --- /dev/null +++ b/docs/src/lib/nvml.md @@ -0,0 +1,15 @@ +# NVML + +## Public + +```@autodocs +Modules = [NVML] +Private = false +``` + +## Private + +```@autodocs +Modules = [NVML] +Public = false +``` diff --git a/docs/src/lib/utils.md b/docs/src/lib/utils.md new file mode 100644 index 0000000000..2b1f1a892f --- /dev/null +++ b/docs/src/lib/utils.md @@ -0,0 +1,15 @@ +# APIUtils + +## Public + +```@autodocs +Modules = [APIUtils] +Private = false +``` + +## Private + +```@autodocs +Modules = [APIUtils] +Public = false +``` From dce8f4786aea4a49b0d1e14828208deb9314d0c9 Mon Sep 17 00:00:00 2001 From: Guillaume Dalle <22795598+gdalle@users.noreply.github.com> Date: Fri, 14 Nov 2025 07:26:31 +0100 Subject: [PATCH 2/3] Change current module [only docs] --- docs/src/lib/cublas.md | 4 ++++ docs/src/lib/cudnn.md | 4 ++++ docs/src/lib/cufft.md | 4 ++++ docs/src/lib/cupti.md | 4 ++++ docs/src/lib/curand.md | 4 ++++ docs/src/lib/cusolver.md | 4 ++++ docs/src/lib/cusparse.md | 4 ++++ docs/src/lib/custatevec.md | 4 ++++ docs/src/lib/cutensor.md | 4 ++++ docs/src/lib/cutensornet.md | 4 ++++ docs/src/lib/nvml.md | 4 ++++ docs/src/lib/utils.md | 4 ++++ 12 files changed, 48 insertions(+) diff --git a/docs/src/lib/cublas.md b/docs/src/lib/cublas.md index 25fb683589..152230b147 100644 --- a/docs/src/lib/cublas.md +++ b/docs/src/lib/cublas.md @@ -1,5 +1,9 @@ # CUBLAS +```@meta +CurrentModule = CUBLAS +``` + ## Public ```@autodocs diff --git a/docs/src/lib/cudnn.md b/docs/src/lib/cudnn.md index 6f9bfb9135..3e1201bf43 100644 --- a/docs/src/lib/cudnn.md +++ b/docs/src/lib/cudnn.md @@ -1,5 +1,9 @@ # cuDNN +```@meta +CurrentModule = cuDNN +``` + ## Public ```@autodocs diff --git a/docs/src/lib/cufft.md b/docs/src/lib/cufft.md index 300ca2ac07..b9be340805 100644 --- a/docs/src/lib/cufft.md +++ b/docs/src/lib/cufft.md @@ -1,5 +1,9 @@ # CUFFT +```@meta +CurrentModule = CUFFT +``` + ## Public ```@autodocs diff --git a/docs/src/lib/cupti.md b/docs/src/lib/cupti.md index 22f97b1c6c..8f8c364b0f 100644 --- a/docs/src/lib/cupti.md +++ b/docs/src/lib/cupti.md @@ -1,5 +1,9 @@ # CUPTI +```@meta +CurrentModule = CUPTI +``` + ## Public ```@autodocs diff --git a/docs/src/lib/curand.md b/docs/src/lib/curand.md index 6e0015dd94..89f1e55672 100644 --- a/docs/src/lib/curand.md +++ b/docs/src/lib/curand.md @@ -1,5 +1,9 @@ # CURAND +```@meta +CurrentModule = CURAND +``` + ## Public ```@autodocs diff --git a/docs/src/lib/cusolver.md b/docs/src/lib/cusolver.md index a8e388ad8d..317d4d48e3 100644 --- a/docs/src/lib/cusolver.md +++ b/docs/src/lib/cusolver.md @@ -1,5 +1,9 @@ # CUSOLVER +```@meta +CurrentModule = CUSOLVER +``` + ## Public ```@autodocs diff --git a/docs/src/lib/cusparse.md b/docs/src/lib/cusparse.md index e918017a2b..9bbe319db6 100644 --- a/docs/src/lib/cusparse.md +++ b/docs/src/lib/cusparse.md @@ -1,5 +1,9 @@ # CUSPARSE +```@meta +CurrentModule = CUSPARSE +``` + ## Public ```@autodocs diff --git a/docs/src/lib/custatevec.md b/docs/src/lib/custatevec.md index 21e5d76449..4bf17560e4 100644 --- a/docs/src/lib/custatevec.md +++ b/docs/src/lib/custatevec.md @@ -1,5 +1,9 @@ # cuStateVec +```@meta +CurrentModule = cuStateVec +``` + ## Public ```@autodocs diff --git a/docs/src/lib/cutensor.md b/docs/src/lib/cutensor.md index 346201e1c2..2427078582 100644 --- a/docs/src/lib/cutensor.md +++ b/docs/src/lib/cutensor.md @@ -1,5 +1,9 @@ # cuTENSOR +```@meta +CurrentModule = cuTENSOR +``` + ## Public ```@autodocs diff --git a/docs/src/lib/cutensornet.md b/docs/src/lib/cutensornet.md index be5c87c8bd..4f9a363a41 100644 --- a/docs/src/lib/cutensornet.md +++ b/docs/src/lib/cutensornet.md @@ -1,5 +1,9 @@ # cuTensorNet +```@meta +CurrentModule = cuTensorNet +``` + ## Public ```@autodocs diff --git a/docs/src/lib/nvml.md b/docs/src/lib/nvml.md index 70fb7446cf..14efa96303 100644 --- a/docs/src/lib/nvml.md +++ b/docs/src/lib/nvml.md @@ -1,5 +1,9 @@ # NVML +```@meta +CurrentModule = NVML +``` + ## Public ```@autodocs diff --git a/docs/src/lib/utils.md b/docs/src/lib/utils.md index 2b1f1a892f..00e5b959e1 100644 --- a/docs/src/lib/utils.md +++ b/docs/src/lib/utils.md @@ -1,5 +1,9 @@ # APIUtils +```@meta +CurrentModule = APIUtils +``` + ## Public ```@autodocs From fd248dc082059717a89e862d8920f44bfebd1f0b Mon Sep 17 00:00:00 2001 From: Guillaume Dalle <22795598+gdalle@users.noreply.github.com> Date: Fri, 14 Nov 2025 08:00:14 +0100 Subject: [PATCH 3/3] Add missing docstrings --- lib/cusparse/array.jl | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) diff --git a/lib/cusparse/array.jl b/lib/cusparse/array.jl index 55693e38b4..b6c38e953f 100644 --- a/lib/cusparse/array.jl +++ b/lib/cusparse/array.jl @@ -34,6 +34,16 @@ function CUDA.unsafe_free!(xs::CuSparseVector) return end +""" + CuSparseMatrixCSC + +Container to hold sparse matrices in compressed sparse column (CSC) format on the +GPU. + +!!! note + Most CUSPARSE operations work with CSR formatted matrices, rather + than CSC. +""" mutable struct CuSparseMatrixCSC{Tv, Ti} <: AbstractCuSparseMatrix{Tv, Ti} colPtr::CuVector{Ti} rowVal::CuVector{Ti} @@ -92,6 +102,8 @@ function CUDA.unsafe_free!(xs::CuSparseMatrixCSR) end """ + CuSparseMatrixBSR + Container to hold sparse matrices in block compressed sparse row (BSR) format on the GPU. BSR format is also used in Intel MKL, and is suited to matrices that are "block" sparse - rare blocks of non-sparse regions. @@ -122,6 +134,8 @@ function CUDA.unsafe_free!(xs::CuSparseMatrixBSR) end """ + CuSparseMatrixCOO + Container to hold sparse matrices in coordinate (COO) format on the GPU. COO format is mainly useful to initially construct sparse matrices, afterwards switch to [`CuSparseMatrixCSR`](@ref) for more functionality. @@ -782,4 +796,3 @@ function Adapt.adapt_structure(to::CUDA.KernelAdaptor, x::CuSparseArrayCSR) size(x), x.nnz ) end -