カスタムアプリケーションの管理¶
本機能の提供について
アプリケーションページは、デフォルトではオフになっています。 このプレビュー機能を有効にする方法については、DataRobotの担当者または管理者にお問い合わせください。
機能フラグ: カスタムアプリケーションワークショップを有効にする
レジストリのアプリケーションページには、すべてのアプリケーションタブから使用できるすべてのカスタムアプリケーションが一覧表示されます。 次の表は、このページの要素と使用可能なアクションを示します。
要素 | 説明 | |
---|---|---|
1 | アプリケーション名 | アプリケーション名。 |
2 | バージョン | アプリケーションまたはソースのバージョン番号を一覧表示します。 |
3 | 開く | クリックすると、アプリケーションまたはソースが開きます。 |
4 | アクションメニュー | アプリケーションを共有、制御、または削除します。 |
5 | 検索 | リスト内の特定のアプリケーションを検索するために使用します。 |
6 | 「アプリケーション」タブ | 構築されたアプリケーションまたはアプリケーションソースの表示を選択します。 |
7 | ドロップダウンを追加 | 追加ドロップダウンを使用して、カスタムアプリケーションをアップロードするか、または新しいアプリケーションソースを作成します。 |
アプリケーションの共有¶
共有機能は権限を管理し、ユーザー、グループ、組織、およびDataRobot以外の受信者とアプリケーションを共有できます。 この機能は、アプリケーションを作成するための専門知識のないユーザーに既存のアプリケーションの使用を許可する場合などに便利です。
注意
複数のユーザーが同じアプリケーションにアクセスできる場合、各ユーザーは、別のユーザーが行った変更や予測を表示、編集、上書きしたり、アップロードしたデータセットを見たりすることができます。 この動作は、カスタムアプリケーションの性質によって異なります。
アプリワークショップのアクションメニューから共有機能にアクセスできます。 共有するアプリケーションの横にあるアクションメニュー をクリックして共有 を選択します。
これにより共有ウィンドウが開き、ユーザーとその役割がリストされます。 エディターは、1つ以上のユーザーまたはグループ、組織全体でアプリケーションを共有できます。 さらに、共有リンクを使ってアプリケーションを外部と共有できます。
-
新しいユーザーを追加するには、次と共有:フィールドにそのユーザー名を入力します。
-
ドロップダウンからロールを選択します。
-
通知を送信を選択してEメール通知を送信し、メモを追加を選択して通知に詳細を追加します。
-
共有をクリックします。
-
共有ウィンドウでグループまたは組織タブを選択します。
-
共有先フィールドにグループ名または組織名を入力します。
- 権限のロールを決めます。
- 共有をクリックします。 アプリが共有され、役割は指定されたグループまたは組織のすべてのメンバーに適用されます。
DataRobot以外のユーザーとカスタムアプリケーションを共有するには、外部共有を有効にするをオンに切り替えます。 トグルの下に表示されるリンクを使用すると、DataRobotにアクセスできないエンドユーザーとカスタムを共有できます。 そのリンクをエンドユーザーと共有する前に、アプリケーションへのアクセスを許可するEメールドメインとアドレスを指定する必要があります。 このリストを変更することで、共有リンクへのアクセスを取り消すことができます。 アプリケーションにアクセスしなくなったドメインまたはアドレスを削除します。
共有ダイアログでは、次のアクションも使用できます。
- ユーザーを削除するには、削除するユーザーの役割の右側にある「X」ボタンをクリックします。
-
ユーザーの役割を再度割り当てるには、割り当てられた役割をクリックして、ドロップダウンから新しい役割を割り当てます。
アプリケーションの削除¶
適切な権限がある場合、アクションメニュー をクリックし、削除()をクリックすることで、アプリケーションを削除できます。
アプリケーションのソース¶
アプリケーションソースには、カスタムアプリケーションを構築できるファイル、依存関係、および環境が含まれます。 アプリケーションページで、アプリケーションソースタブを選択して、カスタムアプリケーションを構築できるすべてのソースを表示します。
アプリケーションソースの追加¶
アプリケーションページから新しいアプリケーションソースを作成するには、追加 > 新しいアプリケーションソースをクリックします。
新しいアプリケーションソースが、直ちにページに追加されます。 新しいアプリケーションソースを選択して、設定を開始します。
アプリケーションソースの設定¶
アプリケーションソースを選択後、その基本環境を選択し、ソースにファイルをアップロードして、ランタイムパラメーターを作成できます。
アプリケーションソースのこれらのコンポーネントのいずれかを編集する場合、ソースの新しいバージョンを作成します。 バージョンドロップダウンから、ソースの任意のバージョンを選択できます。
環境¶
カスタムアプリケーションは、環境(Dockerコンテナ)内で実行されます。 環境には、カスタムアプリケーションで使用されるパッケージ、言語、およびシステムライブラリが含まれます。 環境ヘッダーの下にあるドロップダウンから、DataRobotが提供するアプリケーションソースの環境を選択します。 DataRobotは、[Experimental] Python 3.9 Streamlit
という名前の事前定義済み基本環境を提供します。
ファイル¶
ファイルセクションでは、カスタムアプリケーションソースを構成するファイルを構築できます。 ボックスにファイルをドラッグするか、このセクションのオプションを使用して、カスタムジョブの構築に必要なファイルを作成またはアップロードします。
オプション | 説明 |
---|---|
ソース/アップロードから選択 | 既存のカスタムジョブファイル(run.sh 、metadata.yaml 、など)をローカルファイルまたはローカルフォルダーとしてアップロードします。 |
作成 | 空のファイルまたはテンプレートを含んだファイルとして新しいファイルを作成し、カスタムジョブに保存します。
|
空白のテキストファイル作成を選択する場合、ファイルに情報を入力し、完全なパス(そのファイルに属するフォルダおよびファイル拡張子を含む)を使用して名前を付け、保存をクリックします。
リソース¶
本機能の提供について
カスタムアプリケーションのランタイムパラメーターは、デフォルトではオフになっています。 このプレビュー機能を有効にする方法については、DataRobotの担当者または管理者にお問い合わせください。
機能フラグ:カスタムアプリケーションワークショップを有効にする、ランタイムパラメーターとリソースの上限を有効にする、リソースのバンドルを有効にする
アプリケーションソースを作成した後、アプリケーションが消費するリソースを設定して、本番環境での潜在的な環境エラーを最小限に抑えることができます。 DataRobotでは、リソース制限とレプリカ番号をカスタマイズできます。 リソースバンドルを編集するには:
-
アプリケーションソースを選択します。 リソースセクションで () 編集をクリックします。
-
リソースを更新ダイアログボックスで、次の設定を行います。
設定 説明 バンドル ドロップダウンからリソースバンドルを選択し、カスタムアプリケーションに割り当てることができるメモリーとCPUの最大量を決定します。 レプリカ カスタムアプリケーションの実行時にワークロードのバランスを取るために、並行して実行するレプリカの最大数を設定します。 デフォルト値は 1 で、最大値は4です。 -
アプリケーションソースのリソース設定が完了したら、保存をクリックします。
ランタイムパラメーター¶
本機能の提供について
カスタムアプリケーションのランタイムパラメーターは、デフォルトではオフになっています。 このプレビュー機能を有効にする方法については、DataRobotの担当者または管理者にお問い合わせください。
機能フラグ:ランタイムパラメーターとリソースの上限を有効にする
アプリケーションソースから構築されたカスタムアプリケーションで使用されるランタイムパラメーターを作成して定義します。
metadata.yaml
ファイルに含めることで、ランタイムパラメーターをカスタムアプリケーションに追加でき、カスタムアプリケーションの再利用を容易にします。 このファイルのテンプレートは、ファイル > 作成ドロップダウンから使用できます。
ランタイムパラメーターを定義するには、以下のruntimeParameterDefinitions
をmetadata.yaml
に追加できます。
キー | 説明 |
---|---|
fieldName |
ランタイムパラメーターの名前を定義します。 |
type |
ランタイムパラメーターに含まれるデータ型(string 、boolean 、numeric 、credential )を定義します。 |
defaultValue |
(オプション)ランタイムパラメーターのデフォルト文字列値(credentialタイプはデフォルト値をサポートしません) |
minValue |
(オプション)numeric ランタイムパラメーターには、ランタイムパラメーターで使用可能な最小数値を設定します。 |
maxValue |
(オプション)numeric ランタイムパラメーターには、ランタイムパラメーターで使用可能な最大数値を設定します。 |
allowEmpty |
(オプション)ランタイムパラメーターに空のフィールドポリシーを設定します。
|
description |
(オプション)ランタイムパラメーターの目的または内容の説明 |
備考
defaultValue
を指定せずにランタイムパラメーターを定義した場合、デフォルト値はNone
です。
name: runtime-parameter-example
type: inference
targetType: regression
runtimeParameterDefinitions:
- fieldName: my_first_runtime_parameter
type: string
description: My first runtime parameter.
- fieldName: runtime_parameter_with_default_value
type: string
defaultValue: Default
description: A string-type runtime parameter with a default value.
- fieldName: runtime_parameter_boolean
type: boolean
defaultValue: true
description: A boolean-type runtime parameter with a default value of true.
- fieldname: runtime_parameter_numeric
type: numeric
defaultValue: 0
minValue: -100
maxValue: 100
description: A boolean-type runtime parameter with a default value of 0, a minimum value of -100, and a maximum value of 100.
- fieldName: runtime_parameter_for_credentials
type: credential
allowEmpty: false
description: A runtime parameter containing a dictionary of credentials.
credential
ランタイムパラメータータイプは、DataRobot REST APIで使用可能な任意のcredentialType
値をサポートします。 以下の例に示すように、含まれる資格情報はcredentialType
に依存します。
備考
サポートされている資格情報タイプの詳細については、 資格情報のAPIリファレンスドキュメントを参照してください。
Credential Type | Example |
---|---|
basic |
basic: credentialType: basic description: string name: string password: string user: string |
azure |
azure: credentialType: azure description: string name: string azureConnectionString: string |
gcp |
gcp: credentialType: gcp description: string name: string gcpKey: string |
s3 |
s3: credentialType: s3 description: string name: string awsAccessKeyId: string awsSecretAccessKey: string awsSessionToken: string |
api_token |
api_token: credentialType: api_token apiToken: string name: string |