tanaka's Programming Memo

プログラミングについてのメモ。

Addressableアセットシステムを使ってみる

Addressableアセットシステムは、テキストなどのデータファイルをそれを指定する文字列などのアドレスで読み込む仕組みです。手軽にコンテンツのデータの作成や配布をするのに役立ちます。

Addressableアセットシステムは、依存関係(Dependencies)の一覧を使って、様々な場所から非同期にデータを読み込むことができます。直接参照したり、これまでのAsset Bundleを使ったり、リソースフォルダーを使うこともできます。

以下の公式ドキュメントをざっくり読んで、Addressableアセットの設定、作成、スクリプトからの読み込みをしてみます。

docs.unity3d.com

目次

使う上での注意点

  • 対応するのは、Unity2018.2以降
  • Addressables System 0.5.3で動作確認
  • 2019/4/25の時点ではまだreview版なので、仕様変更や不具合が発生する場合があります。正規のプロジェクトで使うかどうかは慎重に
  • 一通りの設定を終えるまではエラーが発生する場合があります。とりあえずエラーが出ても、アセットを読み込むところまで進めてください

Addressableアセットの設定と作成

インストール

Addressableアセットパッケージは、Package Managerからインストールできます。Package ManagerからAddressables Systemをインストールします。

アセットをAddressableに設定する

2通りの方法があります。Package ManagerでAddressables Systemをインストールしたら、Addressableにしたいアセットを選択してInspectorAddressにチェックを入れるか、Addressablesウィンドウを表示して、そこにドラッグ&ドロップします。

Addressableウィンドウは、WindowメニューからAsset Management > Addressable Assetsを選択して開きます。AddressableにしたいアセットをProjectウィンドウからドラッグして、AddressablesウィンドウのAssetタブにドロップします。

設定したアセットのデフォルトアドレスはプロジェクトのAssetパスです。例えばAssets/images/myImage.pngのようになります。これはInspectorウィンドウや、Addressablesウィンドウでユニークな他の文字列に変更することができます。

Addressableアセットをはじめて設定した時は、プロジェクトフォルダーにAssets/AddressableAssetsDataフォルダーが作成されて、必要なデータが作成されるので、バージョン管理システムを利用している場合は管理に加えてください。

読み込みやAddressからのゲームオブジェクト生成

実行中に読み込みやアセットから生成ができます。Loadingアセットでは、アセットバンドルのデータも含む読み込みに必要なすべてのアセットをメモリーに読み込みます。必要になった時にアセットを読み込んで使うことができます。Instantiating loads the Asset(アセットの読み込みと生成)の場合は読み込んだと同時にシーンにアセットが生成されます。

Addressableアセットにアクセスするスクリプトでは、冒頭で以下を追加しておきます。

using UnityEngine.AddressableAssets;

データの読み込み、および、読み込みとInstantiateは以下のメソッドで実行します。

LoadAsset

Addressables.LoadAsset<GameObject>("AssetAddress");

InstantiateAsset

Addressables.Instantiate<GameObject>("AssetAddress");

上記のいずれも非同期なので、読み込み完了時に処理する場合は以下のようにコールバックを設定します。特に、LoadAssetの場合は、読み込み後にデータを利用することになるので、以下の仕組みが必要になるはずです。以下、testdata.csvというテキストアセットを読み込んで、完了したらログ表示する例です。テキストアセットのエンコードUTF8Nです。

using UnityEngine;
using UnityEngine.AddressableAssets;

public class AddressableLoader : MonoBehaviour {

    void Start () {
        Addressables.LoadAsset<TextAsset>("testdata.csv").Completed += onLoadDone;
    }

    void onLoadDone(UnityEngine.ResourceManagement.IAsyncOperation<TextAsset> obj)
    {
        Debug.Log(obj);
    }
}

以上で、Addressableアセットを作成して、スクリプトから利用することができます。

これ以降、以下の項目を必要に応じて進めるとよいでしょう。

参考URL

メッシュを変形するDeformを使ってみる

なんか凄いのがMITライセンスで公開されたのを知って、取り急ぎ使い方をば。メッシュを変形させるライブラリです。以下のようなことができます。

f:id:am1tanaka:20190406160924g:plain
Twist Deform

github.com

沢山種類があるので、詳しくは上記のGitHubリポジトリーで動画が見れます。

目次

要件

Unity2018.3以降が必要です。

インストール方法

依存関係を解決する必要があるので、リポジトリーのファイルをそのままプロジェクトに突っ込むだけでは動きません。以下のインストール手順に従います。

Deform/Installation.md at master · keenanwoodall/Deform · GitHub

  • Unityを閉じておきます
  • 組み込みたい2018.3以降のUnityのプロジェクトのPackagesフォルダーをエクスプローラーなどで開きます

f:id:am1tanaka:20190406161050p:plain
Packagesフォルダー

  • manifest.jsonを何らかのエディターで開きます

