NextGenエクスペリエンス > レジストリ > カスタムアプリケーション > Manage custom applications

Manage custom applications¶

本機能の提供について

The Applications page is off by default. Contact your DataRobot representative or administrator for information on enabling this preview feature.

機能フラグ： カスタムアプリケーションワークショップを有効にする

The Applications page in the Registry lists all custom applications available to you from the All applications tab. The table below describes the elements and available actions from this page:

	要素	説明
1	アプリケーション名	The application name.
2	バージョン	Lists the version number of the application or source.
3	開く	Click to open an application or source.
4	アクションメニュー	Shares, controls, or deletes an application.
5	検索	Use to find a specific application in the list.
6	「アプリケーション」タブ	Choose to view built applications or application sources.
7	Add dropdown	Use the Add dropdown to upload a custom app or create a new application source.

The sharing capability allows you to manage permissions and share an application with users, groups, and organizations, as well as recipients outside of DataRobot. この機能は、アプリケーションを作成するための専門知識のないユーザーに既存のアプリケーションの使用を許可する場合などに便利です。

注意

複数のユーザーが同じアプリケーションにアクセスできる場合、各ユーザーは、別のユーザーが行った変更や予測を表示、編集、上書き、アップロードされたデータセットの表示を行えます。 This behavior depends on the nature of the custom application.

You can access sharing functionality from the actions menu in the Apps workshop. Click the menu icon () next to the app you want to share and select Share ().

これにより共有ウィンドウが開き、ユーザーとその役割がリストされます。エディターは、1つ以上のユーザーまたはグループ、組織全体でアプリケーションを共有できます。 Additionally, you can share an application externally with a sharing link.

ユーザーグループと組織External sharing

新しいユーザーを追加するには、次と共有：フィールドにそのユーザー名を入力します。
ドロップダウンからロールを選択します。
通知を送信を選択してEメール通知を送信し、メモを追加を選択して通知に詳細を追加します。
共有をクリックします。

共有ウィンドウでグループまたは組織タブを選択します。
共有先フィールドにグループ名または組織名を入力します。
権限のロールを決めます。
共有をクリックします。アプリが共有され、役割は指定されたグループまたは組織のすべてのメンバーに適用されます。

To share a custom app with non-Datarobot users, toggle on Enable external sharing. The link that appears beneath the toggle allows you to share custom with end-users who don't have access to DataRobot. Before you can share that link with end users, you must specify the email domains and addresses that are permitted access to the app. You can revoke access to a sharing link by modifying this list. Remove the domains or addresses that you no longer want to have access to the app.

共有ダイアログでは、次のアクションも使用できます。

ユーザーを削除するには、削除するユーザーの役割の右側にある「X」ボタンをクリックします。
ユーザーの役割を再度割り当てるには、割り当てられた役割をクリックして、ドロップダウンから新しい役割を割り当てます。

アプリケーションの削除¶

適切な権限がある場合、メニュー()を開き、削除()をクリックしてアプリケーションを削除できます。

アプリケーションのソース¶

An application source contains the files, dependencies, and environment from which a custom app can be built. On the Applications page, select the Application sources tab to view all the sources that you can build custom applications from.

Add an application source¶

To create a new application source from the Applications page, click Add > New application source.

The new application source is immediately added to the page. Select the new application source to begin configuring it.

Configure an application source¶

After selecting an application source, you can choose its base environment, upload files to the source, and create runtime parameters.

Whenever you edit any of these components of an application source, you create a new version of the source. You can select any version of a source from the Version dropdown.

環境¶

Custom apps run inside of environments (Docker containers). Environments include the packages, language, and system libraries used by the custom app. Select a DataRobot-provided environment for the application source from the dropdown under the Environment header. DataRobot offers a predefined base environment named [Experimental] Python 3.9 Streamlit.

ファイル¶

In the Files section, you can assemble the files that make up the custom application source. ボックスにファイルをドラッグするか、このセクションのオプションを使用して、カスタムジョブのアセンブルに必要なファイルを作成またはアップロードします。

オプション説明

ソース／アップロードから選択既存のカスタムジョブファイル（run.sh、metadata.yaml、など）をローカルファイルまたはローカルフォルダーとしてアップロードします。

作成

Create a new file, empty or containing a template, and save it to the custom job:

Create metadata.yaml: Creates a basic, editable example of a runtime parameters file.
Create README.md: Creates a basic, editable README file.
Create start-app.sh: Creates a basic, editable example of an entry point file.
Create demo-streamlit.py: Creates a basic, editable Python file.
Create example job: Combines all template files to create a basic, editable app. You can quickly configure the runtime parameters and run this example app.
Create blank file: Creates an empty file. 名称未設定の横にある編集アイコン（）をクリックしてファイル名と拡張子を入力し、カスタムコンテンツを追加します。次のステップでは、カスタム名とコンテンツを使用して、このように作成されたファイルをエントリーポイントとして識別できます。新しいファイルを設定したら、保存をクリックします。

If you choose to create a blank text file, enter the information into the file, name it using a full path (including the folder it belongs to and the file extension), then click Save.

ランタイムパラメーター¶

Create and define runtime parameters used by the custom app built from the application source. You can add runtime parameters to a custom app by including them in a metadata.yaml file, making your custom app easier to reuse. A template for this file is available from Files > Create dropdown.

To define runtime parameters, you can add the following runtimeParameterDefinitions in metadata.yaml:

キー	説明
`fieldName`	ランタイムパラメーターの名前を定義します。
`type`	ランタイムパラメーターに含まれるデータ型（`string`、`boolean`、`numeric`、`credential`）を定義します。
`defaultValue`	（オプション）ランタイムパラメーターのデフォルト文字列値（credentialタイプはデフォルト値をサポートしません）
`minValue`	（オプション）`numeric`ランタイムパラメーターには、ランタイムパラメーターで使用可能な最小数値を設定します。
`maxValue`	（オプション）`numeric`ランタイムパラメーターには、ランタイムパラメーターで使用可能な最大数値を設定します。
`allowEmpty`	（オプション）ランタイムパラメーターに空のフィールドポリシーを設定します。 `True`：（デフォルト）空のランタイムパラメーターを許可します。 `False`：デプロイ前にランタイムパラメーターの値を指定するよう徹底します。
`description`	（オプション）ランタイムパラメーターの目的または内容の説明

備考

defaultValueを指定せずにランタイムパラメーターを定義した場合、デフォルト値はNoneです。

例: metadata.yaml

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

更新しました April 2, 2024

このページは役に立ちましたか？

ありがとうございます。どのような点が役に立ちましたか？

より良いコンテンツを提供するには、どうすればよいでしょうか？

アンケートにご協力いただき、ありがとうございました。