Windows で flann 最新版をソースコードからビルドして、インストールする．CUDA対応可に設定（マイクロソフト C++ ビルドツール (Build Tools) を使用）

Windows で，flann 最新版をソースコードからビルドして,インストールする手順をスクリーンショット等で説明する．

flannは、高次元空間での近似最近傍探索（approximate nearest neighbor searches）を行うライブラリ．マイクロソフト C++ ビルドツールを使用する．GPUを利用するように設定する手順も説明する．

【目次】

前準備
flann のインストール（マイクロソフト C++ ビルドツール (Build Tools) を使用）

※ flann の利用条件などは、利用者が確認すること。次のWeb ページを活用してください

https://github.com/flann-lib/flann

謝辞

flann の作者に感謝します

前準備

Build Tools for Visual Studio 2022 （ビルドツール for Visual Studio 2022）のインストール

Build Tools for Visual Studio は，Windows で動くMicrosoft の C++ コンパイラーである．

ダウンロードページ

https://visualstudio.microsoft.com/ja/downloads/

詳細説明

Build Tools for Visual Studio 2022 （ビルドツール for Visual Studio 2022）のインストール: 別ページで説明している．

インストール手順の概要

ダウンロード URL を開く
https://visualstudio.microsoft.com/ja/downloads/
このページの「Build Tools のダウンロード」をクリック
ダウンロードが始まる
ダウンロードした .exe ファイルを実行する
表示を確認し，「続行」をクリック
「C++ によるデスクトップ開発」をクリック．「インストール」をクリック．

Git のインストール

Git のページ https://git-scm.com/ からダウンロードしてインストール:

Windows での Git のインストール手順: 別ページで説明している．

cmake のインストール

cmake のダウンロードページ: https://cmake.org/download/

Windows での cmake のインストール手順: 別ページで説明している．

NVIDIA ドライバ，NVIDIA CUDA ツールキット 11.7.0, NVIDIA cuDNN 8.4.1 のインストール

GPU は，グラフィックス・プロセッシング・ユニットの略で、コンピュータグラフィックス関連の機能，乗算や加算の並列処理の機能などがある． NVIDIA CUDA ツールキットは，NVIDIA社が提供している GPU 用のプラットフォームである．

【インストール手順の詳細説明】

Windows での NVIDIA ドライバ，NVIDIA CUDA ツールキット 11.7.0，NVIDIA cuDNN v8.4.1 のインストール: 別ページで説明している．
Ubuntu での NVIDIA ドライバ，NVIDIA CUDA ツールキット 11.7, NVIDIA cuDNN 8.4.1 のインストール: 別ページで説明している

NVIDIA ドライバについて

