ノートブックの形式を管理する

この記事では、 Databricksの既定のノートブック形式、ノートブック形式を変更する方法、およびノートブックがソース制御フォルダーにある場合にコミットを管理する方法について説明します。

デフォルトでは、 Databricks のノートブックは.ipynb(IPythonまたはJupyter)形式で作成されます。 代わりにソース形式を使用することもできます。

ノートブックは、さまざまな形式でインポートおよびエクスポートできます。 「Databricks ノートブックのエクスポートとインポート」を参照してください。

ノートブックのフォーマット

Databricks は、 ipynb (デフォルト) とソースの 2 つの形式でノートブックを作成および編集できます。

ノートブックを含むソースファイルは、 Git フォルダーを使用して管理できます。 Git フォルダーでは、特定の Databricks アセットの種類 のみがサポートされます。 この形式は、次の表に示すように、ノートブックがリモート リポジトリにコミットされる方法に影響します。

ノートブックのソース形式	詳細
ソース	ソース コードのみをキャプチャする基本的な形式で、 .py、 .scala、 .r 、 .sqlなどのコード言語を示すサフィックスが付いています。
ipynb (ジュピター)	ソース コード、ノートブック環境、視覚化定義、ノートブック ウィジェット、およびオプションの出力をキャプチャする豊富な形式。 ipynb ノートブックには、.ipynb のpy部分に関係なくDatabricksノートブックでサポートされている任意の言語のコードを含めることができます。ipynb形式を使用すると、オプションでノートブックとノートブックの出力をバージョン管理できます。

ipynb形式は、リモートDatabricks リポジトリ上の ノートブックの表示エクスペリエンスも向上させます。GitGitHub または GitLabを使用する場合は、pull request でノートブックの diff を強化する機能を有効にして、ノートブックの変更の表示とコード レビューを容易にすることができます。

GitHubipynbノートブックのリッチ差分の サポートの詳細については、「機能プレビュー: リッチ Jupyter ノートブックの差分 」を参照してください。ノートブックの差分の GitLabサポートの詳細については、「ipynbJupyter ノートブック ファイル 」を参照してください。

ソース形式のノートブックを通常の Python、Scala、SQL ファイルと区別するために、Databricks では Python、Scala、SQL ノートブックの先頭にコメント「Databricks notebook source」が追加されています。 このコメントにより、Databricks はファイルをスクリプト ファイルではなくノートブックとして正しく解析します。

注記

「アウトプット」とは?

出力は、Databricks プラットフォーム上でノートブックを実行した結果であり、テーブルの表示や視覚化などです。

デフォルトのノートブック形式の設定を変更する

ipynb ノートブックは、 Databricksで新しいノートブックを作成するときのデフォルト形式です。

デフォルトを Databricks ソース形式に変更するには、Databricks ワークスペースにログインし、ページの右上にあるプロファイルをクリックし、[ 設定 ] をクリックして [開発者] に移動します。 [エディター設定 ] 見出しの下にあるノートブックの形式のデフォルトを変更します。

ノートブック形式の変換

Databricks UI を使用して、既存のノートブックを別の形式に変換できます。

既存のノートブックを別の形式に変換するには:

1. ワークスペースでノートブックを開きます。

2. ワークスペース メニューから [ファイル ] を選択し、[ ノートブック形式 ] を選択して、目的の形式を選択します。 Jupyter (.ipynb) (推奨) または ソース (Scala, .py, .sql, R) のいずれかを選択できます。ノートブックの現在の形式はグレー表示され、その横にチェックマークが付いています。

   

Databricksでサポートされているノートブックの種類の詳細については、「ノートブックDatabricksエクスポートとインポート」を参照してください。

Manage ipynb ノートブック output コミット

ソース管理フォルダ内の ipynb ノートブックの場合、ノートブック出力をリモートリポジトリにコミットする方法を管理できます。

ノートブック出力 .ipynb コミットを許可する

出力をコミットできるのは、ワークスペース管理者がこの機能を有効にしている場合のみです。 デフォルトでは、 Git フォルダーの管理設定では、.ipynb ノートブック出力をコミットできません。 ワークスペースの管理者権限がある場合は、次の設定を変更できます。

1. Databricks 管理者コンソールの [管理者設定 ] > [ワークスペース設定 ] に移動します。

2. [ Git フォルダー ] で、[ Git フォルダーに ipynb 出力のエクスポートを許可する ] を選択し、[ 許可: ipynb 出力をオンに切り替えることができる ] を選択します。

   

important

出力が含まれる場合、視覚化とダッシュボードの構成は、作成する.ipynb ノートブックに含まれます。

Control ipynb ノートブック output アーティファクト コミット

.ipynb ファイルをコミットすると、Databricks は出力のコミット方法を制御できる構成ファイル (.databricks/commit_outputs) を作成します。

1. .ipynbノートブックファイルがあるが、リモートリポジトリに設定ファイルがない場合は、[ Git ステータス ] ダイアログに移動します。

2. 通知ダイアログで、 [コミット ファイルの作成 ] を選択します。

   

「 ファイル 」メニューから設定ファイルを生成することもできます。 [ファイル ] メニューには、構成ファイルを自動的に更新するコントロールがあり、特定のipynbノートブックの出力を含めるか除外するかを指定できます。

1. [ ファイル ] メニューで、 [ノートブック出力のコミット] を選択します。

   

2. ダイアログボックスで、ノートブック出力をコミットする選択を確認します。