3.5.3.3.1 CLIによるレシピの作成

1. コンテナの起動

   プロジェクトのコンテナを起動します。

2. Jupyter Notebookのターミナルの起動

   [New]ボタンをクリックし、[Terminal]を選択します。

   Jupyter Notebookのターミナルの起動を確認します。

3. レシピのID確認

   dashrecipe listコマンドを実行し、レシピのレシピIDを確認します。

   ベースレシピは、recipeTypeに "BASE"と表示されます。idに表示される番号がレシピIDです。

   $ dashrecipe list

   例

   $ dashrecipe list
   id | recipeType   | name                  | description
   ---+--------------+-----------------------+---------------------------------
    1 | BASE         | edit_jupyter          | This is BASE recipe.
    2 | FUNCTION     | recipe_sample1        | Sample recipe.
    3 | FUNCTION     | long_name_long_name_< | Sample recipe.
    4 | FUNCTION     | recipe_sample3        | long_description_long_descriptio<

4. ライブラリー一覧の取得

   dashrecipe downloadコマンドを実行し、ライブラリー一覧が記述されたファイル(requirements.txt)を取得します。

   $ dashrecipe download --id <レシピid>

   例

   $ dashrecipe download --id 2
   $ ls -lR
   .:
   total 0
   drwxr-xr-x. 2 root root 49 Sep 12 09:32 recipe_2
   ./recipe_2:
   total 12
   -rw-r--r--. 1 root root 6531 Sep 12 09:32 dash_test.ipynb
   -rw-r--r--. 1 root root 1502 Sep 12 09:32 requirements.txt

5. レシピの作成

   dashrecipe createコマンドを実行し、レシピを作成します。

   以下のように指定します。入力規則は、「表 3.29 レシピの入力規則」を参照してください。

   $ dashrecipe create [-h] --name <レシピ名> --base_id <ベースレシピのID> --file <分析スクリプト名> 
                        [--description <説明>]
                        [--in_port <PORTNAME,PORTNAME,..>] [--out_port <PORTNAME,PORTNAME,..>]
                        [--env_file <必要ライブラリー一覧>]

   • レシピ名

     レシピとして登録・公開する名前

   • 分析スクリプト名

     ユーザーが作成した分析スクリプト名

     スクリプトファイルは新規作成するか、手順4.でダウンロードしたファイルを流用または修正して指定します。

   • 必要ライブラリー一覧

     ユーザーが作成するレシピのライブラリー一覧を記載したファイル名

     手順4.でダウンロードしたライブラリー一覧を参考に新規作成したファイルを指定します。

   • 説明

     レシピの説明を指定します。

   • PORTNAME

     入出力に使用するポート名を指定します。

   例

   $ dashrecipe create --name user-def-recipe --base_id 1 --file sample.ipynb --in_port in1 --out_port out1 --env_file requirements.txt

   ポイント

   --env_file を指定しない場合、--fileで指定した分析スクリプトから必要なライブラリー(最新バージョン)をインターネット経由で取得します。

   CLIを実行するターミナルからインターネットにアクセスする際、プロキシ経由でのアクセスが必要な場合、事前にプロキシ設定が必要です。以下の形式で環境変数 https_proxy の設定を実施してください。

   形式は以下のとおりです。

   https_proxy=https://<user>:<password>@<ip_addr>:<port>/

   注意

   • 同じ名前のレシピは、作成できません。

   • 指定したパラメーターはあとから変更できません。レシピ化対象の分析スクリプトに対して、入出力ポートの設定や処理内容、使用するライブラリーを確認し、実行してください。

   • 元となるレシピとして指定できるのは、recipeType="BASE"のレシピだけです。

   • 本コマンドで作成したレシピの公開範囲は"private"です。必要に応じてWeb UIから、"public"レシピに変更してください。

   • 本コマンドで作成したレシピの種類は"実行のみ可"です。

$ dashrecipe list