WSL2でcmdstanrを動かす環境を整備しよう

この記事はStan Advent Calendar 2020の15日目の記事です。

さて、このネタも若干使い古されたというか、同様の記事はすでにたくさんあります。北條さんの記事、うちの院生の柏原さんの記事、この記事などなど。

rstanパッケージが、どうもR4.0になってからイマイチうまく動かない事例が増えています。WindowsでもMacでも。僕はWinしか使わないのでそれ限定の話を書きますが、とりえあずRtoolsとの連携がうまくいかないなど、コンパイル環境でコケることが多いです。

またrstan側の問題で動かないこともあります。最近rstanがいろいろ機能が増えてきたのも合って、パッケージの依存関係で動かなかったり。あるいは、動くんだけど、cmdstanのバージョンアップに全然追いついてなくて、最新機能をrstanで使えなかったり。

※ついでにcmdstanというのは、cmdで動かせる、最も基本的なStanのプログラムのことです。rstanのコアですね。これがまず開発され、それに合わせて他のrstanやpystanなどが開発されていきます。

そういうのもあって、今から書くcmdstanrをWSL２で動かしたUbuntu上のRstudio Serverで走らせる、というところにメリットがでてきます。

cmdstanrをWSL２で動かしたUbuntu上のRstudio Serverで走らせるメリット

ちょっと専門用語が多いかもなので、順番に説明しましょう。

まず、cmdstanrについて。これは、rstanのようにRのパッケージの一つです。rstanとは別に、Stanを動かすことができるパッケージなんです。なぜそれが生まれたかといえば、上述のrstanの依存パッケージが増えたことの問題と、cmdstanのバージョンアップについていけなくなったことの問題があります。

そこでcmdstanをR上で動かすだけ、という非常にシンプルなパッケージが登場しました。cmdstanrは、cmdstanを別にインストールする形式を取るので、cmdstanがバージョンアップしたら、それに合わせて変更することができます。つまり、パッケージのバージョンアップをせずとも最新のStanを使うことができるのです。また、コンパイルにRcppを使わないので（内部で直接C＋＋を動かしている）、rstanよりコンパイルが早いです。これも結構重要なメリットです。

次にWSL２について。WSLとはWindows Subsystem for Linuxの略で、Windows上でLinuxを動かすことができるシステムです。Linuxは、WindowsやMacとはまた違うOSのことで、オープンでフリーなOSです。いつでも誰でも使えます。WSLで動かせるLinuxのディストリビューションとしてUbuntuがあります（ややこしいのでLinuxと一緒と思えばいいです）。

さて、WSL２はWSLをさらにパワーアップさせたやつで、よりUbuntuとWindowsの連携を良くしてくれるやつです。WSL2を使ってなぜUbuntuを動かしたいかといえば、今から述べるように、Windowsよりもいろいろ安定しているからです。

まず、Ubuntuは商用のOSではないのでバージョンアップはWinほど頻繁に行われず、またどのバージョンでも好きな物を選んでインストールできます。また、Stanを動かすという意味で重要なのは、Ubuntuにははじめからコンパイラがはいっているので、StanコードのコンパイルにRtoolsを使いません。よって、コンパイル環境でコケる心配があまりありません。

もちろん、はじめからUbuntsを使って分析すればいいんですが、僕のようにWindowsしか使わない人のために、Windows上で、Ubuntuをあたかもアプリのように動かしてRを使いたいとき、WSLが活きてくるわけです。

そして、Ubuntuで起動したRstudioをWindowsから操作するために、Rstudio Serverが必要になります。でもこれは、Ubuntuにいれるだけですから、それほど大きな問題ではありません。強いて言えば、ブラウザ上で動かすことになるのでそのあたりに慣れがいるかもしれません。

あとUbuntu上で動くRstudio Serverはとても動作が安定しています。これはなぜなのかはわかりませんし、直感的なものも含まれていますが、僕的にかなり重要な点です。具体的に言えば、rstanで複雑なモデルを推定してlooパッケージのwaic関数を使うと高確率で爆発（Rstudioが落ちる）します。なので、わざわざ自作のWAIC計算用関数を使ったりするんですが、推定終わった直後に爆発する絶望感はすごいです。あと、変分ベイズ推論のvbを使っていても安定感が違います。vbは推定を途中で止めようと思っても内部の計算がrcppを使っているせいか、なかなか止まってくれません。無理に止めようとすると爆発します。しかし、cmdstanrはすぐ止まります。すごい。あと、単純にUbuntuのほうがWindowsよりも推定が早いです。

もう一つ、Windowsだと並列演算をしたときビューアーの更新をしないとMCMCの進捗がわかりませんが、Ubuntuだと勝手に進捗を教えてくれます。これも便利。

メリットをまとめますと、

• cmdstanrを使うと、cmdstanの最新バージョンがいつでも使える
• コンパイルが早い
• コンパイル環境でコケることがない
• 推定が早い
• Rstudioの挙動が安定する

などなど、いいことばかりです。

cmdstanrをWSL２で動かしたUbuntu上のRstudio Serverで走らせる環境を作ろう

さて、それでは環境の構築方法ですが、まずはWSL2が動く環境である必要があります。それについてはこの記事を見てください。この記事に書かれている通りに操作すれば、WindowsでWSL2上でUbuntuを起動するところまではいけるはずです。

まずはUbuntu20.04を起動します。そしたらユーザーネームとパスワードの設定が求められます。適当なものを設定しておきますが、この2つはあとで使うので、メモっておきましょう。

さて、ここから以下のコードをUbuntuで走らせてください。コードをコピーして、Ubuntuのコンソール上で右クリックすれば貼り付けられます。

