01_FUN_AI_Docs.ipynb

{
 "cells": [
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# FUN AI 第1回 環境構築\n",
    "\n",
    "今回は、今後のサークルに必要な環境構築などを行う。PCの操作に不慣れな人は頑張って着いてきて欲しい。おそらく今後の学生生活で同じような作業をすることがあるからだ。慣れておくと楽だろう。"
   ]
  },
  {
   "cell_type": "markdown",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "# GitHub アカウントの作成\n",
    "\n",
    "### ※01_github.pdf にもほぼ同様の内容が書いてある。そちらを見た場合はこの章は飛ばしてもよい。\n",
    "\n",
    "GitHubとは、プログラムのバージョン管理システムを補助するシステムの1つだ。\n",
    "\n",
    "複数人で開発するときには必須と言ってもいいから、ここで導入を行う。ProcessingのソースなどもGitHubで管理すると何かと便利なことが多い。\n",
    "\n",
    "サークル資料も僕のGitHubに上がっているから、アカウントを作成したらダウンロードする。\n",
    "\n",
    "[公式サイト](https://github.com)にアクセスし、sign upする。とりあえずは学内メールで作るとよいだろう。(あとから複数のメールアドレス追加できる)\n",
    "\n",
    "![h300](./fig/01/01_01.png)\n",
    "\n",
    "ついでに sign in もしてしまおう。GitHubから来るメールを確認しverifyすること。\n",
    "\n",
    "次に[このサイト](https://qiita.com/toshi-click/items/dcf3dd48fdc74c91b409)を参考に、Gitをコマンドラインで使う準備をする。後ほど自分で書くかもしれない。\n",
    "\n",
    "それらが済んだら、僕のGitHubからサークルで使う資料を[ダウンロード](https://github.com/t4t5u0/2020_fun_ai_docs)する。\n",
    "\n",
    "![](./fig/01/01_03.png)\n",
    "\n",
    "リンクをコピーし、`git clone`する。\n",
    "\n",
    "`git clone` する際の例をあげる。まずはWindows powershell を立ち上げる。\n",
    "\n",
    "Windowsキー(スタートキー)を押し、アプリを検索できる状態にし、powershell などと打つと良い\n",
    "\n",
    "`cd`コマンドはchange directry の略で、ディレクトリ(フォルダ)を移動できる。`~/`はホームディレクトリを表す。\n",
    "\n",
    "```Console\n",
    "$ cd ~/\n",
    "$ cd Documents\n",
    "$ git clone https://github.com/t4t5u0/2020_fun_ai_docs.git \n",
    "$ cd 2020_fun_ai_docs\n",
    "$ git branch -a\n",
    "$ git checkout dev\n",
    "```\n",
    "\n",
    "更新したい場合は\n",
    "```Console\n",
    "$ cd 2020_fun_ai_docs\n",
    "$ git pull\n",
    "```"
   ]
  },
  {
   "cell_type": "markdown",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "# Python(Anconda)の環境構築\n",
    "\n",
    "注意！すでに環境構築されていて、自分の環境を汚したくない場合は、いい感じにやってください\n",
    "\n",
    "## Anacondaのインストール\n",
    "Anacondaとは機械学習やデータサイエンスのためのPythonディストリビューションだ。様々なライブラリがデフォルトでインストールされていたり、複数の環境を用意できたりする。特に、複数の環境を用意できる点が嬉しく、プロジェクトごとに言語やライブラリのバージョンを管理できる。複数のプロジェクトを同時に行うとき、別々の環境が欲しいことが多い。そのために、`conda` というコマンド群を使って、環境を複数用意する。\n",
    "\n",
    "それでは、環境を作って行く。\n",
    "まずは[公式サイト](https://www.anaconda.com/distribution/#download-section)からダウンロードする。Python3.7 を選択すること。\n",
    "\n",
    "![](./fig/01/01_02.png)\n",
    "\n",
    "途中で一個チェックを入れる。他は特にこだわりが無ければ、そのまま進めて良い。\n",
    "\n",
    "![](./fig/01/01_09.png)"
   ]
  },
  {
   "cell_type": "markdown",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "## VSCode のインストール\n",
    "[公式サイト]()からWindows 64bit 版をダウンロードする。ダウンロードしたらとりあえず起動してみる。  \n",
    "\n",
    "VSCodeは拡張機能が豊富で色々なものがある。\n",
    "\n",
    "必須・おすすめのエクステンション(拡張機能)\n",
    "- Python  \n",
    "    - (必須)VSCode上でPythonを使うための必要\n",
    "- Japanese Language\n",
    "    - VSCodeを日本語化する\n",
    "- Visual Studio Intelisince\n",
    "    - コード補完を強力にする\n",
    "- zenkaku\n",
    "    - 全角スペースを強調してくれる\n",
    "\n",
    "インストールについては下図参照。検索窓に入れたい拡張機能の名前を入れる\n",
    "\n",
    "![](./fig/01/01_04.png)\n",
    "\n",
    "僕の環境では既にインストールしているため、インストールボタンは表示されていないが、皆さんは表示されていることと思う。\n",
    "![](./fig/01/01_05.png)\n",
    "\n",
    "\n",
    "他にも色々な拡張機能があるから、こういった[記事](https://qiita.com/sensuikan1973/items/74cf5383c02dbcd82234)を参考にぜひ自分好みのVSCodeを作って欲しい。"
   ]
  },
  {
   "cell_type": "markdown",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "Anaconda powershell を起動して、以下のコマンドを打つ。これで、`circle`という名前のconda環境が作られた。今後、特にこだわりが無ければ、`circle`環境を使うことを推奨する。\n",
    "\n",
    "```\n",
    "$ conda acivate circle\n",
    "(circle)$ \n",
    "```\n",
    "\n",
    "(circle)とでたら成功"
   ]
  },
  {
   "cell_type": "markdown",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "## VSCode で jupyter notebook を使う方法\n",
    "\n",
    "VSCodeでjupyter notebook を使うこともできる。VSCodeの拡張機能でPythonを有効にする\n",
    "\n",
    "次は、VSCodeで用いるPythonのバージョンを選択する`Ctrl+Shift+p`を押し、\n",
    "```\n",
    "Python：select interpreter\n",
    ">Python 3.7.4 64-bit ('base':conda)\n",
    "```\n",
    "を選択  \n",
    "左下にPython 3.7.4 64-bit ('base':conda) と表示されていれば良い\n",
    "\n",
    "新しいウィンドウを開く。(`Ctrl+Shift+n`) その後、フォルダを開く(`Ctrl+k Ctrl+o`) から先程`git clone`した `2020_fun_ai_docs`を選択する\n",
    "\n",
    "VSCode左のエクスプローラーから`01_FUN_AI_Docs.ipynb` を開く\n",
    "\n",
    "VSCodeのリボンからターミナル(T)→新しいターミナル。もしくは ``Ctrl+Shift+` `` を打つ。(バッククォート(`)は\n",
    "JISキーボードだとShift+＠)\n",
    "\n",
    "```Console\n",
    "$ conda create -n circle\n",
    "$ conda activate circle\n",
    "```\n",
    "\n",
    "---\n",
    "\n",
    "右上の`jupyter server: `の欄がNot Started になっていた場合は以下の作業を行う。\n",
    "```\n",
    "(circle) $ jupyter notebook --no-browser --port=8888\n",
    "\n",
    "[I 13:35:47.749 NotebookApp] JupyterLab extension loaded from C:\\Users\\t4t5u0\\Anaconda3\\lib\\site-packages\\jupyterlab\n",
    "[I 13:35:47.749 NotebookApp] JupyterLab application directory is C:\\Users\\t4t5u0\\Anaconda3\\share\\jupyter\\lab\n",
    "[I 13:35:47.749 NotebookApp] Serving notebooks from local directory: C:\\Users\\t4t5u0\\Documents\\2020_fun_ai_docs\n",
    "[I 13:35:47.749 NotebookApp] The Jupyter Notebook is running at:\n",
    "[I 13:35:47.749 NotebookApp] http://localhost:8888/?token=hogehoge\n",
    "[I 13:35:47.749 NotebookApp] Use Control-C to stop this server and shut down all kernels (twice to skip confirmation).\n",
    "[C 13:35:47.812 NotebookApp]\n",
    "\n",
    "    To access the notebook, open this file in a browser:\n",
    "        file:///C:/Users/t4t5u0/AppData/Roaming/jupyter/runtime/nbserver-14124-open.html\n",
    "    Or copy and paste one of these URLs:\n",
    "        http://localhost:8888/?token=hogehoge\n",
    "```\n",
    "\n",
    "\n",
    "VSCode上で`Ctrl-Shift-p`と入力するとポップアップが出る。そこで以下のように入力する。\n",
    "\n",
    "\n",
    "```Console\n",
    ">Python: Specify local or remote Jupyter server for connections\n",
    "\n",
    "Existing\n",
    "\n",
    "http://localhost:8888/?token=hogehoge\n",
    "```\n",
    "\n",
    "右上にJupyter Server: http://localhost:8888/?token=hogehoge と表示されていればよい。これでVSCode上でjupyter notebookを実行する手順が整った。\n"
   ]
  },
  {
   "cell_type": "markdown",
   "execution_count": null,
   "metadata": {},
   "outputs": [],
   "source": [
    "## PyTorchのインストール\n",
    "\n",
    "PyTorchとは、深層学習用のPythonフレームワークだ。FUN AI では、PyTorchを使って演習を進めていく。詳しい使い方などは次回以降に解説していく。\n",
    "[公式サイト](https://pytorch.org)にアクセスして、欲しいバージョンや環境をクリックするとリンクを生成してくれる。Windows用のものは以下に用意した。他のOSも同じようにダウンロードできる。\n",
    "\n",
    "先程同様にVSCode内でターミナルを開く。(``Ctrl+Shift+` ``) その後、以下のコマンドを打つ\n",
    "```Console\n",
    "$ conda activate cirle\n",
    "$ conda install pytorch torchvision cudatoolkit=10.1 -c pytorch\n",
    "```"
   ]
  },
  {
   "cell_type": "markdown",
   "metadata": {},
   "source": [
    "# 附録\n",
    "## ブラウザで jupyter notebook を開く方法。\n",
    "### jupyter server を起動している場合\n",
    "ブラウザの検索欄に、http://localhost:8888 と入力する。\n",
    "\n",
    "### jupyter server を起動していない場合\n",
    "condaが使えるターミナルを開き、\n",
    "```Console\n",
    "$ conda activate circle\n",
    "$ jupyter notebook\n",
    "```\n",
    "と入力する。そうするとブラウザから起動する。\n",
    "\n",
    "## Google Colaboratory から開く方法\n",
    "Google Colabratory(Colab)とは、Googleのサービスの1つで、Web上でnotebook形式のPythonを走らせることができる。\n",
    "\n",
    "深層学習の学習に必要なGPUを無料で使うことができたり、頼ることもあるだろう。\n",
    "\n",
    "[Google Colaboratory](https://colab.research.google.com/notebooks/intro.ipynb?hl=ja#recent=true)にアクセスし、GitHubのリポジトリをマウント方法を説明する。clone するときと同じリンクを貼り付けると、以下のように選択できる。\n",
    "\n",
    "![](./fig/01/01_06.png)\n",
    "\n",
    "GPUを使いたいときは、ランタイム → ランタイムタイプの変更 → GPU を選択するとGPUを使用することができる。\n",
    "\n",
    "![](./fig/01/01_07.png)\n",
    "![](./fig/01/01_08.png)\n",
    "\n",
    "ただし、無料版を使用している場合は、GPUを連続で12時間までしか使うことができないから注意すること。学習したパラメータを保存しておかないと学習した結果が無駄になってしまう。パラメータを保存する方法は、次回以降に説明する。"
   ]
  }
 ],
 "metadata": {
  "kernelspec": {
   "display_name": "Python 3.7.3 64-bit ('base': conda)",
   "language": "python",
   "name": "python37364bitbaseconda429541fdaed24deaa7378a94fef3496a"
  },
  "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.7.3-final"
  }
 },
 "nbformat": 4,
 "nbformat_minor": 2
}