Assemble structured custom models¶

DataRobot provides built-in support for a variety of libraries to create models that use conventional target types. If your model is based on one of these libraries, DataRobot expects your model artifact to have a matching file extension:

If your model doesn't use one of the following libraries, you must create an unstructured custom model.

Compare the characteristics and capabilities of the two types of custom models below:

Structured custom model requirements¶

If your custom model uses one of the supported libraries, make sure it meets the following requirements:

• Data sent to a model must be usable for predictions without additional pre-processing.
• 連続値モデルは、予測データの行ごとに単一の浮動小数点を返す必要があります。
• Binary classification models must return one floating point value <= 1.0 or two floating point values that sum to 1.0 per row of prediction data.
  • Single-value output is assumed to be the positive class probability.
  • For multi-value, it is assumed that the first value is the negative class probability and the second is the positive class probability.
• There must be a single pkl/pth/h5 file present.

Structured custom model hooks¶

To define a custom model using DataRobot’s framework, your artifact file should contain hooks (or functions) to define how a model is trained and how it scores new data. DataRobotは各フックを自動的に呼び出し、プロジェクトおよびブループリントの設定に基づいてパラメーターを渡します。 しかし、各フック内で実行するロジックを定義できる柔軟性があります。 If necessary, you can include these hooks alongside your model artifacts in your model folder in a file called custom.py for Python models or custom.R for R models.

次のセクションでは、例とともに各フックについて説明します。

init()¶

The init hook is executed only once at the beginning of the run to allow the model to load libraries and additional files for use in other hooks.

init(**kwargs) -> None 

init() 入力¶

init() 例¶

以下に、init()を使用した簡単なコードスニペットを紹介します。より完全な例についてはこちらを参照してください。

def init(code_dir):
    global g_code_dir
    g_code_dir = code_dir 

init <- function(…) {
    library(brnn)
    library(glmnet)
} 

init() 出力¶

init()フックは何も返しません。

load_model()¶

The load_model() hook is executed only once at the beginning of the run to load one or more trained objects from multiple artifacts. トレーニング済みのオブジェクトがサポートされていない形式を使用するアーティファクトに保存されている場合、または複数のアーティファクトが使用される場合にのみ必要です。 The load_model() hook is not required when there is a single artifact in one of the supported formats:

• Python：.pkl、.pth、.h5、.joblib
• Java：.mojo
• R：.rds

load_model(code_dir: str) -> Any 

load_model() 入力¶

load_model() 例¶

以下に、load_model()を使用した簡単なコードスニペットを紹介します。より完全な例についてはこちらを参照してください。

def load_model(code_dir):
    model_path = "model.pkl"
    model = joblib.load(os.path.join(code_dir, model_path)) 

load_model <- function(input_dir) {
    readRDS(file.path(input_dir, "model_name.rds"))
} 

load_model() 出力¶

load_model()フックは、トレーニング済みのオブジェクト（あらゆる型）を返します。

read_input_data()¶

The read_input_data hook customizes how the model reads data; for example, with encoding and missing value handling.

read_input_data(input_binary_data: bytes) -> Any 

read_input_data()入力¶

read_input_data()例¶

def read_input_data(input_binary_data):
    global prediction_value
    prediction_value += 1
    return pd.read_csv(io.BytesIO(input_binary_data)) 

read_input_data <- function(input_binary_data) {
    input_text_data <- stri_conv(input_binary_data, "utf8")
    read.csv(text=gsub("\r","", input_text_data, fixed=TRUE))
} 

read_input_data()出力¶

The read_input_data() hook must return a pandas DataFrame or R data.frame; otherwise, you must write your own score method.

transform()¶

transform()フックはカスタム変換の出力を定義し、変換されたデータを返します。 推定器モデルにこのフックを使用しないでください。 This hook can be used in both transformer and estimator tasks:

• For transformers, this hook applies transformations to the data provided and passes it to downstream tasks.

• For estimators, this hook applies transformations to the prediction data before making predictions.

transform(data: DataFrame, model: Any) -> DataFrame 

transform() 入力¶

transform() 例¶

以下に、transform()を使用した簡単なコードスニペットを紹介します。より完全な例についてはこちらを参照してください。

def transform(data, model):
    data = data.fillna(0)
    return data 

transform <- function(data, model) {
    data[is.na(data)] <- 0
    data
} 

transform() 出力¶

The transform() hook returns a pandas DataFrame or R data.frame with transformed data.

score()¶

score()フックは、カスタム推定器の出力を定義し、出力データに予測を返します。 変換モデルにこのフックは使用しないでください。

score(data: DataFrame, model: Any, **kwargs: Dict[str, Any]) -> DataFrame 

score() 入力¶

score() 例¶

以下に、score()を使用した簡単なコードスニペットを紹介します。より完全な例についてはこちらを参照してください。

def score(data: pd.DataFrame, model: Any, **kwargs: Dict[str, Any]) -> pd.DataFrame:
    predictions = model.predict(data)
    predictions_df = pd.DataFrame(predictions, columns=[kwargs["positive_class_label"]])
    predictions_df[kwargs["negative_class_label"]] = (
        1 - predictions_df[kwargs["positive_class_label"]]
    )

    return predictions_df 

score <- function(data, model, …){
    scores <- predict(model, newdata = data, type = "prob")
    names(scores) <- c('0', '1')
    return(scores)
} 

score() 出力¶

The score() hook should return a pandas DataFrame (or R data.frame or tibble) of the following format:

• 連続値または異常検知プロジェクトの場合、出力に予測という単一の数値列が必要です。

• 二値または多クラスプロジェクトについては、出力にはクラスごとに1つの列があり、クラス名を列名として使用する必要があります。 各セルには各クラスの確率が含まれている必要があります。また、各行の合計が1.0になる必要があります。

post_process()¶

The post_process hook formats the prediction data returned by DataRobot or the score hook when it doesn't match the output format expectations.

post_process(predictions: DataFrame, model: Any) -> DataFrame 

post_process()入力¶

post_process()例¶

def post_process(predictions, model):
    return predictions + 1 

post_process <- function(predictions, model) {
    names(predictions) <- c('0', '1')
} 

post_process()出力¶

The post_process hook returns a pandas DataFrame (or R data.frame or tibble) of the following format:

• 連続値または異常検知プロジェクトの場合、出力に予測という単一の数値列が必要です。

• 二値または多クラスプロジェクトについては、出力にはクラスごとに1つの列があり、クラス名を列名として使用する必要があります。 各セルには各クラスの確率が含まれている必要があります。また、各行の合計が1.0になる必要があります。