UnityのML-AgentsのAPIリファレンスを自動生成する

今回はUnityのML-AgentのスクリプトのAPIリファレンスを自動生成してみようと思います。

UnityのML-Agentを使って機械学習を使う時にスクリプトのAPIリファレンスがあると便利です。

そんなわけで今回はそのやり方を書いておきます。

スポンサーリンク

Unityのサンプルを含んだツールキットをダウンロードする

Unityのサンプルを含んだUnityツールキットファイルを以下からダウンロードします。

Unity-Technologies/ml-agents
Unity Machine Learning Agents Toolkit. Contribute to Unity-Technologies/ml-agents development by creating an account on GitHub.

ML-Agentの最新のツールキットをダウンロードする

上のようにCodeを押してDownload ZIPを押します。

ファイルのダウンロードが終わったらわかりやすいようにデスクトップにすべてのファイルを展開します。

Doxygenをダウンロードする

次にソースファイルから文書を抜き出しドキュメント化してくれるDoxygenをダウンロードします。

Doxygen 日本語情報トップページ - OSDN
Doxygenは、 C++, C, JavaそしてIDLのためのJavaDocのようなドキュメントシステムです。

最新のWindows64bit版(現時点でdoxygen-1.8.20.windows.x64.bin.zip)のダウンロードをします。

ダウンロードが終了したらこちらもわかりやすいようにデスクトップにすべてのファイルを展開します。

APIリファレンスの生成

次にコマンドプロンプトを開き先ほどダウンロードしたUnityのツールキットのdocsフォルダまで移動します。

デスクトップにファイルを展開したので以下のようにコマンドを打ちます。

cd C:\Users\ユーザー名\Desktop\ml-agents-master\docs

なぜこのフォルダに移動したかというとdocsフォルダにあるdox-ml-agents.confファイルを指定したいからです。

次に以下のようにコマンドを打ちます。

C:\Users\ユーザー名\Desktop\doxygen-1.8.20.windows.x64.bin\doxygen dox-ml-agents.conf

画像で示すと以下のような感じです。

ML-AgentsのAPIリファレンスを出力するコマンド

doxygenまでが実行するコマンドでdox-ml-agents.confがオプションコマンドです。

環境変数のPATHにdoxygen.exeファイルまでのパスを通せば

doxygen dox-ml-agents.conf

だけで大丈夫ですが、環境変数の設定も面倒なのでこちらのやり方にしました。

これでAPIリファレンスをHTMLファイルで確認出来るようになります。

APIリファレンスの確認

APIリファレンスのHTMLはUnityツールキットのフォルダ内に作成されます。

C:\Users\ユーザー名\Desktop\ml-agents-master\docs\html

上のフォルダに出力されますので、その中のindex.htmlファイルを開いてブラウザでAPIリファレンスを確認する事が出来ます。

タイトルとURLをコピーしました