f:id:am1tanaka:20190406161103p:plain
manifest.jsonを開く

  • すでに書かれている部分はそのままにして、 "dependencies": {の下に以下の行を追加します
// :
"com.beans.deform": "https://github.com/keenanwoodall/Deform.git",

f:id:am1tanaka:20190406161121p:plain
dependenciesを追加

  • 上書き保存してエディターを閉じます

以上できたら、Unityを起動してプロジェクトを開きます。そうすると、自動的に依存関係も含めてDeformがインストールされます。

原文には、ZIPをダウンロードして組み込む手順も掲載されています。

変形させる

以下を参考に、Twistでキューブ(Cube)をねじってみます。

Deform/GettingStarted.md at master · keenanwoodall/Deform · GitHub

ねじるためのCubeを作成する

変形のための頂点が必要なので、通常のGame Objectから作成するCubeだとうまくいきません。Deformがそれ用のCubeを作ってくれますのでそれを使います

  • ToolメニューからDeform > Creatorを選択します

f:id:am1tanaka:20190406161220p:plain
Creatorウィンドウを開く

  • Creatorウィンドウが開きますので、Create Deformableボタンをクリックします

f:id:am1tanaka:20190406161255p:plain
Deformableの作成

Wireframeを表示してみると、以下のように1辺が16分割された立方体であることが確認できます。

f:id:am1tanaka:20190406161315p:plain
作成されたCubeの確認

ちなみに、普通に作ったCubeは以下の通りなので、辺の途中がねじれないのでうまくDeformできません。

f:id:am1tanaka:20190406161327p:plain
標準のCube。これだと複雑な変形ができない

  • Hierarchyウィンドウで、作成したDeformable Objectをクリックして選択したら、CreatorウィンドウのTwistボタンをクリックします

f:id:am1tanaka:20190406161421p:plain
Twistを追加

以上で、TwistDeformerが設定されました。

ネジってみる

  • 作成したCubeの子供に追加されたTwistオブジェクトを選択します
  • Cubeの上下にオレンジ色の円柱状のハンドルが表示されるので、それをドラッグするとCubeがねじれます!

f:id:am1tanaka:20190406161500p:plain
ねじる!

  • Twistの座標や回転、大きさを変化させると、ねじれ方が変わります

f:id:am1tanaka:20190406160924g:plain
Twist Deform

Cube以外のメッシュを変形させたい場合

既存のモデルに適用したい場合は、そのモデルを選択して、CreatorウィンドウのCreate DeformableボタンをクリックすればOKです。あとの作業は同じです。

スクリプトから使う

利用したいコードの先頭に以下を追加します。

using Deform;

Twistを制御したい場合は、TwistDeformerインスタンスInspectorGetComponent<TwistDeformer>()で取得して、StartAngleEndAngleプロパティーに値を設定すれば動きます。

using UnityEngine;
using Deform;

public class TwistTest : MonoBehaviour
{
    TwistDeformer twistDeformer;
    float now = 0;

    private void Awake()
    {
        twistDeformer = GetComponent<TwistDeformer>();
    }

    void Update()
    {
        now = Mathf.Repeat(now + Time.deltaTime * 360f, 360f);
        twistDeformer.StartAngle = now;
        twistDeformer.EndAngle = -now;
    }
}

上記のようなスクリプトを作成してTwistオブジェクトにアタッチすると自動的にねじれます。

詳細は...

英語ですが、以下の動画で操作が分かります。控えめに言って凄いです。

www.youtube.com

関連URL

github.com

Looking Glassの表示がずれる

Looking Glass(ルキグラス)を表示したら、以下のように微妙にずれるという時は、メインモニターの方の設定が原因かも知れません。

f:id:am1tanaka:20190405224303j:plain
LookingGlassの表示がずれる

Someluさんの以下のツイートをなんとなく覚えていて、LookingGlassの方だけではなく、メインモニターの倍率も100%じゃないといけないということで、無事直りました!

UnityでMissingのオブジェクトを検索する

以下書いたけど、Unity2018.3だとワーニングをダブルクリックすればどのオブジェクトか示してくれますね。ちょっと前に駄目だった気がしたのですが、気のせいだったかも・・・。一応なんかあった時の対処法ということで。


無料版のAssetを有料版に差し替える時やバージョンアップ時に、構造が変わってスクリプトMissingになってしまうことがあります。しかし、Missingなのは分かるけど、どれ・・・という時の解決策をUnity Communityで見つけました。

wiki.unity3d.com

実装手順

  • Editorフォルダーをプロジェクト内のどこかに作成します(すでにあればそれを利用すればよい)
  • Editorフォルダー内にFindMissingScriptsRecursivelyという名前でC#スクリプトを作成します

f:id:am1tanaka:20190401213247p:plain
スクリプト作成

f:id:am1tanaka:20190401213504p:plain
スクリプトをコピー

  • FindMissingScriptsRecursively.csに貼り付けます

f:id:am1tanaka:20190401213557p:plain
貼り付け

以上で設定完了です。

Missingを探す

  • 探したいシーンを開きます
  • Windowメニューから、FindMissingScriptsRecursivelyを選択して、検索ボタンのあるウィンドウを開きます

f:id:am1tanaka:20190401213818p:plain
検索メニュー表示

  • Hierarchyウィンドウでオブジェクトを全て選択します

f:id:am1tanaka:20190401213716p:plain
オブジェクトを選択

  • Find Missing Scripts in selected GameObjectsボタンをクリックします

f:id:am1tanaka:20190401214102p:plain
検索実行

検索結果は、Consoleウィンドウに表示されます。

f:id:am1tanaka:20190401214144p:plain
コンソール画面

  • ????? has an empty script attached in position: ?という行があったら、Missingを持ったゲームオブジェクトがあったということです。先頭の?????の部分にオブジェクトの名前が表示されます
  • 上記のコンソールの行をクリックすると、Hierarchyウィンドウで該当するゲームオブジェクトが黄色で示されます

f:id:am1tanaka:20190401214459p:plain
Missingのあるゲームオブジェクト

以上です。

Missingのあるプレハブを見つけるには

Hierarchyウィンドウで選択したのと同様に、Projectウィンドウで調べたいオブジェクトを選択して、検索ボタンを押せばプレハブからもMissingを見つけてくれます。

参考URL

Unity1週間ゲームジャム「つながる」参加ブログ

つながるというお題で、スタートからゴールに線を繋げる 跳ね玉 というゲームを作りました!unityroomにログインして遊んで評価を送信していただければ喜びます!

跳ね玉

跳ね玉 | フリーゲーム投稿サイト unityroom

企画から制作までの流れをメモがてら。

目次

企画ができるまで

最近では恒例になりました、秋葉原にあるコワーキングスペースWeeybleさんにおいてニムさん主催で開催されましたUnity1週間ゲームジャム準備会に参加するところからスタート。

今回も勢いをつけるためにライトニングトーク(LT)枠での参加。いつもはネットランキングやツイート方法、フレームワークの参考など技術的なことをお話していたのですが、ゲームデザインについて自分が調べたことを発表しました。3/9に資料作成した模様。

資料は以下で公開してます。

docs.google.com

準備会ではLT後、Looking Glassを持って行っていたのでどっちかというとそっちで遊んでいたような...。3/10の作業は以下のような感じでした。

  • Trelloで作業用ボード作成
  • Unityのプロジェクト作成、基本設定、ビルド、unityroomへの仮登録

一人企画会議

準備会から帰ったあとは一人企画会議です。Trelloのカードに以下のようにざっくりとテーマを書き出しました。

  • タイミング一発的なシンプルなルール
  • プリミティブな形をかっこよく見せる -> PPSを利用
  • 高さなどの眩暈要素 -> CameraPlayの波紋
  • ネットランキングとツイートでSNS要素を入れる

以下のような案が最初の方向性でした。

  • タイミングワンキー
  • 左右を選ぶ
  • ロープ
  • 棒高跳び的な
  • スポットライトに当たり続ける or 逃げる

ただ、この段階で具体的なイメージはまとまらず。次に、最近気になっていたPhysics.Simulate()による物理の先読みネタを考え始めました。テラシュールブログさんの以下のブログのやつです。

tsubakit1.hateblo.jp

そして日曜日の21時半ごろに以下をツイート。

この時に考えていたのが、跳ね玉のほぼそのままの企画です。

ついでにこんなことつぶやいていた。これは深入りしなくてよかった^^;

  • カジュアルゲームなら高さによるめまい要素を入れたり演出に時間をかけられる
  • パズルならPhysics.Simulate()を使えて、めまい要素は減るけどCameraPlayで揺らすのはできる

という2択。LT通りにやるならカジュアルゲーだけど、パズルの方がイメージがしっかりと固まっていて「つながる」のテーマも満たしている。Physics.Simulate()と念願のCameraPlayも使えそう。ということで、やりたいことができるパズル企画を選びました。

この後の開発の流れは後半にて。

学生さん作品

Sāya君. Bird Tree Life

前回、デビュー作のカードジャンゴーでいいねを沢山もらった狼幼女改めSāya君が今回も参加。

unityroom.com

画面が奇麗でずんずん成長してます。前作もそうですが、文字がなくてもストーリー性が出せるのが強い。サウンドや雰囲気でランクインしたり、おすすめや週間ランキングにも登場。お見事!!

f:id:am1tanaka:20190326185313p:plain
週間ランキング

f:id:am1tanaka:20190326185336p:plain
音楽

Alesta_WSさん. MicroChip

こちらも連続参加。ロシアからの留学生のAlesta_WSさんの作品。

unityroom.com

歯ごたえのあるパズルゲームです。説明が少ないのと音がなくて評価を落としてしまったのが残念。面白いゲームですが、元ネタはあるのだろうか。学校がはじまったら聞いてみよう。休みの期間で自力で完成させて公開しているのでえらいです!!

ゲームジャムを終えて

全体的によいコメントや評価をいただけて、頑張った甲斐がありました。評価ランキングでは、3/25までの最高順位で8位に入ることができました!!

f:id:am1tanaka:20190325223552p:plain
評価総合ランキング

僅差なのでいつまで持ちこたえられるか分からないので記念のスクショ。

今回から変更になった評価形式やランキングによって、多くの作品が並びますし、項目ごとに評価が分かって次回作への反省材料になります。unityroomがさらに進化!naichiさん、いつも本当にありがとうございます。

次回に向けて

参加された皆さんの作品を拝見するのもとても得るものが多いです。今回は特に以下のようなこと。

  • ゲームがシンプルでも強いものは強い
  • 画面は明るめに(地が黒くてもエフェクトで半分以上明るくなるとか、画面全体が暗くならないように)
  • キャラクター性、ストーリー性、作家性のいずれかがあるものは強い
  • ドット絵強い(これは自分には無理なのでプリミティブ方面を追う)

今回は時間を沢山使えましたが次回は時期的に難しいはず。上記を踏まえてコンパクトなものに挑戦したいと考えています。が、企画は水物なのでどうなるか。画面の明るさ問題は「絵作り」で結果が出たのでちょっと悩みどころなのですが、ビュー数を伸ばす手段として試す価値はありそうだと考えています。

naichiさん、素敵なサイトと1週間ゲームジャムをありがとうございます。今回も多くの収穫がありました。Weeybleさんで準備会や追い込み会でご一緒した皆様、また是非ご一緒できればうれしいです!今回も楽しい実況プレイをしてくださったぱふもどきさん、お疲れさまでした。沢山のゲーム、特にオンラインゲームを楽しめました。1週間ゲームに参加された皆様、遊んでくださって評価してくださった皆様、お疲れさまでした&ありがとうございました!

引き続き、開発ログです。

開発ログ

初日:3/11(月)

テーマが発表されてすぐにモックアップの作成を開始しました。フォントはデザインの要の一つなので早めに選びます。今回の1週間ゲームジャムでは、フォントワークスさんが2か月間の無償ライセンスをご提供くださっていたので使おうとしたのですが、サイトを探してもやり方が見つかりません...。インストールフォルダってどこだ。どうやって探すんだ。ライセンスの内容もどうにも要領を得ず、知りたいことが分かりません。これはキビしい...。ということで、仕様ライセンスの解約とアンインストール。

そして、いつも通りフリーフォント探しの旅に出ました。いつもお世話になっているColissさんが2019年度版のフリーフォント総まとめを出して下さってました!!

この中から、今回のゲームにぴったりのかっこいいフォントが見つかりました。ありがたやありがたや。

ということで、解像度などを確定して、タイトル画面を作って0日目終わり。

作業再開は昼過ぎから、ゲーム画面のモックアップ作りを開始。PostProcessの設定をしたり、プレイヤーの玉やバウンドさせるやつの形を作ったり、アニメーションを作ったりで終了。

作業をしつつステージの構成についても検討。ガンズターンアプリ研究所さんの作品「WHEEL OF FORTUNE」のエンディング演出が素晴らしかったので、ステージ全体で何かを表現できないか考えました。

unityroom.com

ステージ全体が鳥のおもちゃの中で、電線を繋いでいってエンディングで羽ばたかせるのはどうだ、とか考えてました。アセットも探していたのですがよさそうなのが見つからず、方針を転換して今回のアイディアにしました。

f:id:am1tanaka:20190325002227j:plain
つなぐ

6ステージ分の基本的な形がまとめてできたので、ステージ作りは楽にできました。

2日目:3/12(火)

この日も昼過ぎから。

Sleek Renderは速度が速いのだけど、滑らかに形に合わせたBloomが出ないのですよね。ということで、公式PPSに変更することにしました。その後、玉の軌道予測と移動に取り掛かりました。

こんな感じで方針転換。ざっくりとしたものはこの日にできましたが、まだまだ不具合を抱えている状態でした。

また、バウンドさせる丸いのの地味さを解決するために、Pro Builderでエッジを作ってそこを発光させるようにしたりして画面はおおよそ整いました。

3日目:3/13(水)

評価順位の発表までずっとこう思ってました。が、評価ランキングでは絵作りが一番順位が高く、自己判断ってあてにならないなと思った次第^^; ご意見聞くの大事。

以前から使いたかったCamera Play - Asset Storeの演出をようやく入れることができました!いくつもコメントいただきましたし、間違いなく絵作りの評価が高かった理由の一つだと思います。満足^^

4日目:3/14(木)

ゲームの大枠をおおよそ実装。

ここに書いてある「Physics.SimulateがFixedUpdateを呼び出してしまう」というのは勘違いで、これが最終日まで問題がもつれる原因になりました。椿さんのブログに「FixedUpdateは呼ばれない」とちゃんと書いてあったのを誤読していたという...。国語力大事。

5日目:3/15(金)

5日目にして問題発生!

1つ順番が狂えばシミュレーションと実行結果が変わってしまうので苦戦しました。FixedUpdate()が不規則に呼ばれると勘違いしていたことで、余計にこんがらがってました。19時過ぎにようやくひと段落。

クリアのフローを作ったりと残りの作業をばばばばばっと。

6日目:3/16(土)

あと2日しかないし...。クリアが入ったので、残りのステージ作りに取り掛かりました。また、Stage4以降に出る紫のやつも作成。朝から作業を開始して、Stage6まで完了して以下をツイート。

ここからは怒涛の作業。バウンドするやつを壊せるようにしたり、仮エンディング、チュートリアル、ランキングをどどどっと実装しました。

チュートリアルの制作は2時間ぐらい。メッセージと説明用のオブジェクトを、ページごとのゲームオブジェクトの子供にして作っておいて、それをSetActive()で切り替えるというシンプルな方法で実装しました。

画面の変化は殆どないので画像無し。安心できない感じで最終日を迎えました。

最終日:3/17(日)

朝から仕上げの作業。やまださんのimgur版の画像ツイートと仮のエンディングを実装してお昼。Weeybleさんの追い込み会に出発!

weeyble-game.connpass.com

Weeybleさんでは、ラスボスである玉がバウンドさせるやつを抜けてしまうバグ退治。ここにきてようやくPhysics.Simulate()の振る舞いをDebug.Log()で追って、問題を突き止めました。原因はシミュレート自体ではなく、とあるフラグの初期化のタイミングでした。

17時半に解決したのであとは楽勝だと思ってたのですが、ここからラスボスの第2形態が...。初期化でコケるという超初歩的なバグが発生。初期化の流れが今一つ良くなくて、これの解決に20時ギリギリまでかかってしまいました。バウンドさせると消えるのがうまくいかず、最終ステージの仕掛けを一部省いたりしましたが、なんとかアップロード!!

ぴったりなスクショも取れまして。

これにて、公開完了となりました。めでたしめでたし。

その後のバージョンアップ

バウンドさせるやつが消える時の処理や、Stage2のバランス、この企画の冒頭で考えていたエンディングの演出の実装などを終えて、3/19の夜に最終版が仕上がりました!

以上、今回の「跳ね玉」の開発の流れでした。

参考URL

Leap Motionでマウス的な操作をする LeapMotionPointer

Leap Motionを使って、マウスと同じようにスクリーン上の場所を指定する操作を実装しました。以下は、開発中のVoxelorer Birdに組み込んだ作例です。

以下のリポジトリーで公開しています。

github.com

使い方を紹介します。

f:id:am1tanaka:20190217005740g:plain
動作例

目次

前提

動作確認をしたのは以下の環境です。

  • Windows10
  • Unity2017.4.20と2018.3.2
  • Leap Motion Orion 4.0.0
  • Unity Core Assets 4.4.0

WebGLについて

Unity2017.4ではビルドできませんでした。Unity2018.1にして、Unsafe Codeを許可するとビルドはできましたが、実行時にエラーが出て動きませんでした。WebGLでの動かし方は分かっていません。

環境設定

Leap MotionをUnityで使えるようにする手順はこちらの公式ページで説明されています。すでに環境を構築済みでしたら、飛ばして構いません。

  • 公式ページを開きます
  • DOWNLOAD ORION BETAのボタンをクリックして、Leap Motion Orionの最新版をダウンロードしてインストールします
  • 公式のこちらを開きます
  • DOWNLOAD UNITY CORE ASSETS X.X.Xのボタンをクリックして、Unity Core Assetsをダウンロードします

以上で下準備完了です。

デモを動かす

デモの実行方法です。

Leap Motion用のアセットがないので、以下のようなエラーが出ます。次の手順で消えますので作業を進めてください。

f:id:am1tanaka:20190217010038p:plain
エラーが出ても構わず進めて良い

  • 上の手順でダウンロードしたUnity Core Assetsをプロジェクトにインポートします

f:id:am1tanaka:20190217010102p:plain
インポート

これでエラーが消えます。

  • Projectウィンドウから、LeapMotionPointer > Demoフォルダーを開いて、Demoシーンをダブルクリックして開きます

以上でデモ用のシーンが開きます。Playするとデモが動きます。

f:id:am1tanaka:20190217010115p:plain
デモの画面

操作方法

手を水平に開いておくのが基本姿勢です。以下のように、Leap Motionの上に手を開いて、水平にかざします。

f:id:am1tanaka:20190216211447j:plain
基本姿勢

手のひらを水平にしたまま、上下左右に手を動かして画面にカーソルが表示される場所を探してください。Leap Motionから少し奥で、30cmぐらい上の位置ぐらいで表示されると思います。

左手でも操作できます。

左右移動

手を左右に動かします。

f:id:am1tanaka:20190217010155g:plain
左右操作

上下移動

手を上下、あるいは前後に動かします。

f:id:am1tanaka:20190217010233g:plain
上下操作

上下、前後のどちらも、カーソルは上下移動と見なします。

クリック

クリックは、人差し指を下げます。

f:id:am1tanaka:20190216211523j:plain
クリック

人差し指薬指の高さの違いでクリック判定をしています。中指は見ていないので、曲げても曲げなくてもどちらでも楽な方で。

手のひらが人差し指側に傾いていると誤クリックが発生しやすくなり、操作が安定しません。

f:id:am1tanaka:20190216211546j:plain
誤クリックが増える

小指側に傾けておく方が安定した操作ができます。

f:id:am1tanaka:20190216211538j:plain
小指側に傾けると安定する

丸いのをドラッグしたり、左上のボタンをクリックしたりしてみてください。

f:id:am1tanaka:20190217005740g:plain
動作例

手のひらを小指側に傾けておけば、適当に操作してもそれっぽく動きます。

手の認識がうまくいっていないと動作が不安定になります(結構頻繁に起きます)。反対側に動いたり、クリックがおかしかったり、震えたりする場合は、手をLeap Motionの視野から一旦外してから、手を認識しなおしてください。

プロジェクトに組み込む

組み込みたいプロジェクトをUnity2017.4以降で開いてから、以下の作業をします。

必要なアセットをインポート

  • ダウンロードしてあるUnity Core Assets(Leap_Motion_Core_Assets_ x.x.x.unitypackage)をインポートします
  • LeapMotionPointerリポジトリーのReleasesを開いて、最新版のLeapMotionPointerX.X.X.unitypackageをダウンロードして、プロジェクトにインポートします
  • LeapMotionを使いたいシーンを開きます
  • Projectウィンドウで、LeapMotionPointer > Prefabsフォルダーを開きます
  • LeapMotionPointerプレハブをドラッグして、Hierarchyウィンドウにドロップします

これで準備完了です。ついでに、動作確認のためにデモ用のCanvasを配置しておくと楽です。

  • ProjectウィンドウのLeapMotionPointer > Demo > Prefabsフォルダーを開いて、DemoCanvasプレハブをHierarchyウィンドウにドロップします
  • EventSystemがシーンにない場合は、HierarchyウィンドウのCreateボタンをクリックして、UI > Event Systemを選択して追加します

f:id:am1tanaka:20190217010456p:plain
Hierarchyの様子

これでLeapMotionを使ってカーソルを操作できます。カーソルは、DemoCanavsの子供のCursorオブジェクトです。これの画像を差し替えればオリジナルのものに差し替えることができます。

f:id:am1tanaka:20190217010526p:plain
DemoCanvas

スクリプトで情報を得る

情報は、LeapMotionManagerExクラスのstaticプロパティーで得られます。

利用したいスクリプトの冒頭に、以下のusingを追加します。

// :
using AM1.LeapMotionPointer;

bool LeapMotionManagerEx.isEnable

Leap Motionで手を確認している時にtrueになります。

Vector3 LeapMotionManagerEx.screenPoint

Leap Motionが指している画面座標を返します。

// :
Debug.Log(LeapMotionManagerEx.screenPoint);

補足

デフォルトの設定では、Camera.mainのスクリーン座標を返します。Main Cameraタグが未設定だった場合など、Camera.mainが取得できない状態の時はscreenPointは無効な値を返します。

カメラを指定するには、シーンに配置したLeapMotionPointerオブジェクトのTarget Cameraプロパティーに目的のカメラを設定します。

f:id:am1tanaka:20190217010543p:plain
カメラを設定する場所

Vector3 LeapMotionManagerEx.viewportPosition

Leap Motionが指している場所をビューポート座標で返します。

bool LeapMotionManagerEx.isPressDown

クリックを開始した時にtrueになります。

// :
if (LeapMotionManagerEx.isPressDown) {
    Debug.Log("クリック!");
}

bool LeapMotionManagerEx.isPress

クリック状態の時、ずっとtrueになります。ドラッグを判定したい場合などに利用します。

// :
if (LeapMotionManagerEx.isPress) {
    Debug.Log("押し続けている");
}

bool LeapMotionManagerEx.isPressUp

クリックが解除された時にtrueになります。

// :
if (LeapMotionManagerEx.isPressUp) {
    Debug.Log("クリック終了");
}

UIのボタン

UIのボタンは、クリック時に自動的に押すようにしてあります。何もしなくても反応します。

パラメーター

LeapMotionPointerの調整用パラメーターは以下の通りです。

f:id:am1tanaka:20190217012026p:plain
LeapMotionPointerのインスペクター

  • Leap Provider
  • Model Pool
    • 手のモデルを表示したい時に利用します。本プロジェクトでは設定不要です
  • Target Camera
    • LeapMotionManagerEx.screenPointを計算する時に使うカメラを指定します。未設定の時は、Camera.mainの値を使います。Camera.mainnullの時は、LeapMotionManagerEx.screenPointの値が設定されません
  • Move Rate
    • 手の動きと、カーソルの動きを対応させる係数です。この値を大きくすると、手の動きに対して、カーソルの動きが速くなります
  • Visible Under
    • 手の低さの下限値です。この値を小さくすると、低い位置で手を認識するようになります。小さくしすぎると指の動きが認識できなくなるので、0.15程度が下限です
  • Click Threshold
    • クリックを判別する人差し指と薬指の高さの差です。この値を大きくすると、クリックの誤動作は減りますが、クリックの反応が鈍くなります
  • Bank Limit
    • 手首の傾きがこの値よりも大きくなったら、誤動作を避けるためにクリック判定を無視します。0は傾き無し。0.5が90度です
  • Viewport Click Limit
    • 画面端でクリックを無視する範囲です。特に不要な場合は0のままで構いません
  • Flat Rate
    • 手の震えを止めるための平均係数です。この値を小さくすると反応はよくなりますが、Leap Motionの誤差による震えが出やすくなります

特に調整する必要はないと思います。手を認識する場所を下げたい時に、Visible Underを設定するぐらいだと思います。

今後について

現在、UIのボタンは無理やりButtonコンポーネントを取得して、クリック時のイベントを実行するようにしています。レイヤーの指定などができず、他の要素のクリックもできないので、将来的にはEvent Systemに対応させることを考えています。

人差し指と薬指の高さ判定に手首の回転を考慮していませんが、試しに実装したら動作が不安定になったので削除した経緯があります。よい方法があればご教示いただければ幸いです。

プルリク歓迎です。

github.com

ライセンス

MITライセンス

参考URL

www.leapmotion.com

UnityのML-Agentsで、新しい学習環境を作成する(0.6.0a版)

0.7.0だと色々変更になったものと思います。たっつー様が0.7.0の導入方法を以下で公開して下さっていることをお知らせくださいました。

www.fast-system.jp


Unityで新規プロジェクトを作って、ML-Agentsの0.6.0aを組み込む手順です。

f:id:am1tanaka:20190117011444g:plain
こんな感じ

以下のML-Agentsリポジトリーのドキュメントを元に進めていきます。

github.com

目次

動作環境

以下で確認しました。

  • Windows10
  • Unity2018.2.10
  • ML-Agents Beta 0.6.0a

ML-Agentsのリポジトリーをクローンしていなかったり環境構築ができていない場合は、以下で済ませてください。

am1tanaka.hatenablog.com

0.5.0で環境を作成済みの場合

PythonとAnaconda、TensorFlowは、0.5.0と同じバージョンなのでそのまま使えます。Pythonの実行環境に0.6.0用のツールをインストールする必要があるので、新しく実行環境を作ってインストールします(0.5.0を全く使わなくなるのであれば、0.5.0用のものに上書きインストールしても大丈夫そうです)。

  • こちらML-Agentsツールキットリポジトリーのダウンロードに従って、ML-Agentsのリポジトリーをクローンするか、ダウンロードして、ドキュメントフォルダーなど使いやすいところに展開してください
  • スタートメニューなどから、Anaconda Promptを起動します

f:id:am1tanaka:20190117132534p:plain
Anaconda Promptを起動

  • 以下を実行して0.6.0用のPythonの実行環境を作成します。質問が表示されたらyキーでインストールを進めます
conda create -n ml-agents060 python=3.6
  • 完了したら、以下を実行して実行環境を開始します
activate ml-agents060
  • cdコマンドで、クローンやダウンロードした0.6.0のML-Agentsフォルダーを開きます
  • cd ml-agentsml-agentsフォルダーを開きます
  • 以下のコマンドを実行します
pip install -e .
pip install pypiwin32

以上で、0.6.0用のファイルがインストールされます(2行目のpypiwin32のインストールは、2019/1/17時点で発生するエラーを回避するためのものです。そのうち不要になるかも。こちら参照)。

Anaconda Promptはあとで利用するので開きっぱなしにしておいても構いません。

このチュートリアルで作るもの

ランダムな場所に登場するキューブを取るようにボールを操作するAIを学習して作ります。また、ボールが地面から落下しないようにもします。

  1. AIで動かすオブジェクトであるエージェント(Agent)が活動する環境(environment)をUnity上に作ります。環境は、いくつかのオブジェクトによるシンプルな物理シミュレーションから、ゲームやエコシステム全体まで含みます
  2. アカデミー(Academy)サブクラスを実装してゲームオブジェクトにアタッチして、環境を組み込んだUnityのシーン内に配置します。アカデミークラスには、AIエージェントとは別にシーンを更新するいくつかのオプションのメソッドを実装できます。例えば、環境内に、AIエージェントやその他のオブジェクトを追加、移動、削除したりできます
  3. 1つ以上のAIのブレイン(Brain=脳)を、AssetsメニューやProjectウィンドウのCreateボタンから、Create > ML-Agents > Brainを選択して作ることができます。名前は自由につけることができます
  4. エージェントサブクラスを実装します。エージェントサブクラスは、環境を観察するためのコードを定義して、行動を割り当てて、強化学習のための報酬(Reward=リワード)を計算します。また、学習が終了したり、タスクが失敗した時に、エージェントをリセットするメソッドを実装することができます

  5. AIで制御したいゲームオブジェクトに、作成したエージェントサブクラスをアタッチすることで、そのオブジェクトはAIで行動するようになります。エージェントには必ずブレインアセットを割り当てる必要があります

  6. AIを学習(Training)させる時は、アカデミーオブジェクトのBroadcastHub欄のControlチェックボックスにチェックを入れます
  7. 学習してできたモデルデータを使ってUnityでAIを動かすには、アカデミーオブジェクトのControlチェックボックスのチェックを外して、モデルデータをブレインに設定します。学習についてはこちら

Note

  • Unityの操作になじみがなく、このマニュアルの操作が理解できない場合は、Unityの公式マニュアルのLearning the interfaceをおすすめします。

Unityプロジェクトの作成

まずは、新規でUnityプロジェクトを作成して、ML-Agentsを組み込みます。

  • Unity2017.4以降を起動して、RollerBallなどの名前で新しいプロジェクトを作成します
  • Editメニューから、Project Settings > Playerを選択します

以下を、利用したいプラットフォームごとに実施します

  • Other Settingsを開きます
  • Scripting Runtime VersionExperimental、あるいは.NET 4.6 Equivalent、あるいは.NET 4.x Equivalentにします(2018.3ではデフォルトで4.xになっているのでこの手順は不要)
  • Restartするかのウィンドウが表示されたら、Restartします

ML-Agentsのデータをプロジェクトに読み込みます。

  • エクスプローラーで、ダウンロード(あるいはクローン)して展開したml-agentsフォルダーを開きます
  • UnitySDK/Assetsフォルダーを開きます
  • フォルダー内にある全てのファイルとフォルダーを選択したら、ドラッグしてUnityのProjectウィンドウにドロップしてインポートします

f:id:am1tanaka:20190115235829p:plain
Import ML-Agent System

Unityのバージョンによって表示は変わりますが、おおよそ以下のようになります。

f:id:am1tanaka:20190115235932p:plain
Imported Packages

環境(Environment)を作る

ML-Agentsの環境用のシーンとして、エージェントが乗っかる床となるPlane、エージェントがゴールや目標として探索するCube、エージェントを表すSphereを作成します。

床のPlaneを作る

  • HierarchyウィンドウのCreateをクリックして、3D Object > Planeを選択します
  • 作成したPlaneの名前をFloorにします
  • 作成したFloorをクリックして選択します
  • InspectorウィンドウのTransform欄を以下の通り設定します
    • Position = 0, 0, 0
    • Rotation = 0, 0, 0
    • Scale = 1, 1, 1
  • InspectorウィンドウのMesh Renderer欄にあるMaterialsの左の三角をクリックして開いたら、Element 0の右の〇をクリックして、ウィンドウからLightGridFloorSquareマテリアル(別のものでも構いません)を選択して割り当てます

f:id:am1tanaka:20190116000559p:plain
Set Material

以上で床は完成です。

取るためのキューブを作る

  • HierarchyウィンドウのCreateをクリックして、3D Object > Cubeを選択します
  • 作成したCubeの名前をTargetにします
  • 作成したTargetをクリックして選択します
  • InspectorウィンドウのTransform欄を以下の通り設定します
    • Position = 3, 0.5, 3
    • Rotation = 0, 0, 0
    • Scale = 1, 1, 1
  • InspectorウィンドウのMesh Renderer欄にあるMaterialsの左の三角をクリックして開いたら、Element 0の右の〇をクリックして、ウィンドウからBlockマテリアルを選択して割り当てます

エージェント(Agent)とするSphereを作る

  • HierarchyウィンドウのCreateをクリックして、3D Object > Sphereを選択します
  • 作成したSphereの名前をRollerAgentにします
  • 作成したRollerAgentをクリックして選択します
  • InspectorウィンドウのTransform欄を以下の通り設定します
    • Position = 0, 0.5, 0
    • Rotation = 0, 0, 0
    • Scale = 1, 1, 1
  • InspectorウィンドウのMesh Renderer欄にあるMaterialsの左の三角をクリックして開いたら、Element 0の右の〇をクリックして、ウィンドウからCheckerSquareマテリアルを選択して割り当てます
  • Add Componentをクリックします
  • PhysicsからRigidbodyを選択してアタッチします

後程、このオブジェクトにエージェントサブクラスをアタッチします。

アカデミー(Academy)を持たせるための空のゲームオブジェクトを作る

  • HierarchyウィンドウのCreateをクリックして、Create Emptyを選択します
  • 作成したGameObjectの名前をAcademyにします

以上でシーンが完成です。

f:id:am1tanaka:20190116001537p:plain
Created Hierarchy

Main Cameraの座標や角度を調整して、Gameウィンドウで見やすくなるようにしてください。

f:id:am1tanaka:20190116001428p:plain
Game Window Sample

アカデミーの実装

アカデミーオブジェクトは、シーン内のML-Agentsを動かして、観測-意思決定-行動というシミュレーションループを制御します。ML-Agentのシーンごとに1つのアカデミーのインスタンスが必要です。アカデミークラスのベースクラスはabstractなので、メソッドを実装する必要がなくてもサブクラスを作成する必要があります。

先に作成したアカデミーオブジェクトに新しいスクリプトを追加します。

  • HierarchyウィンドウからAcademyオブジェクトをクリックして選択します
  • Inspectorウィンドウで、Add Componentをクリックします
  • New Scriptを選択して、RollerAcademyという名前で作成します
  • 作成したRollerAcademyスクリプトをダブルクリックして、エディターで開きます
  • MLAgentsの機能を使うために、using MLAgents;を定義します
  • クラスの継承元をMonoBehaviourからAcademyに変更します
  • Start()Update()メソッドを削除します

基本的な機能はベースクラスのAcademyが持っているので、実装は不要です。以下の通りにしたら、上書き保存をしてUnityに切り替えます。

using MLAgents;

public class RollerAcademy : Academy { }

デフォルトの設定で問題なく動作しますのでそのままの設定で使います。Inspectorウィンドウで変更する項目はありません。

f:id:am1tanaka:20190116103613p:plain
Default MLAgents

ブレイン(Brain)を追加する

ブレインアセットは、行動を決める処理を担当します。エージェントは自らが観測した情報をブレインに送ります。ブレインは送られてきた観測情報を元に行動を決定してエージェントに伝えます。エージェントは、ブレインから受け取ったデータに従って行動します。作成するブレインアセットの種類によって、そのブレインの行動の決め方を選択することができます(Learning=AI学習, Heuristic=アルゴリズムで実装, Player=人間が操作)。

ブレインアセットを作成します(0.5.0からこの部分が完全に変わりました!)

  • ProjectウィンドウのCreateボタンをクリックして、ML-Agentsから、作成したいBrainの種類のアセットを選択します。ここでは、Learning BrainPlayer Brainを作成します

f:id:am1tanaka:20190116104825p:plain
Create Asset

f:id:am1tanaka:20190116104845p:plain
Create Brains

  • 作成したら、それぞれの名前をRollerBallBrainと、RollerBallPlayerにします

f:id:am1tanaka:20190116105019p:plain
作成した2つのBrain

設定は実際に動かす時に行うので、一先ずこのままで先に進めます。

エージェントの実装

エージェントを制御するスクリプトを作成します。

  • Hierarchyウィンドウから、RollerAgentオブジェクトをクリックして選択します
  • Inspectorウィンドウで、Add Componentをクリックします
  • New Scriptを選択して、RollerAgentという名前で作成します
  • 作成したRollerAgentスクリプトをダブルクリックして、エディターで開きます
  • Academyの時と同じように、usingを設定して、ベースクラスをMonoBehaviourからAgentに変更します

以下のようなコードになります。

using MLAgents;

public class RollerAgent : Agent { }

上書き保存をして、Unityに戻ります。

ここまでの手順は、あらゆるUnityのプロジェクトにML-Agentsを加える基本的な手順です。次に、強化学習を使ってSphereのエージェントがキューブを取るように動かすためのロジックを加えていきます。

今回のシンプルなシナリオでは、アカデミーオブジェクトに環境の変更は実装しませんが、シミュレーション前やシミュレーション中に、床の大きさを変えたり、エージェントやその他のオブジェクトを追加したり削除したりしたい場合は、アカデミーにメソッドを自由に追加して実装することができます。ここでは、エージェントが成功したり失敗した時に、エージェントや目標物をリセットすることだけを行います。

エージェントの初期化とリセット

今回作成するエージェントは、Targetに触れたら自分自身でそのことを確認して、Targetをランダムな座標に配置し直すリセット関数を呼び出します。また、地面から落下したらリセット関数によって地面に戻します。

Targetオブジェクトに辿り着くには、エージェントはTargetTransformへの参照を知っている必要があります(Transformには、3D空間における座標、回転、拡大率が記録されています)。そのために、RollerAgentクラスにpublicTransformを定義します。これにより、InspectorウィンドウでTargetTransformを渡せるようになります。

エージェントの速度をリセットしたり、エージェントを動かすための力を与えるために、Rigidbodyコンポーネントの参照が必要です。Rigidbodyは、Unityで物理シミュレーションをするための基本的なエレメントです。スクリプトのゲームオブジェクトにアタッチされているRigidbodyへの参照は、Start()メソッド内で、GameObject.GetComponent<T>()を使って取得します。

RollerAgent.csは以下のようになります。

using System.Collections.Generic;
using UnityEngine;
using MLAgents;

public class RollerAgent : Agent {
    Rigidbody rBody;
    private void Start()
    {
        rBody = GetComponent<Rigidbody>();
    }

    public Transform Target;
    public override void AgentReset()
    {
        if (this.transform.position.y < 0)
        {
            // エージェントが落ちた
            this.rBody.angularVelocity = Vector3.zero;
            this.rBody.velocity = Vector3.zero;
            this.transform.position = new Vector3(0, 0.5f, 0);
        }

        // ターゲットを新しい場所へ移動させる
        Target.position = new Vector3(
        Random.value*8-4,
            0.5f,
            Random.value*8-4
        );
    }
}

次は、Agent.CollectObservations()関数(情報を収集する関数)を実装します。

環境を観測する(Observing the Environment)

エージェントは、収集した環境の情報をブレインに送ります。ブレインは送られてきた情報を使って行動を決めます。エージェントを学習する時、あるいは、学習済みのモデルを利用する時に、観測(Observation)したデータをfeature vector(観測結果を表すベクトルデータ)としてニューラルネットワークに与えます。エージェントの学習を成功させるためには、正しい情報を与えなくてはなりません。どの情報を与えるのが正しいかを決めるよい指標は、問題を解決するために何が必要かを分析して考えることです。

今回の場合、エージェントは以下の情報を集めます。

  • ターゲットの位置
// :
AddVectorObs(Target.position);
  • エージェント自身の位置
// :
AddVectorObs(this.transform.position);
  • エージェントの速度。速度があれば、Targetを行き過ぎたり、床から転落したりするのを防ぐことを学習する助けになります
// :
AddVectorObs(rBody.velocity.x);
AddVectorObs(rBody.velocity.z);

以上、8次元のベクトル(TargetのX, Y, Z、AgentのX, Y, Z, Agentの速度X, Z)で、観測したデータをブレインに渡します。まとめると、以下のようになります。RollerAgent.csスクリプトRollerAgentクラス内に、以下のメソッドを追加します。

// 32:
    public override void CollectObservations()
    {
        // TargetとAgentの位置
        AddVectorObs(Target.position);
        AddVectorObs(this.transform.position);

        // Agentの速度
        AddVectorObs(rBody.velocity.x);
        AddVectorObs(rBody.velocity.z);
    }

エージェント用のコードの仕上げは、ブレインが選択した行動を受け取って、報酬を与えるAgent.AgentAction()メソッドの作成です。

Actions

ブレインが決めた行動は、AgentAction()関数に配列で渡されます。この配列の要素数は、エージェントのブレインのVector Actionの設定のSpace TypeSpace Sizeによって決まります。今回作成しているRollerAgentは、行動データを加える力として利用します。力はfloat値(連続的な値)として使いたいので、Space TypeContinuous(連続的)を選択します。行動に必要なデータの個数を表すAction Sizeには2を設定します。1つ目のエレメントaction[0]X方向に加える力、2つ目のaction[1]Z方向に加える力とします(もし、Y方向の移動もあった場合は、Action Size3にして、Y方向の力の分を増やします)。ブレインは、これらの値がどのようなものかは把握しません。学習は、観測した入力に対して返す値を調整した結果、どのような報酬が得られるかということだけに注目して行われます。

(補足) Space TypeDiscreteにすると、ブレインからは整数値が行動として返されるようになります。ボードゲームのマス目や、「止まる」「歩く」「パンチする」「食べる」など整数で表せる行動をさせたい場合は、Discreteにします。

RollerAgentaction[]配列の値をRigidbodyコンポーネントであるrBodyAddForce()で反映させます。以下、コード例です。実際に追加するコードは後述します。

// :
Vector3 controlSignal = Vector3.zero;
controlSignal.x = action[0];
controlSignal.z = action[1];
rBody.AddForce(controlSignal * speed);

報酬(Rewards=リワード)

強化学習(Reinforcement learning)では報酬の設定が必要です。報酬は、AgentAction()関数内で割り当てます(他の場所では無効になるので注意!!)。学習アルゴリズムは、シミュレーションのステップごとにエージェントに報酬を与えて、エージェントにとって最適な行動が何かを学習するのに利用します。エージェントが目的を達成したら(今回ならTargetオブジェクトに辿り着いたら)報酬を与えて、望まない行動をしたら(今回なら床から転落したら)報酬を取り上げます。今回はTargetオブジェクトに辿り着いたら1の報酬を与えます。

RollerAgentは、Targetに辿り着いたかを検出するために距離を計算します。算出した距離が到達したと判断する値以下になっていたら、Agent.SetReward()メソッドを呼び出してエージェントに1の報酬を与えて、完了したことを報告するためにDone()を呼び出します。

(補足) 報酬を与えるメソッドが、AddRewardからSetRewardに改名されました。

// :
float distanceToTarget = Vector3.Distance(this.transform.position,
                                          Target.position);
// ターゲットに辿り着いたか
if (distanceToTarget < 1.42f)
{
    SetReward(1.0f);
    Done();
}

メモ: Done()を呼び出してエージェントが完了したことを知らせると、リセットするまで動作が停止します。Agent.ResetOnDoneプロパティーをインスペクター上でTrueに設定しておくことで、完了したらすぐに自動的にエージェントをリセットすることもできますし、アカデミーがMaxStepに到達して、環境をリセットするのを待つこともできます。今回はResetOnDoneプロパティーTrueに設定してリセットします。MaxStep0のままにして、アカデミーが環境をリセットしないようにします。

最後に、プラットフォームから転落した時にDoneを呼び出して、次のステップで自分自身をリセットさせます。

// :
// プラットフォームからの転落
if (this.transform.position.y < 0)
{
    Done();
}

(補足) 0.5.0では床から転落した時に報酬を-1していましたが、その処理がなくなっています。あえて報酬を下げなくても、報酬が得られないだけで学習には十分なようです。

AgentAction()

行動と報酬の考え方は以上の通りです。AgentAction()関数の完成形は以下のようになります。RollerAgent.csRollerAgentクラス内に加えてください。

// 43:
    public float speed = 10;
    public override void AgentAction(float[] vectorAction, string textAction)
    {
        // 動作の設定。sizeが2なのでvectorActionは2つ
        Vector3 controlSignal = Vector3.zero;
        controlSignal.x = vectorAction[0];
        controlSignal.z = vectorAction[1];
        rBody.AddForce(controlSignal * speed);

        // Targetとの距離
        float distanceToTarget = Vector3.Distance(
            this.transform.position,
            Target.position);

        // Targetに接触したか
        if (distanceToTarget < 1.42f)
        {
            SetReward(1);
            Done();
        }

        // プラットフォームから転落
        if (this.transform.position.y < 0)
        {
            Done();
        }
    }

speedプロパティーを関数の前にpublicで定義することで、Inspectorウィンドウで速さを調整できるようにしてあります。

仕上げのエディター設定

全てのゲームオブジェクトとML-Agentコンポーネントの設定が完了したので、データを接続していきます。

  • HierarchyウィンドウのAcademyオブジェクトをクリックして選択します
  • ProjectウィンドウのBroadcast Hubの下のAdd Brain to Broadcast Hubボタンをクリックします

f:id:am1tanaka:20190116131430p:plain
1つ目のBrain欄を追加

  • もう一つ設定したいので、Add Newボタンをクリックして増やします

f:id:am1tanaka:20190116153255p:plain
Add Newで2つ目のBrain欄を追加

  • ProjectウィンドウからRollerBallBrainをドラッグして、InspectorウィンドウのBrains欄にドロップします。RollerBallPlayerも同様に2つ目のBrains欄にドラッグ&ドロップします

f:id:am1tanaka:20190116153857p:plain
Brainアセットを設定

  • HierarchyウィンドウからRollerAgentオブジェクトをクリックして選択します
  • ProjectウィンドウからRollerBallPlayerをドラッグして、InspecorウィンドウのBrain欄にドロップします
  • InspectorウィンドウのDecision Frequency10にします(ブレインは10ステップごとに意思決定をして、行動は毎フレーム実行します)
  • HierarcyウィンドウからTargetオブジェクトをドラッグして、InspectorビューのTarget欄にドロップします

f:id:am1tanaka:20190116154114p:plain
RollerAgentの設定

最後に、Brainアセットの設定をします。

  • ProjectウィンドウからRollerBallBrainアセットをクリックして選択したら、Inspectorウィンドウで以下を設定します。
    • Vector ObservationSpace Size = 8
      • ブレインに送る観測データベクトルの次元数(要素数)
  • Vector ActionSpace Type = Continuous
    • 行動結果を表すベクトルを、整数(Discrete=不連続)で返すか、小数(Continuous=連続)で返すか
  • Vector ActionSpace Size = 2
    • 行動結果として返すベクトルの次元数(要素数)

ProjectウィンドウからRollerBallPlayerアセットをクリックして選択して、以上と同じく設定します。これで環境を試すための準備が整いました。

f:id:am1tanaka:20190116154929p:plain
Brainアセットの設定

環境を手動で試す

実際に学習を開始する前に、手動で環境を試すのがおすすめです。RollerAgentBrainRollerBrainPlayerを設定したので、キー入力でAgentオブジェクトを操作することができます。実行する前に、前後左右の4方向に移動するためのキーを4つ割り当てます。

  • ProjectウィンドウからRollerBallPlayerアセットをクリックして選びます
  • InspectorウィンドウのKey Continuous Player Actions欄を開きます(この設定は、PlayerBrainのみ表示されます)
  • Size4にします
  • 以下の通り、設定します
Element Key Index Value
Element 0 D 0 1
Element 1 A 0 -1
Element 2 W 1 1
Element 3 S 1 -1

Indexの値は、AgentAction()関数に渡す配列のインデックスを表します。Valueの値は、Keyが押された時にvectorAction[Index]に渡される値です。

Playすると、[W][A][S][D]キーで、Agentを操作することができます。エラーが発生しないことと、Targetに触ったり床から落ちたらエージェントがリセットされることを確認してください。ML-Agents SDKには、ゲームウィンドウにエージェントの状態を簡単に表示させることができるMonitorクラスが用意されています。より詳細な状態が見たい場合は利用するとよいでしょう。

(ここではやりませんが)作成した環境とPython APIが想定通りに動くかどうかを、Jupyter notebookを使って試すことができます。確認のためには、notebooks/getting-started.ipynbを利用します。ノートブックのenv_nameに、この環境をビルドして生成した実行ファイル名を設定します。

環境の学習

学習を開始するには、AgentのBrainをRollerBallBrainに変更して、AcademyオブジェクトのControlプロパティーにチェックを入れます。

  • HierarchyウィンドウでRollerAgentをクリックして選択します
  • ProjectウィンドウからRollerBallBrainをドラッグして、InspectorウィンドウのBrain欄にドロップします

f:id:am1tanaka:20190116160552p:plain
Brainを入れ替え

  • HierarchyウィンドウでAcademyオブジェクトをクリックして選択します
  • InspectorウィンドウのBroadcast Hub欄に設定したRollerBallBrainの右のチェックボックスにチェックを入れます

f:id:am1tanaka:20190116160825p:plain
RollerBallBrainを有効化

これで、AIのブレインを利用するようになります。ここからの設定は、Training ML-Agentsと同様です。

mlagents-learnプログラムに渡すconfigurationファイル内の学習のためのパラメーターを設定します。Clone、あるいはダウンロードしたml-agentsフォルダー内のconfig/trainer_config.yamlファイルにデフォルト値が設定されています。

f:id:am1tanaka:20190116222250p:plain
学習設定

今回は、この設定ファイルのdefault設定を利用します。そのままの設定で学習させる場合、30万ステップ程度学習させる必要があります。しかし、以下の設定をすることで、2万ステップ程度で学習を完了させることができるようになります。

batch_size: 10
buffer_size: 100

今回のサンプルは、入力も出力も数が少ないシンプルな学習なので、小さなバッチ(batch)やバッファー(buffer)サイズにして、学習を高速化することができます。ただし、環境が複雑になったり、報酬や観測方法を変更したら、このパラメーターは調整が必要になるかも知れません。

Note: trainer_config.yamlに加えて、AgentDecisionFrequencyパラメーターも、学習時間や成功するかどうかに大きく影響します。大きな値を設定すると、学習アルゴリズムが行動を判断する回数を減らすことができるので、今回のようなシンプルな環境では学習のスピードアップにつながります。

エディターで学習を開始するには、UnityでPlayする前に、ターミナルやコマンドプロンプトからPythonコマンドを実行します。

  • Anaconda Promptを起動していなかければ、スタートメニューなどから起動します
  • 以下を実行して、ML-Agents用の実行環境を開始します
activate ml-agents060
  • クローンやダウンロードしたml-agentsフォルダーにcdコマンドで移動します
  • 初めて学習する時は、設定を調整するために、configフォルダー内のtrainer_config.yamlを何らかのエディターで開きます
  • defaultの設定の以下の部分を書き換えます

f:id:am1tanaka:20190116233317p:plain
config.yaml

  • 名前を付けて保存を選択して、config.yamlの名前で保存します
  • Anaconda Promptで以下を実行します
mlagents-learn config/config.yaml --run-id=RollerBall-1 --train

しばらく待つと以下のような画面が表示されて、最後にUnityをPlayするようにメッセージが出るので、UnityをPlayしてください。

f:id:am1tanaka:20190117002030p:plain
レーニング開始

Unity上で学習が始まります。2万ステップの学習が完了したら、Anaconda Promptが以下のように表示されて学習が完了します。

f:id:am1tanaka:20190117002241p:plain
レーニング完了

学習の様子は、TensorBoardを使ってグラフで確認できます。

Anaconda Promptで、以下を実行します。

tensorboard --logdir=summaries

以下のようなメッセージが表示されます。

f:id:am1tanaka:20190117002833p:plain
ログの確認

  • Webブラウザーで、メッセージの最後の部分に書かれているhttp://で始まるURLを開いてください
  • 以下のようにグラフが確認できます

f:id:am1tanaka:20190117003106p:plain
TensorBoard

Environment欄のCumulative Rewardと、Policy欄のValue Estimateのグラフで、エージェントが目的をどれぐらい達成できたかを把握できます。今回の例では、エージェントが得られる最大の報酬は1.0です。エージェントが目的を達成するほど、グラフは1.0に近づきます。

Note: TensorBoardを利用する場合、mlagents-learnコマンドで学習を実行するたびに、run-idの部分を増やすなどして変更した方がよいかも知れません。同じrun-idで学習させると、過去の学習結果のグラフも重ねて表示されるので、傾向の把握が難しくなる可能性があります。

f:id:am1tanaka:20190117153604p:plain
同じrun-idで学習させた時のグラフ

シーンのまとめ

Unity環境で、ML-Agentsを利用する時にシーンをどのように構成するかをまとめます。

Unity ML-Agentを利用する場合、一つのアカデミーと、一つ以上のエージェントゲームオブジェクトが必要です。また、利用したい種類のブレインアセットを作成して、エージェントアカデミーに設定する必要があります。

約束事です。

  • 一つのシーンには、アカデミーゲームオブジェクトを一つだけ配置します
  • 学習に利用できるブレインは、アカデミーBroardcast Hubリストに追加したものだけです

参照したドキュメントは以上です。以下はこのブログでの追記です。

学習したモデルを試す

学習が完了したモデルを使って、実際にRollerAgentを動かしてみます。再生するには、TensorflowSharpプラグインをプロジェクトにインポートする必要があります。0.5.0の時と同じプラグインが利用できるので、ダウンロード済みのTFSharpPlugin.unitypackageがあればそれを利用できます。

f:id:am1tanaka:20190117005821p:plain
TFSharpパッケージのダウンロード

  • ダウンロードしたTFSharpPlugin.unitypackageをドラッグして、Projectウィンドウにドロップして、インポートします
    • PC上で試すだけなら、AndroidiOSプラグインは不要なので、チェックを外した方が容量やインポート時間を節約できます。

f:id:am1tanaka:20181114001257p:plain

  • Editメニューから、Project Settings > Playerを開きます
  • Other SettingsScripting Define Symbolsに、ENABLE_TENSORFLOWと入力します
  • Allow 'unsafe' Code欄にチェックを入れます

以上、ビルドしたい全てのタブでおこないます。

f:id:am1tanaka:20190117010625p:plain
Tensorflowを有効にする

学習させたモデルデータをブレインに設定します。

  • エクスプローラーなどで、ML-Agentsをクローンやダウンロードしたフォルダーを開きます
  • フォルダー内のmodels > RollerBall-1を開きます
  • RollerBallBrain.bytesをドラッグして、UnityのProjectウィンドウにドロップしてインポートします

f:id:am1tanaka:20190117005024p:plain
モデルファイルをインポート

  • Projectウィンドウから、RollerBallBrainアセットをクリックして選択します
  • Projectウィンドウから、インポートしたRollerBallBrainをドラッグして、InspectorウィンドウのModel欄にドロップします

f:id:am1tanaka:20190117005243p:plain
モデルデータを設定

  • HierarchyウィンドウからAcademyオブジェクトをクリックして選択します
  • InspectorウィンドウのRollerBallBrain欄のControlのチェックを外します

以上で学習したモデルデータを使ってRollerAgentが動くようになります。

f:id:am1tanaka:20190117011444g:plain
完成!!

おまけ

default以外の設定を使う

ドキュメントではconfig.yamldefault設定を書き換えましたが、ブレインアセットの名前をキーにして、ブレインごとの設定を作ることができます。

f:id:am1tanaka:20190117155615p:plain
ブレイン用の設定を作る

上記のようにすることで、defaultを書き換えなくても、RollerBallBrainを学習させるときに利用したい設定をすることができます。

ログの見方

コンソール画面に謎の文字が表示されますが、ここから学習がどのように進んでいるかを読み取ることができます。このログは、設定した回数ごとの集計になっています。デフォルトでは千回に1回、集計されて以下のように表示されます。

f:id:am1tanaka:20190117155837p:plain
ログ

重要なのはStep以降の部分です。

Step

何ステップ学習したかを表示します。今回は2万ステップ設定したので、Step: 20000.で終了しています。

Mean Reward

獲得した報酬の平均値です。最初の千回の平均は0.212で、かなり失敗していることが分かります。学習を進めることでどんどん改善して、1万4千ステップには1.000を達成しています。ほぼ全部ターゲットを取ったということです。

Std of Reward

報酬の標準偏差です。標準偏差とは、データのバラつきを表す値です。全てのリワードが同じ値ならこの値は0になり、バラけているほど大きな値になります。

AIがめちゃくちゃに動いている最初の方は、得られる報酬がバラバラなので大きな値になりがちです。頭が良くなるにつれて行動が似てくるので報酬のバラつきが減り、この値は小さくなっていくのが一般的です。

最初からこの値が小さい場合、めちゃくちゃに動いても報酬に変化がないことになります。この場合、学習のしようがないので報酬の与え方がよくないか、エージェントの設定に失敗している可能性があります。

学習の再開

同じrun-idで学習を開始しても、前に学習した内容は破棄されて学習はやり直しになります。今回は2万ステップで学習は十分でしたが、試した結果、もう少し学習を継続させたい場合があります。その時は、config.yamlを開いてmax_stepsの値を増やして上書き保存をしてから、Anaconda Promptで以下を実行すれば、先ほどのデータの続きから学習を再開できます。

mlagents-learn config/trainer_config.yaml --run-id=RollerBall --train --load

注意!!: すでに学習ステップ数がmax_stepsに達していたら、学習を再開させてもすぐに終わってしまいます。学習回数を増やす場合は、config.yamlmax_stepsを増やす必要があります。

学習効果を高める(おまけ)

0.5.0と共通の知見としては、以下が挙げられます。

バッチとバッファの設定を適切にする

default値のまま学習すると、2万ステップでは学習が全く足りませんでした。どのぐらいの値がよいかの指標があるのかないのかも含めて調査したい項目です。

ベクトルの観測データはベクトルのまま渡す

観測データ(CollectObservations()メソッド内でAddVectorObs()メソッドで渡すデータ)がベクトルの場合、使ってないデータがあってもベクトルのまま渡した方がよさそうでした。

今回のサンプルでは、RollerAgentXZの速度を個別のAddVectorObs()メソッドで渡していますが、これによって学習効果が下がってしまうようです。

RollerBallBrainアセットのSpace Size9にして、RollerAgent.csスクリプトCollectObservations()メソッドを以下のように書き換えて、学習しなおすと効果が分かります。

// 36:
    public override void CollectObservations()
    {
        // TargetとAgentの位置
        AddVectorObs(Target.position);
        AddVectorObs(this.transform.position);

        // Agentの速度
        AddVectorObs(rBody.velocity);
    }

以下、学習結果です。青がサンプルのまま。オレンジがRollerAgentの速度をベクトルで与えた時のものです。

f:id:am1tanaka:20190118113458p:plain
観測データをベクトルにするかどうかの違い

速度をベクトルで与えたところ、1万ステップの辺りでMean Reward1.000になることもありました。ベクトルデータはベクトルのまま渡した方がよさそうです。

まとめ

Unityの新規プロジェクトに学習用の環境を構築して、Pythonと連携した強化学習の実行、そして学習結果のモデルデータを利用してエージェントを動かすことができました。

0.5.0との目立った違いとしては以下が挙げられます。

  • ブレインがアセットになって、設定が楽になった
  • 学習の切り替えを、AcademyのControlチェックでできるのも楽
  • 報酬を設定するメソッドがSetRewardに変更になった

あとはおおよそそのままいけました。慣れれば導入はかなり簡単だと思います。楽しいAIライフを!

参考URL