以下のコードでアップデートしておきます。最初のコードを走らせるとパスワードが聞かれます。これはsudoという管理者権限でのコマンド実行をしているためです。最初に設定したパスワードを入力します（打っても何も入力されてない感じですが、大丈夫です、入力されてます）。

続いて、Ubuntuのライブラリをインストールします。これはdevtools、rstanやtidyverseを動かすのにいりますので、走らせておきましょう。

次にRをUbuntuにインストールします。以下、呪文だと思って黙々と走らせていきましょう。まずはインストールの準備。

続いて、R4.0をインストール。1行目の実行でエラーがでますが、それはパッケージをインストールする先のリポジトリが古いやつなので出るエラーらしく、Rをインストールするだけなら問題ないようです。
2行目を走らせるとRのインストールが始まります。そこそこ時間がかかります。

次に、Rstudio Serverのインストール。これもそこそこかかります。

次にRstudio Serverを起動します。

この時点では、何も起きません。しかし、Ubuntuの内部ではちゃんと起動できています。Ubuntu上のRstudio Serverにアクセスするためには、ブラウザからアクセスする必要があります。

適当なブラウザで、アドレスバーにlocalhost:8787と入力してエンターを押すと、RstudioServerに繋がります。ここでユーザーIDとパスが求められますが、Ubuntuを初めて起動したときに求められたIDとパスワードをここで入力します。そうすると、見慣れたRstudioの画面が表示されるはずです。

これはRを入れたばかりの状態ですので、いくつかパッケージを入れておく必要があります。cmdstanrを入れるためには、まずdetoolsパッケージを入れます。そして、devtoolsのinstall_github関数を使って、cmdstanrパッケージを入れます。cmdstanrを入れたら、次にcmdstanをインストールします。それぞれ、そこそこ時間かかります。このあたりでコーヒーを入れてもいいと思います。

ここで、うまくパッケージが入らないことがあります。エラーメッセージを見て、コケてるパッケージをダイレクトにいれてからもう一度走らせてみてください。結構心が折れそうになりますが、一つずつ確実に入れていけばいずれ全部入ります。

あと、cmdstanrの結果を見やすくするために、rstanパッケージも必要になりますので、入れておきましょう。

なお、Rstudio-Serverを終了したいときは、

とUbuntuに入力しましょう。

cmdstanrを走らせよう

cmdstanrは、rstanと走らせ方も引数も違うので、注意が必要です。

まずはどうでもいいStanコードを書いたStanファイルを保存します。prob.stanとします。

次に、モデルのコンパイルなのですが、Stanファイルのフルパスがいります。僕は面倒なので、getwd()でワーキングディレクトリのアドレスを取得します。あとはプロジェクト内のStanファイルの相対パスをつなげればOKです。具体的には、次のような感じです。

あと、データリストも用意しておきます。これはrstanと同じです。適当なデータを乱数で作ります。

さて、さっそくcmdstanrを走らせましょう。コードはrstanと少し違い、コンパイルしたモデルのオブジェクト内のsample関数を実行するという形を取ります。オブジェクト指向っぽい。

注意が必要なのは、iter_warmupがウォームアップ数、iter_samplingはウォームアップしたあとのMCMCサンプル数である点です。rstanのようにウォームアップとサンプルの合計を指定するわけではないので気をつけてください。

これで無事にcmdstanrが走ったと思います。

次に、結果を見たいときですが、rstanのread_stan_csv()を使います。そこに、fit_cの内部にある、output_files()を指定することで、cmdstanrの出力をrstan風に変えてくれます。次のコードをまるまる使えばOKです。

すると

上のような出力が得られます。

基本的には、cmdstanrのドキュメントを見れば、使い方は書いてますので、そちらを見ていれば大体わかります。

WSL2からWindows上のプロジェクトにアクセスする方法

さて、Rstudio-Serverを使って分析ができたわけですが、Ubuntu上のRstudioなわけなので、ワーキングディレクトリはhome/ユーザー名という謎な空間がデフォルトとなっています。一見、Windows上のファイルにアクセスできないように見えます。

それもWSLなら問題なくアクセスできます。Rsutdio ServerのFilesから、Open Projectを選びます。そして、エクスプローラではなく、File name:のところに、/mnt/c/users/[Windowsでのユーザー名]/と入力してみましょう。たとえばWindowsのユーザー名がnorimuneならば、/mnt/c/users/norimune　と入力します。そうすれば、Windows上のファイルが見れるようになるはずです。あとは、Rstudioのプロジェクトがあるディレクトリまで進んでいって、Rprojファイルを起動すれば、いつものプロジェクトが開けます。もちろん、Cドライブのルートにおいてるなら、/mnt/cと入力したらOKです。

せっかくなのでRstudio-Server専用のブラウザを用意してみる

僕はもはやデスクトップ版Rstudioは使っておらず、WSL2上のRstudio-ServerでしかRを動かしていません。そうすると、普段使ってるブラウザで動かしているといろいろ不満がでてきます。

まず、タブが多くなるとうざい、ブックマークとかあるとRstudioの画面が小さくなってうざい、なんとなくブラウザと分析は分けたい、などなど。

そこで、普段はChromeをブラウザにしている僕は、Firefoxをいれて、それをRstudio専用にしています。しかも、わざわざショートカットの画像もRstudioにしました。これで「分析するぞ！」っていう気分になります。なるんです。

ホームページもlocalhost:8787に設定し、タブバーもメニューバーもアドレスバーも消しました。

現状、下のような感じです。

これでほぼ、デスクトップ版Rstudioと変わらない使い勝手になりました。

というわけで、みなさんもWSL2でcmdstanr生活やってみてください。