2.1. ノートブック管理機能¶
Jupyter Notebook (以下Jupyter)を使用し、ブラウザ上でノートブックの管理、編集、実行を行うことができます。
2.1.1. ログイン画面¶
GridData Analytics Serverを起動後、http://<GridData Analytics ServerのIPアドレス>:8000/にアクセスします。
以下のログイン画面から、あらかじめ作成したユーザー名とパスワードでログインしてください。
GridData Analytics Serverの起動方法やユーザーの作成方法については、GridData Analytics 管理者ガイドを参照してください。
2.1.2. ダッシュボード画面¶
ログイン後、Jupyterのダッシュボード画面が表示されます。 この画面では、ノートブックやJupyterに関する管理や設定を行うことができます。
ダッシュボード画面では以下の機能を利用できます。なお、各機能の番号は画像内の番号に対応しています。
- Filesタブ
ファイル一覧(File Tree)を表示します。ログイン直後はこの画面が表示されます。
- Runningタブ
ユーザーが起動中のノートブックやターミナルのプロセスを管理できます。
- Clustersタブ
本製品では使用しません。
- Nbextensionsタブ
Jupyterの拡張機能の設定を変更できます。
- File Tree
ファイル一覧を表示します。ログイン直後はユーザーのホームディレクトリーを表示します。緑色のアイコンはノートブックが起動中であることを表します。
ノートブックファイルを選択すると、ノートブック編集画面が開きます。 ディレクトリーを選択すると、そのディレクトリー内のファイル一覧を表示します。
- Quit
Jupyterサーバーを停止します
- Logout
Jupyterからログアウトします。
- Control Panel
ユーザーのJupyterを停止することができます。
- リポジトリー操作ボタン表示エリア
リポジトリー管理機能を使用するためのボタンを表示します。詳しくは リポジトリー管理機能 を参照してください。
- Upload
クライアントのローカルにあるファイルをFile Treeにアップロードします。
- New
ノートブック、空のファイルやフォルダを新しく作成します。また、ターミナル画面やテキスト編集画面を開くこともできます。
新しいノートブックを作成する際は、そのノートブックで使用するカーネルを以下の一覧から選択します。カーネルとは、プログラミング言語ごとに用意されている実行環境です。
カーネル名 説明 PySpark_large PySpark用のカーネルです。潤沢にリソースがある環境を想定しSparkSessionの設定を行います。 PySpark_medium PySpark用のカーネルです。PySpark_largeとPySpark_smallの中間のリソース設定を行います。 PySpark_small PySpark用のカーネルです。最小限のリソース設定を行います。 Python3 Python3の実行カーネルです。 R Rの実行カーネルです。 Spark(Scala) Scalaの実行カーネルです。実行にはSparkの起動が必要となります。 PySparkカーネルの詳細は Sparkクラスター上で処理を実行する を参照してください。
また、カーネルを追加した場合はこの一覧に追加されます。カーネルの追加方法はGridData Analytics 管理者ガイドを参照してください。
- Refresh notebook list
File Treeを最新の状態に更新します。
2.1.3. ノートブック編集画面¶
ダッシュボード画面で既存のノートブックを選択、または新しいノートブックを作成すると、ノートブック編集画面が開きます。
ノートブック編集画面では、ノートブックを複数のセルと呼ばれる最小単位に分割することで、 セルごとにスクリプトの編集や実行、結果の表示や保存を行うことができます。 セルには主にプログラミング言語用のセル、Markdown記法のテキスト用のセル、 TeX記法のテキスト用のセルという3種類のセルがあり、それらを自由な順序で組み合わせることができます。
ノートブック上では、REPLのように実行したセルの処理結果はメモリ上に保持されます。 そのため、ノートブック内では宣言した変数や関数はセル間で共有されます。 変数や関数を宣言するセルを一度実行することで、その変数や関数を利用する他のセルを実行できるようになります。
また、起動中のノートブックでは、ノートブックごとにプログラミング言語用のカーネルと呼ばれるプロセスがひとつ常駐しており、 ノートブック編集画面にて、カーネルに対するプロセスの起動や停止、一時停止などの操作も行うことができます。
ノートブック編集画面では以下の機能を利用できます。なお、各機能の番号は画像内の番号に対応しています。
- ロゴ
- クリックするとダッシュボード画面に移動します。
- ノートブック名
- クリックすると名前を編集できます。
- メニューバー
- ノートブックの操作に関するプルダウンメニューです。詳細は後述します。
- ツールバー
- ノートブックの操作に関するツールチップ群です。詳細は後述します。
- ノートブック画面
- 各セルを表示します。マウスまたは矢印キーでセルを選択します。選択中のセルの左端にはバーが表示されます。
- Logout
- Jupyterからログアウトします。
- Control Panel
- ユーザーのJupyterを停止することができます。
- kernel indicator
- カーネル名やカーネルの状態を表示します。
メニューバー¶
メニューバーの項目について説明します。
各項目の内容は以下の通りです。
- File
ノートブックの新規作成やコピー、リネーム、エクスポートなどを行います。
- Edit
セルのカットやコピー、ペースト、分割などの編集を行います。
- View
ツールバーの表示の切り替えなど、ノートブック編集画面の表示に関する変更を行います。
- Insert
セルの挿入を行います。
- Cell
セルの実行、セルの実行形式の変更、出力結果の設定などを行います。
- Kernel
カーネルの設定や変更を行います。
- Widget
セルにウィジェット機能を追加します。
- Help
Jupyterや分析ライブラリーのヘルプを開きます。
- Diff
ノートブックの過去のチェックポイントとの差分を表示します。
チェックポイントについては、 リビジョン管理機能 を参照してください。
ツールバー¶
ツールバーの項目について説明します。
各項目の内容は以下の通りです。
- save and checkout
ノートブックを保存し、チェックポイントを作成します。
チェックポイントについては、 リビジョン管理機能 を参照してください。
- insert cell below
選択しているセルの下に、新しくセルを挿入します。
- cut selected cells
選択中のセルを削除します。
- copy selected cells
選択中のセルをコピーします。
- paste cells below
コピーしたセルを貼り付けます。
- move selected cells up
選択中のセルの位置を上のセルと入れ替えます。
- move selected cells down
選択中のセルの位置を下のセルと入れ替えます。
- run cell, select below
選択中のセルを実行し下のセルに移動します。
- interrupt kernel
カーネルを一時停止します。
- restart the kernel
カーネルを再起動します。
- restart the kernel,then re-run
カーネルを再起動したのち、ノートブックを実行します。
- プルダウン
セルの種別を選択します。スクリプトを記述する場合はCodeを、Markdown記法のテキストを記述する場合はMarkdownを選択します。
なお、使用できるMarkdown記法については Jupyterの公式ドキュメント を参照してください。
- open the command palette
ノートブック編集画面で実行できる操作の一覧とショートカットキーを表示します。
2.1.4. ターミナル画面¶
ダッシュボード画面の右上にある、NewボタンのメニューからTerminalを選択すると、以下のようなターミナル画面が開きます。
ターミナル画面では、一般的なターミナルと同様にコマンドを実行し、その結果を確認できます。 実行ユーザーはJupyterのログインユーザーで、ホームディレクトリーはログインユーザーのホームディレクトリーです。
左上のJupyterのロゴをクリックすると通常のダッシュボード画面に戻ります。
2.1.5. テキスト編集画面¶
ダッシュボード画面の右上にある、NewボタンのメニューからText Fileを選択すると、以下のようなテキスト編集画面が開きます。
メニューバーの項目について説明します。
- File
- テキストファイルの新規作成、保存、リネーム、ダウンロードを行います。
- Edit
- 文字の検索と置換、キーバインドの設定を行います。キーバインドはSublime Text、Vim、emacsから選択可能です。
- View
- ヘッダや行番号の表示を切り替えます。
- Language
- テキストの書式を選択することで、コマンドやキーワードのハイライトを行います。