古いNVIDIA ドライバ，NVIDIA CUDA がインストール済みのとき，不要なものがあればアンインストール
Windows のスタートメニューで「設定」，「アプリ」と操作して，「NVIDIA ・・・」を削除
NVIDIA グラフィックス・カードの種類を調べる
hwinfo (URL: https://www.hwinfo.com) を使って調べることができる．
あとで，NVIDIA CUDA ツールキットをインストールするときに，NVIDIA ドライバを同時にインストールすることができる．
あとで、NVIDIA CUDA ツールキットをインストールするので、そのときに、NVIDIA ドライバもインストールすることにする．次へ進む．

但し， NVIDIA CUDA ツールキットの古いバージョンを使う場合には，次のページから，最新のNVIDIA ドライバをダウンロードして，インストールする．
NVIDIA ドライバのダウンロードページ: https://www.nvidia.co.jp/Download/index.aspx?lang=jp

NVIDIA CUDA ツールキット 11.7.0，NVIDIA cuDNN 8.4.1 のインストール

Windows での NVIDIA ドライバ，NVIDIA CUDA ツールキット 11.6.2，NVIDIA cuDNN v8.4.0 のインストール: 別ページで説明している．

NVIDIA CUDA ツールキット 11.7.0 のダウンロードとインストール
NVIDIA ドライバのインストールが必要な場合は，このときに，同時にインストールする
次のページからダウンロードし，インストールする．
NVIDIA CUDA ツールキットのページ: https://developer.nvidia.com/cuda-toolkit-archive
NVIDIA CUDA クイックスタートの公式ページ: https://docs.nvidia.com/cuda/cuda-quick-start-guide/index.html
NVIDIA cuDNN のダウンロードと設定
1. ZLIB DLL のダウンロードとインストール
  管理者として実行したコマンドプロンプトで，次のコマンドを実行．
  v11.7」のところは，実際にインストールされているバージョンを確認し，読み替えてください．
```
cd "C:\Program Files\NVIDIA GPU Computing Toolkit\CUDA\v11.7\bin"
curl -O http://www.winimage.com/zLibDll/zlib123dllx64.zip
call powershell -command "Expand-Archive zlib123dllx64.zip"
copy zlib123dllx64\dll_x64\zlibwapi.dll .
```
  Windows で「Could not locate zlibwapi.dll. Please make sure it is in your library path!」と表示されるときの対処：
  ここの説明を参考に ZLIB DLL をインストールする．
2. NVidia の cuDNN のウェブページを開く
  https://developer.nvidia.com/cuDNN
3. ダウンロードしたいので，cuDNNのところにある「Download cuDNN」をクリック
4. NVIDIA Developer Program メンバーシップに入る
  cuDNN のダウンロードのため．
  「Join now」をクリック．その後，画面の指示に従う．利用者本人が，電子メールアドレス，表示名，パスワード，生年月日を登録．利用条件等に合意．
5. ログインする
6. ライセンス条項の確認
  - NVIDIA cuDNN のダウンロードページ: https://developer.nvidia.com/cudnn
  - Windows での NVIDIA cuDNN のインストールの詳細説明: 別ページで説明している．
7. いまダウンロードした zip ファイルを，分かりやすいディレクトリに展開（解凍）する
8. そこに，パスを通す．
  
  「C:\Program Files\NVIDIA GPU Computing Toolkit\CUDA\v11.7」に展開（解凍）した場合は，すでにパスは通っているので，何もしなくてよい．
9. 次の操作により，cudnn64_8.dll にパスが通っていることを確認する．
  Windowsのコマンドプロンプトを開き，次のコマンドを実行．エラーメッセージが出ないことを確認．
```
where cudnn64_8.dll
```
10. システム環境変数 CUDNN_PATH の設定を行う．
  システム環境変数 CUDNN_PATH の設定
  管理者として実行したコマンドプロンプトで，次のコマンドを実行．
  
  「C:\Program Files\NVIDIA GPU Computing Toolkit\CUDA\v11.7」は，実際に展開（解凍）したディレクトリに読み替えること．
```
call powershell -command "[System.Environment]::SetEnvironmentVariable(\"CUDNN_PATH\", \"C:\Program Files\NVIDIA GPU Computing Toolkit\CUDA\v11.7\", \"Machine\")"
```

flann のインストール（マイクロソフト C++ ビルドツール (Build Tools) を使用）

Visual Studio の x64 Native Tools コマンドプロンプトを開く．

起動は，Windows のメニューで「Visual Studio 20..」の下の「x64 Native Tools コマンドプロンプト (x64 Native Tools Command Prompt)」を選ぶ．「x64」は，64ビット版の意味である．

「x64 Native Tools コマンドプロンプト (x64 Native Tools Command Prompt)」がないとき:
C++ ビルドツール (Build Tools) のインストールを行うことで，「x64 Native Tools コマンドプロンプト (x64 Native Tools Command Prompt)」がインストールされる．その手順は，別ページで説明している
flann のインストールディレクトリを削除する
```
cd %LOCALAPPDATA%
rmdir /s /q flann
```

flann のソースコードをダウンロード

cd %LOCALAPPDATA%
git clone https://github.com/mariusmuja/flann

cmake の実行

cmake でのオプションについて

cmake のオプションの「Visual Studio 16 2019」のところは，使用する Visual Studio のバージョンにあわせること． Visual Studio 2022 のときは，「Visual Studio 17 2022」． Visual Studio 2019 のときは，「Visual Studio 16 2019」

cmake の実行手順例は次の通り

cd %LOCALAPPDATA%
cd flann
del CMakeCache.txt
rmdir /s /q build
mkdir build
cd build
del CMakeCache.txt
cmake -G "Visual Studio 16 2019" -T host=x64 ^
    -DCMAKE_INSTALL_PREFIX="c:\flann" ^
    -DBUILD_EXAMPLES=ON ^
    -DBUILD_PYTHON_BINDINGS=OFF ^
    -DBUILD_CUDA_LIB=ON ^
    -DHDF5_C_INCLUDE_DIR="%LOCALAPPDATA%\CMake-hdf5-1.10.4\hdf5-1.10.4\c++\src" ^
    -DHDF5_DIFF_EXECUTABLE="%LOCALAPPDATA%\CMake-hdf5-1.10.4\build\bin\Release\h5diff.exe" ^
    -DHDF5_DIR="%LOCALAPPDATA%\CMake-hdf5-1.10.4\hdf5-1.10.4" ^
    -DHDF5_hdf5_LIBRARY_RELEASE="%LOCALAPPDATA%\CMake-hdf5-1.10.4\build\bin\Release\hdf5.lib" ^
..

cmake の実行結果の確認
※ 下図のとおりになるとは限らない．自動設定がうまくいっていない場合は、1つ上の「cmake の実行」のところを、設定を変えてやり直す．
ソースコードからビルドし、インストールする
```
cmake --build . --config RELEASE --target INSTALL
```
結果の確認
エラーメッセージが出ていないことを確認．最後のほうに「0 エラー」のように表示されるのを確認．
※ 黄色の警告メッセージは無視しても良い
※ ここでエラーメッセージが出たときは、
- 「zlib のインストール」を忘れていないかを確認する。
  忘れていた場合には、 zlib のインストールを行った後、「cmake の実行」からやり直す
- 「liblz4 のインストール」を忘れていないかを確認する。
  忘れていた場合には、 liblz4 のインストールを行った後、「cmake の実行」からやり直す
- 「hdf5 のインストール」を忘れていないかを確認する。
  忘れていた場合には、 hdf5 のインストールを行った後、「cmake の実行」からやり直す
システム環境変数 FLANN_ROOT の設定
次のように設定する
%LOCALAPPDATA%\flann
システム環境変数 LIB の設定
次のように追加する
%LOCALAPPDATA%\flann\lib
動作確認
https://usermanual.wiki/Document/flannmanual184.1650808969/html の PDF ファイルに掲載のプログラムを動作確認に使用
VS 2017用 x64 Native Tools コマンドプロンプトで、次を実行する。エラーメッセージが出なければOKとする
```
cd %LOCALAPPDATA%\flann\examples
cl flann_example.cpp ^
  /I %LOCALAPPDATA%\flann\include ^
  /I %LOCALAPPDATA%\CMake-hdf5-1.10.4\hdf5-1.10.4\src ^
  /I %LOCALAPPDATA%\CMake-hdf5-1.10.4\build ^
  -o flann_example_cpp.exe ^
  libhdf5.lib liblz4.lib zlib.lib msvcrt.lib
```
ビルドでエラーメッセージが出たときは、
- 「zlib のインストール」で、システム環境変数LIBの設定を忘れていないか
- 「liblz4 のインストール」で、システム環境変数LIBの設定を忘れていないか
- 「hdf5 のインストール」で、システム環境変数LIBの設定を忘れていないか
を確認する

GNU の C++ コンパイラでも動作確認 Windows のコマンドプロンプトで、次を実行する．エラーメッセージが出なければOKとする

cd %LOCALAPPDATA%\flann\examples
g++ flann_example.cpp ^
  -I %LOCALAPPDATA%\flann\include ^
  -o flann_example_cpp.exe ^
  %LOCALAPPDATA%\CMake-hdf5-1.10.4\build\bin\Release\hdf5.lib -llz4

本サイトは金子邦彦研究室のWebページである．

資料等の公開では，原則，「クリエイティブコモンズ BY NC SA」として公開するようにしている． PDFファイル，パワーポイントファイルなどには，「クリエイティブコモンズ BY NC SA」を明記するとともに，ロゴを記載するようにしている（作業が間に合っていない分もあるのでご容赦ください）．

公開している資料をご利用になる場合の，再配布の条件，剽窃の防止などについて，別ページで説明している．再配布や資料改変の際には，そのページをご確認ください．

サイトマップは，サイトマップのページをご覧下さい．本サイト内の検索は，サイト内検索のページをご利用下さい．

問い合わせ先：金子邦彦（かねこくにひこ）