{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {
    "colab_type": "text",
    "id": "tcLyUtUqhkTr"
   },
   "source": [
    "# 5-OpenJij GPU"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "colab_type": "text",
    "id": "view-in-github"
   },
   "source": [
    "[![Open in Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/OpenJij/OpenJijTutorial/blob/master/source/ja/005-OpenJijGPU.ipynb)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "> (追記: 2021/05)このセクションは2021/05 現在、サポートされていません。次の章へ進むことをおすすめします。"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "colab_type": "text",
    "id": "Vrd0CwLJhvVQ"
   },
   "source": [
    "このセクションではGPUを用いてSimulated Quantum Annealing(SQA)を行う方法をご紹介します。\n",
    "\n",
    "## Google Colabでの設定とインストール\n",
    "\n",
    "一般のPCにはCUDA環境が整っていない、もしくはCUDAに対応するNVIDIAのGPUが搭載されていないこともあります。しかし**Google colaboratory**を使えば誰でもGPGPUを使うことができます。\n",
    "\n",
    "### GPU設定\n",
    "\n",
    "GPU実行したいJupyter NotebookをGoogle Colabで開きます。  \n",
    "\n",
    "```\n",
    "ランタイム > ランタイムのタイプを変更 > ハードウェアアクセラレータをGPUに選択\n",
    "```\n",
    "\n",
    "この設定を行うことでGPUを用いたJupyter Notebookの実行が可能となります。\n",
    "\n",
    "### OpenJijのインストール\n",
    "\n",
    "OpenJijからGPUを用いたモジュールを呼び出すためには、まずpipからのインストールの際にOpenJijをソースコードからビルドする必要があります。\n",
    "この操作のためにCMakeと呼ばれるツールが必要ですが、Google ColabにプリインストールされているCMakeは古いバージョンです。まずはそれをバージョンアップしましょう。"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {
    "colab": {
     "base_uri": "https://localhost:8080/",
     "height": 173
    },
    "colab_type": "code",
    "id": "o8UaiBs1hkwh",
    "outputId": "3a0075b7-00ea-4cad-9ff1-47b0965e833f"
   },
   "outputs": [],
   "source": [
    "!pip install -U cmake"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "colab_type": "text",
    "id": "-DuFQsPK90LI"
   },
   "source": [
    "その後、OpenJijをインストールし直します。一度アンインストールしてから、ソースコードからビルドするオプションである `--no-binary :all:`をpipに付け加えてインストールします。\n",
    "インストールにはしばらく時間がかかります。\n",
    "> 通常pipは一度インストールしたことのあるアプリケーションであればキャッシュからデータを取ってきてしまうので、それも無効化する `--no--cache-dir`もつけます。初めてOpenJijをインストールする際にはこのオプションは不要です。"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {
    "colab": {
     "base_uri": "https://localhost:8080/",
     "height": 377
    },
    "colab_type": "code",
    "id": "s1pjFhAa95Zs",
    "outputId": "e398ccc6-abca-420b-8e9b-0626ab3283bc"
   },
   "outputs": [],
   "source": [
    "!pip uninstall openjij -y\n",
    "!pip install openjij --no-binary :all: --no-cache-dir"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "colab_type": "text",
    "id": "JMgqfmZ-h8X3"
   },
   "source": [
    "## GPUSQA計算\n",
    "\n",
    "OpenJijのGPUでサポートしているのはキメラグラフ上でのモンテカルロ計算です。  \n",
    "まずは GPUSQASampler のインスタンスを作ります。\n",
    "もし、GPU関連のモジュールが見つからないとエラーが出た際には、以前のバージョンが読み込まれている可能性があるので、一度再起動するといいかもしれません。"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 1,
   "metadata": {
    "colab": {},
    "colab_type": "code",
    "id": "TYhWp0eqh3Yb"
   },
   "outputs": [],
   "source": [
    "import openjij as oj\n",
    "\n",
    "sampler = oj.GPUChimeraSQASampler(num_reads=100, unit_num_L=2)"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "colab_type": "text",
    "id": "oOmEWWBxh_3O"
   },
   "source": [
    "ここで `unit_num_L` はキメラユニットセルが並ぶ2次元格子の1辺の長さを指定します。  \n",
    "上の例では 2×2=4つのキメラユニットセルが並んでいる系を作成しています。キメラユニットセルは8bitで1つを構成しているため、総ビット数は\n",
    "  \n",
    "${\\rm total\\_num} = {\\rm unit\\_num\\_L}^2 \\times 8$\n",
    "\n",
    "のように計算されます。\n",
    "\n",
    "GPUSQASamplerでは、のちに sample_qubo などで少ない変数を指定しても、ここで作ったキメラグラフの系のサイズだけSQA計算を行います。  \n",
    "`unit_num_L`は無駄に大きすぎないように注意しましょう。また`unit_num_L`はコンストラクタで指定しなくても、`sample_qubo`を実行するときの引数としても指定できます。\n",
    "\n",
    "## 実行\n",
    "\n",
    "ではSQAを実行してみましょう。これまで紹介してきたSamplerと同様に、sample_qubo (or sample_ising) で計算を行うことができます。\n",
    "ただし、キメラグラフを満たさない添字の相互作用を指定するとエラーになります。"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 2,
   "metadata": {
    "colab": {
     "base_uri": "https://localhost:8080/",
     "height": 1000
    },
    "colab_type": "code",
    "id": "_XIsZ9z2h_Rv",
    "outputId": "be24e99d-b0b9-4766-c686-815ca027694c"
   },
   "outputs": [
    {
     "data": {
      "text/plain": [
       "Response(rec.array([([1, 1, 1, 0], -2., 1), ([1, 1, 1, 0], -2., 1),\n",
       "           ([1, 1, 1, 0], -2., 1), ([1, 1, 1, 0], -2., 1),\n",
       "           ([1, 1, 1, 0], -2., 1), ([1, 1, 1, 0], -2., 1),\n",
       "           ([1, 1, 1, 0], -2., 1), ([1, 1, 1, 0], -2., 1),\n",
       "           ([1, 1, 1, 0], -2., 1), ([1, 1, 1, 0], -2., 1),\n",
       "           ([1, 1, 1, 0], -2., 1), ([1, 1, 1, 0], -2., 1),\n",
       "           ([1, 1, 1, 0], -2., 1), ([1, 1, 1, 0], -2., 1),\n",
       "           ([1, 1, 1, 0], -2., 1), ([1, 1, 1, 0], -2., 1),\n",
       "           ([1, 1, 1, 0], -2., 1), ([1, 1, 1, 0], -2., 1),\n",
       "           ([1, 1, 1, 0], -2., 1), ([1, 1, 1, 0], -2., 1),\n",
       "           ([1, 1, 1, 0], -2., 1), ([1, 1, 1, 0], -2., 1),\n",
       "           ([1, 1, 1, 0], -2., 1), ([1, 1, 1, 0], -2., 1),\n",
       "           ([1, 1, 1, 0], -2., 1), ([1, 1, 1, 0], -2., 1),\n",
       "           ([1, 1, 1, 0], -2., 1), ([1, 1, 1, 0], -2., 1),\n",
       "           ([1, 1, 1, 0], -2., 1), ([1, 1, 1, 0], -2., 1),\n",
       "           ([1, 1, 1, 0], -2., 1), ([1, 1, 1, 0], -2., 1),\n",
       "           ([1, 1, 1, 0], -2., 1), ([1, 1, 1, 0], -2., 1),\n",
       "           ([1, 1, 1, 0], -2., 1), ([1, 1, 1, 0], -2., 1),\n",
       "           ([1, 1, 1, 0], -2., 1), ([1, 1, 1, 0], -2., 1),\n",
       "           ([1, 1, 1, 0], -2., 1), ([1, 1, 1, 0], -2., 1),\n",
       "           ([1, 1, 1, 0], -2., 1), ([1, 1, 1, 0], -2., 1),\n",
       "           ([1, 1, 1, 0], -2., 1), ([1, 1, 1, 0], -2., 1),\n",
       "           ([1, 1, 1, 0], -2., 1), ([1, 1, 1, 0], -2., 1),\n",
       "           ([1, 1, 1, 0], -2., 1), ([1, 1, 1, 0], -2., 1),\n",
       "           ([1, 1, 1, 0], -2., 1), ([1, 1, 1, 0], -2., 1),\n",
       "           ([1, 1, 1, 0], -2., 1), ([1, 1, 1, 0], -2., 1),\n",
       "           ([1, 1, 1, 0], -2., 1), ([1, 1, 1, 0], -2., 1),\n",
       "           ([1, 1, 1, 0], -2., 1), ([1, 1, 1, 0], -2., 1),\n",
       "           ([1, 1, 1, 0], -2., 1), ([1, 1, 1, 0], -2., 1),\n",
       "           ([1, 1, 1, 0], -2., 1), ([1, 1, 1, 0], -2., 1),\n",
       "           ([1, 1, 1, 0], -2., 1), ([1, 1, 1, 0], -2., 1),\n",
       "           ([1, 1, 1, 0], -2., 1), ([1, 1, 1, 0], -2., 1),\n",
       "           ([1, 1, 1, 0], -2., 1), ([1, 1, 1, 0], -2., 1),\n",
       "           ([1, 1, 1, 0], -2., 1), ([1, 1, 1, 0], -2., 1),\n",
       "           ([1, 1, 1, 0], -2., 1), ([1, 1, 1, 0], -2., 1),\n",
       "           ([1, 1, 1, 0], -2., 1), ([1, 1, 1, 0], -2., 1),\n",
       "           ([1, 1, 1, 0], -2., 1), ([1, 1, 1, 0], -2., 1),\n",
       "           ([1, 1, 1, 0], -2., 1), ([1, 1, 1, 0], -2., 1),\n",
       "           ([1, 1, 1, 0], -2., 1), ([1, 1, 1, 0], -2., 1),\n",
       "           ([1, 1, 1, 0], -2., 1), ([1, 1, 1, 0], -2., 1),\n",
       "           ([1, 1, 1, 0], -2., 1), ([1, 1, 1, 0], -2., 1),\n",
       "           ([1, 1, 1, 0], -2., 1), ([1, 1, 1, 0], -2., 1),\n",
       "           ([1, 1, 1, 0], -2., 1), ([1, 1, 1, 0], -2., 1),\n",
       "           ([1, 1, 1, 0], -2., 1), ([1, 1, 1, 0], -2., 1),\n",
       "           ([1, 1, 1, 0], -2., 1), ([1, 1, 1, 0], -2., 1),\n",
       "           ([1, 1, 1, 0], -2., 1), ([1, 1, 1, 0], -2., 1),\n",
       "           ([1, 1, 1, 0], -2., 1), ([1, 1, 1, 0], -2., 1),\n",
       "           ([1, 1, 1, 0], -2., 1), ([1, 1, 1, 0], -2., 1),\n",
       "           ([1, 1, 1, 0], -2., 1), ([1, 1, 1, 0], -2., 1),\n",
       "           ([1, 1, 1, 0], -2., 1), ([1, 1, 1, 0], -2., 1)],\n",
       "          dtype=[('sample', 'i1', (4,)), ('energy', '<f8'), ('num_occurrences', '<i8')]), [0, 4, 5, 12], {'system': [], 'sampling_time': 689034.2819970101, 'execution_time': 5976.18150019116, 'list_exec_times': array([76328.54099938,  7530.31800195,  7715.94400067,  7510.68699901,\n",
       "        7787.2940019 ,  7512.42399929,  7352.67699929,  7332.60900233,\n",
       "        7284.00799926,  7312.71800032,  7284.09800286,  7233.33899805,\n",
       "        6989.54900145,  6796.05900223,  6726.42200152,  6837.33000187,\n",
       "        6793.93099927,  6824.61099859,  6693.40600143,  6772.17100019,\n",
       "        6788.3619995 ,  6788.34800055,  6761.98400106,  6818.01799874,\n",
       "        6860.50599688,  6735.12700087,  6726.58600161,  6680.12800088,\n",
       "        6669.64500124,  6631.90600244,  6647.62699671,  6668.59500052,\n",
       "        6733.77299972,  6725.34799742,  6780.18899998,  6743.88599873,\n",
       "        6646.95599698,  6676.33299963,  6360.07000139,  4574.99900222,\n",
       "        4392.35500016,  4334.32299906,  4210.20800059,  4228.12000033,\n",
       "        4252.30999826,  4257.1069971 ,  4158.3150014 ,  4189.84000135,\n",
       "        4206.58399889,  4182.14999809,  4202.39699815,  4218.48000042,\n",
       "        4165.10200012,  4231.43999797,  4240.46400076,  4241.20000025,\n",
       "        4202.66500078,  4199.92800016,  4168.96200113,  4213.14699997,\n",
       "        4235.60900163,  4205.72599978,  4233.40400084,  4227.56999978,\n",
       "        4187.44800118,  4163.88200028,  4231.00700209,  4187.86500086,\n",
       "        4188.6709987 ,  4152.51400045,  4202.75400029,  4194.30900001,\n",
       "        4198.0720016 ,  4240.42300074,  4285.01699935,  4305.28099969,\n",
       "        4215.97699824,  4225.1800005 ,  4163.24800244,  4252.90499697,\n",
       "        4178.68700242,  4195.24300014,  4241.57200177,  4212.6690023 ,\n",
       "        4228.39599923,  4194.24500069,  4215.65000215,  4240.26400287,\n",
       "        4252.68699837,  4220.24699947,  4185.00500018,  4219.33899997,\n",
       "        4194.66599851,  4208.64400076,  4177.97600312,  4194.74700175,\n",
       "        4173.36499959,  4242.68899951,  4194.9890001 ,  4218.5889979 ]), 'schedule': {'beta': 10.0, 'gamma': 1, 'num_sweeps': 100}}, 'BINARY')"
      ]
     },
     "execution_count": 2,
     "metadata": {},
     "output_type": "execute_result"
    }
   ],
   "source": [
    "Q = {(0, 4): -1, (0, 5): -1, (4, 12): 1}\n",
    "response = sampler.sample_qubo(Q)\n",
    "response"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "colab_type": "text",
    "id": "BIXHyB7--qB8"
   },
   "source": [
    "## 全結合模型のキメラグラフへの埋め込み\n",
    "\n",
    "これまで説明したものは、相互作用がキメラグラフ上に存在するもののみの計算でした。以下では全結合の問題のように、相互作用が複雑なものをキメラグラフに埋め込む場合のスクリプトをご紹介します。  \n",
    "キメラグラフへの埋め込みを行うために、`dwave`の`EmbeddingComposite`を併用しましょう。`pip`を用いて`dwave-system`をインストールします。"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": null,
   "metadata": {
    "colab": {
     "base_uri": "https://localhost:8080/",
     "height": 803
    },
    "colab_type": "code",
    "id": "WcP7nmD2--si",
    "outputId": "a769f387-5ed8-4a91-9115-aa5b82bc6bb7"
   },
   "outputs": [],
   "source": [
    "!pip install dwave-system"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {
    "colab_type": "text",
    "id": "u9Xzb7BHBG1n"
   },
   "source": [
    "そしてsampler部分のスクリプトを以下のように書き換えます。"
   ]
  },
  {
   "cell_type": "code",
   "execution_count": 15,
   "metadata": {
    "colab": {},
    "colab_type": "code",
    "id": "Ry1nTJGU-vnI"
   },
   "outputs": [],
   "source": [
    "from dwave.system.composites import EmbeddingComposite\n",
    "\n",
    "gpusqa = oj.GPUSQASampler(num_reads=100, unit_num_L=2)\n",
    "sampler = EmbeddingComposite(gpusqa)"
   ]
  }
 ],
 "metadata": {
  "accelerator": "GPU",
  "colab": {
   "name": "5-OpenJijGPU.ipynb",
   "provenance": []
  },
  "kernelspec": {
   "display_name": "Python 3",
   "language": "python",
   "name": "python3"
  },
  "language_info": {
   "codemirror_mode": {
    "name": "ipython",
    "version": 3
   },
   "file_extension": ".py",
   "mimetype": "text/x-python",
   "name": "python",
   "nbconvert_exporter": "python",
   "pygments_lexer": "ipython3",
   "version": "3.9.3"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 1
}