From e9e858725bf1cc51d736df36d0e30b4af595b6c7 Mon Sep 17 00:00:00 2001 From: Avik Pal Date: Fri, 23 Aug 2024 23:19:20 -0700 Subject: [PATCH] docs: add installation details --- docs/src/index.md | 48 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) diff --git a/docs/src/index.md b/docs/src/index.md index a73264f4c..34d8c47de 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -46,3 +46,51 @@ features: link: /api/Testing_Functionality/LuxTestUtils --- ``` + +## How to Install Lux.jl? + +Its easy to install Lux.jl. Since Lux.jl is registered in the Julia General registry, +you can simply run the following command in the Julia REPL: + +```julia +julia> using Pkg +julia> Pkg.add("Lux") +``` + +If you want to use the latest unreleased version of Lux.jl, you can run the following +command: (in most cases the released version will be same as the version on github) + +```julia +julia> using Pkg +julia> Pkg.add(url="https://github.com/LuxDL/Lux.jl") +``` + +## Want GPU Support? + +Install the following package(s): + +:::code-group + +```julia [NVIDIA GPUs] +using Pkg +Pkg.add("LuxCUDA") +# or +Pkg.add(["CUDA", "cuDNN"]) +``` + +```julia [AMD ROCm GPUs] +using Pkg +Pkg.add("AMDGPU") +``` + +```julia [Metal M-Series GPUs] +using Pkg +Pkg.add("Metal") +``` + +```julia [Intel GPUs] +using Pkg +Pkg.add("oneAPI") +``` + +:::