ランタイムパラメーターの定義¶

Define environment variables to supply different values to custom model code at runtime by including them as runtime parameters, making your custom model easier to reuse. Define runtime parameters in code or through the UI:

• Code: Provide a model-metadata.yaml file in the model artifact. Define this file before uploading a model to Workshop, or use the template available in Workshop through a custom model's Files > Create dropdown. The YAML structure is defined on this page.

• UI: Define runtime parameters in the Runtime parameters section of the custom model in Workshop. For more information, see the Create custom models documentation.

Runtime parameters are injected into containers in two ways:

1. As standard environment variables without prefixes or JSON parsing for simple types (so you can use os.getenv to access environment variables without the datarobot-drum library).
2. For backward compatibility also in the legacy prefixed (MLOPS_RUNTIME_PARAM_*) and JSONified format.

Parameters created via the Workshop UI persist and merge when you upload new code versions, ensuring a seamless development flow.

{"awsAccessKeyId": "<your-key-id>", "awsSecretAccessKey": "<your-access-key>"} 

MAIN_AWS_CREDENTIAL_AWS_ACCESS_KEY_ID="<your-key-id>"
MAIN_AWS_CREDENTIAL_AWS_SECRET_ACCESS_KEY="<your-access-key>" 

To change runtime parameter values for an existing deployment, deactivate the deployment, update the values in the deployment's Settings > Resources tab, and then reactivate the deployment. For details, see Configure deployment resource settings.

Runtime parameter definitions¶

モデルメタデータを介してカスタムモデルにランタイムパラメーターを追加することで、カスタムモデルのコードを再利用しやすくします。 ランタイムパラメーターを定義するには、model-metadata.yamlに以下の runtimeParameterDefinitionsを追加します。

DataRobotで予約されたランタイムパラメーター¶

DataRobotでは、カスタムモデルの設定用に、以下のランタイムパラメーターが予約されています。

カスタムモデルのメタデータを定義する¶

Before you define runtimeParameterDefinitions in model-metadata.yaml, define the custom model metadata required for the target type. For binary and multiclass models, that includes an inferenceModel block (targetName and class labels; for multiclass, classLabels).

name: binary-example
targetType: binary
type: inference
inferenceModel:
  targetName: target
  positiveClassLabel: "1"
  negativeClassLabel: "0" 

name: regression-example
targetType: regression
type: inference 

name: textgeneration-example
targetType: textgeneration
type: inference 

name: anomaly-example
targetType: anomaly
type: inference 

name: unstructured-example
targetType: unstructured
type: inference 

name: multiclass-example
targetType: multiclass
type: inference
inferenceModel:
  targetName: class
  classLabels:
    - class_a
    - class_b
    - class_c 

次に、モデル情報の下にruntimeParameterDefinitionsを指定できます。

name: runtime-parameter-example
targetType: regression
type: inference

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
  credentialType: basic
  allowEmpty: false
  description: A runtime parameter containing a dictionary of credentials; credentials must be provided before registering the custom model.

- fieldName: runtime_parameter_for_connected_deployment
  type: deployment
  description: A runtime parameter defined to accept the deployment ID of another deployment to connect to the deployed custom model. 

ランタイムパラメーターによる資格情報の提供¶

credentialランタイムパラメータータイプは、DataRobot REST APIで使用可能な任意のcredentialType値をサポートします。 At runtime, credential payloads are also reflected as environment variables in the container; see the runtime parameter considerations for naming rules (single-field types such as api_token, bearer, and gcp use the bare parameter name; multi-field types such as basic and s3 use suffixed names per field).

資格情報は、以下の2つの方法で指定できます。

• 既存の資格情報を参照する：DataRobotの資格情報の管理セクションで定義された資格情報を参照するには、資格情報IDをdefaultValueとして使用します。

• 資格情報の値を直接指定する：（通常、DRUMを用いたローカル開発時に使用される）ランタイムパラメーターを定義する際には、完全な資格情報構造を含めます。

既存の資格情報を参照する¶

既存の資格情報を参照するには、defaultValueを資格情報IDに設定します。

- fieldName: my_api_token
  type: credential
  credentialType: api_token
  allowEmpty: false
  defaultValue: <credential-id>
  description: A runtime parameter referencing an existing API token credential. 

資格情報の値を直接指定する¶

必要な資格情報は、以下の例に示すように、credentialTypeによって異なります。

basic:
    credentialType: basic
    description: string
    name: string
    password: string
    user: string
        

azure:
    credentialType: azure
    description: string
    name: string
    azureConnectionString: string
        

gcp:
    credentialType: gcp
    description: string
    name: string
    gcpKey: string
        

s3:
  credentialType: s3
    description: string
    name: string
    awsAccessKeyId: string
    awsSecretAccessKey: string
    awsSessionToken: string
        

api_token:
    credentialType: api_token
    apiToken: string
    name: string
        

ローカル開発中にオーバーライド値を指定する¶

DRUMを使用したローカル開発では、ランタイムパラメーターの値を含む.yamlファイルを指定できます。 ここで定義された値は、model-metadata.yamlでのdefaultValueセットをオーバーライドします。

my_first_runtime_parameter: Hello, world.
runtime_parameter_with_default_value: Override the default value.
runtime_parameter_for_credentials:
  credentialType: basic
  name: credentials
  password: password1
  user: user1 

DRUMを使用する場合、--runtime-params-fileオプションはランタイムパラメーター値を含むファイルを指定します。

drum score --runtime-params-file .runtime-parameters.yaml --code-dir model_templates/python3_sklearn --target-type regression --input tests/testdata/juniors_3_year_stats_regression.csv 

カスタムコードでのランタイムパラメーターのインポートと使用¶

ランタイムパラメーターをインポートしてアクセスするには、custom.pyでコードにRuntimeParametersモジュールをインポートします。

from datarobot_drum import RuntimeParameters


def mask(value, visible=3):
    return value[:visible] + ("*" * len(value[visible:]))


def transform(data, model):
    print("Loading the following Runtime Parameters:")
    parameter1 = RuntimeParameters.get("my_first_runtime_parameter")
    parameter2 = RuntimeParameters.get("runtime_parameter_with_default_value")
    print(f"\tParameter 1: {parameter1}")
    print(f"\tParameter 2: {parameter2}")

    credentials = RuntimeParameters.get("runtime_parameter_for_credentials")
    if credentials is not None:
        credential_type = credentials.pop("credentialType")
        print(
            f"\tCredentials (type={credential_type}): "
            + str({k: mask(v) for k, v in credentials.items()})
        )
    else:
        print("No credential data set")
    return data