NCCL のインストール（Windows 上）

Windows上でNCCL（NVIDIA Collective Communications Library）をインストールする手順を説明している．主な手順としては，GitHubからのソースコードのクローン，Visual Studioを使用したプロジェクトの再ターゲット，x64 Native Toolsコマンドプロンプトを用いたビルド，そしてシステム環境変数へのパス追加である．インストールでは，Visual Studioでのプロジェクト設定や，CUDAツールキットとの連携に関して注意する必要がある．また，ビルド時に発生する可能性のあるエラーとその解決方法についても説明している．インストールの各ステップについて，具体的なコマンドラインの操作を示している．インストールは，管理者権限で行う．

前準備

Build Tools for Visual Studio 2022 のインストール（Windows 上）

以下のコマンドを管理者権限のコマンドプロンプトで実行する（手順：Windowsキーまたはスタートメニュー → cmd と入力 → 右クリック → 「管理者として実行」）。

REM VC++ ランタイム
winget install --scope machine --accept-source-agreements --accept-package-agreements --silent --id Microsoft.VCRedist.2015+.x64

REM Build Tools + Desktop development with C++（VCTools）+ 追加コンポーネント（一括）
winget install --id Microsoft.VisualStudio.2022.BuildTools ^
  --override "--passive --wait --add Microsoft.VisualStudio.Workload.VCTools --includeRecommended --add Microsoft.VisualStudio.Component.VC.Llvm.Clang --add Microsoft.VisualStudio.ComponentGroup.ClangCL --add Microsoft.VisualStudio.Component.VC.CMake.Project --add Microsoft.VisualStudio.Component.Windows11SDK.26100"

--add で追加されるコンポーネント

上記のコマンドでは，まず Build Tools 本体と Visual C++ 再頒布可能パッケージをインストールし，次に setup.exe を用いて以下のコンポーネントを追加している。

VCTools：C++ デスクトップ開発ワークロード（--includeRecommended により、MSVC コンパイラ、C++ AddressSanitizer、vcpkg、CMake ツール、Windows 11 SDK 等の推奨コンポーネントが含まれる）
VC.Llvm.Clang：Windows 向け C++ Clang コンパイラ
ClangCL：clang-cl ツールセットを含むコンポーネントグループ（MSBuild から Clang を使用するために必要）
VC.CMake.Project：Windows 向け C++ CMake ツール
Windows11SDK.26100：Windows 11 SDK（ビルド 10.0.26100）

インストール完了の確認

winget list Microsoft.VisualStudio.2022.BuildTools

上記以外のコンポーネントが必要になった場合は Visual Studio Installer で個別にインストールできる。

CUDA 12.3のインストール

前提条件（CUDA インストール前）: NVIDIA GPU，NVIDIA ドライバ，および Build Tools for Visual Studio もしくは Visual Studio が必要である．
インストール中の注意: なるべく他のウインドウはすべて閉じておくこと．

REM CUDAをシステム領域にインストール（NVIDIA GPU搭載機のみ）
winget install --scope machine --id Nvidia.CUDA -e --silent --accept-package-agreements --accept-source-agreements --version 12.3 --force

REM CUDA のパス設定
set "CUDA_PATH=C:\Program Files\NVIDIA GPU Computing Toolkit\CUDA\v12.3"
set "CUDNN_PATH=C:\Program Files\NVIDIA GPU Computing Toolkit\CUDA\v12.3"
if exist "%CUDA_PATH%" setx CUDA_PATH "%CUDA_PATH%" /M >nul
if exist "%CUDNN_PATH%" setx CUDNN_PATH "%CUDNN_PATH%" /M >nul
for /f "skip=2 tokens=2*" %a in ('reg query "HKLM\SYSTEM\CurrentControlSet\Control\Session Manager\Environment" /v Path') do set "SYSTEM_PATH=%b"
if exist "%CUDA_PATH%\bin" (
    echo "%SYSTEM_PATH%" | find /i "%CUDA_PATH%\bin" >nul
    if errorlevel 1 setx PATH "%CUDA_PATH%\bin;%SYSTEM_PATH%" /M >nul
)

REM 環境変数TEMP, TMPの設定（一時ファイルの保存先を短いパスに変更）
mkdir C:\TEMP
set "TEMP_PATH=C:\TEMP"
setx TEMP "%TEMP_PATH%" /M >nul
setx TMP "%TEMP_PATH%" /M >nul

NCCL のインストール（Windows 上）

https://github.com/MyCaffe/NCCLを使用する．

https://github.com/MyCaffe/NCCL/blob/master/INSTALL.mdの説明に従い，インストールを行う．

以下の操作を管理者権限のx64 Native Tools コマンドプロンプト (x64 Native Tools Command Prompt)で実行する（手順：スタートメニュー >「Visual Studio Build Tools 2022」の下の「x64 Native Tools コマンドプロンプト (x64 Native Tools Command Prompt)」を右クリック > 「管理者として実行」）。

ダウンロード

cd c:\
rmdir /s /q NCCL
git clone https://github.com/MyCaffe/NCCL

ビルドの実行

msbuild の /p:PlatformToolset および /p:WindowsTargetPlatformVersion オプションにより，ビルド時にターゲットの再設定（再ターゲット）を行う．PlatformToolset にはインストール済みのツールセット（例：v143），WindowsTargetPlatformVersion にはインストール済みの Windows SDK のバージョン（例：10.0）を指定する．

cd c:\
cd NCCL

REM CUDA BuildCustomizations ファイルをMSBuildの参照先へコピー
mkdir "C:\Program Files (x86)\Microsoft Visual Studio\18\BuildTools\MSBuild\Microsoft\VC\v180\BuildCustomizations" 2>nul
copy /Y "C:\Program Files\NVIDIA GPU Computing Toolkit\CUDA\v12.3\extras\visual_studio_integration\MSBuildExtensions\*" "C:\Program Files (x86)\Microsoft Visual Studio\18\BuildTools\MSBuild\Microsoft\VC\v180\BuildCustomizations\"

msbuild windows\nccl.12.3.vcxproj /p:Platform=x64 /p:PlatformToolset=v143 /p:WindowsTargetPlatformVersion=10.0

終了の確認
パスの設定
Windows のシステム環境変数 Path に c:\NCCL\windows\x64\Debug を追加することにより，パスを通す．
Windows で，管理者権限でコマンドプロンプトを起動する（手順：Windowsキーまたはスタートメニュー > cmd と入力 > 右クリック > 「管理者として実行」）。
次のコマンドを実行する．
```
powershell -command "$oldpath = [System.Environment]::GetEnvironmentVariable(\"Path\", \"Machine\"); $oldpath += \";c:\NCCL\windows\x64\Debug\"; [System.Environment]::SetEnvironmentVariable(\"Path\", $oldpath, \"Machine\")"
```