Platform For AI:EasyRec プロセッサ

新しい FeatureGenerator ライブラリ（fg_mode=normal）

この例では、PyOdps3 ノードタイプと新しい FeatureGenerator ライブラリを使用します。このライブラリは、組み込みおよびカスタムの変換オペレーター、複雑な入力タイプ（配列、マップ）、DAG ベースの特徴の依存関係をサポートします。

次の例では、特徴データ管理に PAI-FeatureStore を使用します。${fs_project},${fs_model} を実際の値に置き換えてください。「ステップ 2: EAS モデルサービスの作成とデプロイ」では、完全な手順について説明しています。

import json
import os

service_name = 'ali_rec_rnk_with_fg'

config = {
  'name': service_name,
  'metadata': {
    "cpu": 8,
    #"cuda": "11.2",
    "gateway": "default",
    "gpu": 0,
    "memory": 32000,
    "rolling_strategy": {
        "max_unavailable": 1
    },
    "rpc": {
        "enable_jemalloc": 1,
        "max_queue_size": 256
    }
  },
  "processor_envs": [
    {
      "name": "ADAPTE_FG_CONFIG",
      "value": "true"
    }
  ],
  "model_path": "",
  "processor": "easyrec-3.5",
  "storage": [
    {
      "mount_path": "/home/admin/docker_ml/workspace/model/",
      "oss": {
        "path": "oss://easyrec/ali_rec_sln_acc_rnk/20250722/export/final_with_fg"
      }
    }
  ],
  # fg_mode を変更する場合は、呼び出しメソッドも変更する必要があります。
  # fg_mode が 'normal' または 'tf' の場合は、EasyRecRequest SDK を使用します。
  # fg_mode が 'bypass' の場合は、TFRequest SDK を使用します。
  'model_config': {
    'outputs': 'probs_ctr,probs_cvr',
    'fg_mode': 'normal',
    'steady_mode': True,
    'period': 2880,
    'access_key_id': f'{o.account.access_id}',
    'access_key_secret': f'{o.account.secret_access_key}',
    "load_feature_from_offlinestore": True,
    'region': 'cn-shanghai',
    'fs_project': '${fs_project}',
    'fs_model': '${fs_model}',
    'fs_entity': 'item',
    'featuredb_username': 'guest',
    'featuredb_password': '123456',
    'log_iterate_time_threshold': 100,
    'iterate_featuredb_interval': 5,
    'mc_thread_pool_num': 1,
  }
}

with open('echo.json', 'w') as output_file:
    json.dump(config, output_file)

os.system(f'/home/admin/usertools/tools/eascmd -i {o.account.access_id} -k {o.account.secret_access_key} -e pai-eas.cn-shanghai.aliyuncs.com create echo.json')
# os.system(f'/home/admin/usertools/tools/eascmd -i {o.account.access_id} -k {o.account.secret_access_key} -e pai-eas.cn-shanghai.aliyuncs.com modify {service_name} -s echo.json')

featuredb_username および featuredb_password の値を有効な認証情報に置き換えてください。

TF オペレーターバージョンの FeatureGenerator（fg_mode=tf）

重要： TF オペレーターバージョンの FeatureGenerator は、限定された組み込み特徴のみをサポートします： id_feature, raw_feature, combo_feature, lookup_feature, match_feature, および sequence_feature。カスタム FeatureGenerator オペレーターはサポートされていません。

次のデプロイスクリプトには、AccessKey ペアがプレーンテキストで含まれています。Hologres の負荷を軽減するために、PAI-FeatureStore を使用せず、MaxCompute からデータを読み込みません。

本番デプロイメントでは、MaxCompute を使用した PAI-FeatureStore を使用してください。「ステップ 2: EAS モデルサービスの作成とデプロイ」では、Python スクリプト、DataWorks の o オブジェクト、および load_feature_from_offlinestore を True に設定した一時 STS トークンを使った、より安全な方法を示しています。

bizdate=$1
# fg_mode に基づいて呼び出しメソッドを変更します: 'normal'/'tf' の場合は EasyRecRequest、'bypass' の場合は TFRequest
cat << EOF > echo.json
{
  "name":"ali_rec_rnk_with_fg",
  "metadata": {
    "instance": 2,
    "rpc": {
      "enable_jemalloc": 1,
      "max_queue_size": 100
    }
  },
  "cloud": {
    "computing": {
      "instance_type": "ecs.g7.large",
      "instances": null
    }
  },
  "model_config": {
    "remote_type": "hologres",
    "url": "postgresql://<AccessKeyID>:<AccessKeySecret>@<endpoint>:<port>/<database>",
    "tables": [{"name":"<schema>.<table_name>","key":"<index_column_name>","value": "<column_name>"}],
    "period": 2880,
    "fg_mode": "tf",
    "outputs":"probs_ctr,probs_cvr",
  },
  "model_path": "",
  "processor": "easyrec-3.5",
  "storage": [
    {
      "mount_path": "/home/admin/docker_ml/workspace/model/",
      "oss": {
        "path": "oss://easyrec/ali_rec_sln_acc_rnk/20221122/export/final_with_fg"
      }
    }
  ]
}

EOF
# デプロイコマンドを実行します。
eascmd  create echo.json
# eascmd -i <AccessKeyID>  -k  <AccessKeySecret>   -e <endpoint> create echo.json
# 更新コマンドを実行します。
eascmd update ali_rec_rnk_with_fg -s echo.json

FeatureGenerator のバイパス（fg_mode=bypass）

FeatureGenerator を使用しない場合は、クライアント側でリクエストを組み立てる必要があります。詳細については、「EasyRec でトレーニングせずに EAS を推論に使用する方法」をご参照ください。

bizdate=$1
# fg_mode に基づいて呼び出しメソッドを変更します: 'normal'/'tf' の場合は EasyRecRequest、'bypass' の場合は TFRequest
cat << EOF > echo.json
{
  "name":"ali_rec_rnk_no_fg",
  "metadata": {
    "instance": 2,
    "rpc": {
      "enable_jemalloc": 1,
      "max_queue_size": 100
    }
  },
  "cloud": {
    "computing": {
      "instance_type": "ecs.g7.large",
      "instances": null
    }
  },
  "model_config": {
    "fg_mode": "bypass"
  },
  "processor": "easyrec-3.5",
  "processor_envs": [
    {
      "name": "INPUT_TILE",
      "value": "2"
    }
  ],
  "storage": [
    {
      "mount_path": "/home/admin/docker_ml/workspace/model/",
      "oss": {
        "path": "oss://easyrec/ali_rec_sln_acc_rnk/20221122/export/final/"
      }
    }
  ],
  "warm_up_data_path": "oss://easyrec/ali_rec_sln_acc_rnk/rnk_warm_up.bin"
}

EOF
# デプロイコマンドを実行します。
eascmd  create echo.json
# eascmd -i <AccessKeyID>  -k  <AccessKeySecret>   -e <endpoint> create echo.json
# 更新コマンドを実行します。
eascmd update ali_rec_rnk_no_fg -s echo.json

次の表では、主要なパラメータについて説明します。追加のパラメータについては、「JSON デプロイ」をご参照ください。

EasyRec プロセッサ推論の最適化

2.1 ネットワーク設定

PAI-Rec エンジンとスコアリングサービスはどちらも PAI-EAS 上で実行されるため、ダイレクトネットワーク接続が必要です。PAI-EAS インスタンスページで [VPC] をクリックして、同じ VPC、vSwitch、およびセキュリティグループを設定します。詳細については、「EAS からパブリックまたはオンプレミスのリソースにアクセスする」をご参照ください。Hologres を使用する場合は、同じ VPC も設定してください。次の図に例を示します。

2.2 サービス情報の取得

デプロイ後、[Elastic Algorithm Service (EAS)] ページに移動します。目的のサービスを探し、[サービスメソッド] 列の [呼び出し情報] をクリックすると、エンドポイントとトークンが表示されます。

2.3 SDK コード例

EasyRec モデルは、入力と出力に Protocol Buffers (Protobuf) を使用するため、PAI-EAS コンソールからテストすることはできません。

サービスを呼び出す前に、ステップ 1 の model_config 内にある fg_mode を確認してください。モードごとに、必要なクライアント SDK が異なります。

import com.aliyun.openservices.eas.predict.http.*;
import com.aliyun.openservices.eas.predict.request.EasyRecRequest;

PredictClient client = new PredictClient(new HttpConfig());
// パブリックゲートウェイ経由でサービスにアクセスする場合、ユーザー ID (UID) で始まるエンドポイントを使用します。このエンドポイントは、EAS コンソールのサービスの呼び出し情報から取得できます。
client.setEndpoint("xxxxxxx.vpc.cn-hangzhou.pai-eas.aliyuncs.com");
client.setModelName("ali_rec_rnk_with_fg");
// ご自身のサービス トークンに置き換えてください。
client.setToken("******");

EasyRecRequest easyrecRequest = new EasyRecRequest(separator);
// userFeatures: ユーザー特徴量。特徴量は `\u0002` (CTRL_B) で区切られます。特徴量名と値はコロン (:) で区切られます。
//  user_fea0:user_fea0_val\u0002user_fea1:user_fea1_val
// 特徴値の形式の詳細については、https://easyrec.readthedocs.io/en/latest/feature/rtp_fg.html を参照してください。
easyrecRequest.appendUserFeatureString(userFeatures);
// 一度に 1 つのユーザー特徴量を追加することもできます：
// easyrecRequest.addUserFeature(String userFeaName, T userFeaValue).
// 特徴値のデータ型 T は、String、float、long、または int です。

// contextFeatures: コンテキスト特徴量。特徴量は `\u0002` (CTRL_B) で区切られます。特徴量名とその値はコロン (:) で区切られます。同じ特徴量の複数の値もコロンで区切られます。
//   ctxt_fea0:ctxt_fea0_ival0:ctxt_fea0_ival1:ctxt_fea0_ival2\u0002ctxt_fea1:ctxt_fea1_ival0:ctxt_fea1_ival1:ctxt_fea1_ival2
easyrecRequest.appendContextFeatureString(contextFeatures);
// 一度に 1 つのコンテキスト特徴量を追加することもできます：
// easyrecRequest.addContextFeature(String ctxtFeaName, List<Object> ctxtFeaValue).
// ctxtFeaValue のデータ型は String、Float、Long、または Integer です。

// itemIdStr: 予測対象のアイテム ID リスト。カンマ (,) で区切られます。
easyrecRequest.appendItemStr(itemIdStr, ",");
// 一度に 1 つのアイテム ID を追加することもできます：
// easyrecRequest.appendItemId(String itemId)

easyrecPredictProtos.PBResponse response = client.predict(easyrecRequest);

for (Map.Entry<String, easyrecPredictProtos.Results> entry : response.getResultsMap().entrySet()) {
    String key = entry.getKey();
    easyrecPredictProtos.Results value = entry.getValue();
    System.out.print("key: " + key);
    for (int i = 0; i < value.getScoresCount(); i++) {
        System.out.format("value: %.6g\n", value.getScores(i));
    }
}

// FG 処理後の特徴量を取得して、オフラインの特徴量との一貫性を確認します。
// DebugLevel を 3 に設定して、生成された特徴量を返します。
easyrecRequest.setDebugLevel(3);
easyrecPredictProtos.PBResponse response = client.predict(easyrecRequest);
Map<String, String> genFeas = response.getGenerateFeaturesMap();
for(String itemId: genFeas.keySet()) {
    System.out.println(itemId);
    System.out.println(genFeas.get(itemId));
}

from eas_prediction import PredictClient

from eas_prediction.easyrec_request import EasyRecRequest
from eas_prediction.easyrec_predict_pb2 import PBFeature
from eas_prediction.easyrec_predict_pb2 import PBRequest

if __name__ == '__main__':
    endpoint = 'http://xxxxxxx.vpc.cn-hangzhou.pai-eas.aliyuncs.com'
    service_name = 'ali_rec_rnk_with_fg'
    token = '******'

    client = PredictClient(endpoint, service_name)
    client.set_token(token)
    client.init()

    req = PBRequest()
    uid = PBFeature()
    uid.string_feature = 'u0001'
    req.user_features['user_id'] = uid
    age = PBFeature()
    age.int_feature = 12
    req.user_features['age'] = age
    weight = PBFeature()
    weight.float_feature = 129.8
    req.user_features['weight'] = weight

    req.item_ids.extend(['item_0001', 'item_0002', 'item_0003'])
    
    easyrec_req = EasyRecRequest()
    easyrec_req.add_feed(req, debug_level=0)
    res = client.predict(easyrec_req)
    print(res)

import java.util.List;

import com.aliyun.openservices.eas.predict.http.PredictClient;
import com.aliyun.openservices.eas.predict.http.HttpConfig;
import com.aliyun.openservices.eas.predict.request.TFDataType;
import com.aliyun.openservices.eas.predict.request.TFRequest;
import com.aliyun.openservices.eas.predict.response.TFResponse;

public class TestEasyRec {
    public static TFRequest buildPredictRequest() {
        TFRequest request = new TFRequest();
 
        request.addFeed("user_id", TFDataType.DT_STRING, 
                        new long[]{3}, new String []{ "u0001", "u0001", "u0001"});
      	request.addFeed("age", TFDataType.DT_FLOAT, 
                        new long[]{3}, new float []{ 18.0f, 18.0f, 18.0f});
        // 注： INPUT_TILE=2 を設定した場合、同じ値を持つ特徴量については、値を一度だけ渡すだけで済みます：
        //    request.addFeed("user_id", TFDataType.DT_STRING,
        //            new long[]{1}, new String []{ "u0001" });
        //    request.addFeed("age", TFDataType.DT_FLOAT, 
        //            new long[]{1}, new float []{ 18.0f});
      	request.addFeed("item_id", TFDataType.DT_STRING, 
                        new long[]{3}, new String []{ "i0001", "i0002", "i0003"});  
        request.addFetch("probs");
      	return request;
    }

    public static void main(String[] args) throws Exception {
        PredictClient client = new PredictClient(new HttpConfig());

        // ダイレクトネットワーク接続を使用するには、setDirectEndpoint メソッドを使用します。例：
        //   client.setDirectEndpoint("pai-eas-vpc.cn-shanghai.aliyuncs.com");
        // EAS コンソールでダイレクトネットワーク接続を有効にし、EAS サービスへのアクセスに使用するソース vSwitch を指定する必要があります。
        // ダイレクトネットワーク接続は、より高い安定性とパフォーマンスを提供します。
        client.setEndpoint("xxxxxxx.vpc.cn-hangzhou.pai-eas.aliyuncs.com");
        client.setModelName("ali_rec_rnk_no_fg");
        client.setToken("");
        long startTime = System.currentTimeMillis();
        for (int i = 0; i < 100; i++) {
            try {
                TFResponse response = client.predict(buildPredictRequest());
                // "probs" はモデルの出力フィールドです。curl コマンドを使用して、モデルの入力と出力を確認できます：
                //   curl xxxxxxx.vpc.cn-hangzhou.pai-eas.aliyuncs.com -H "Authorization:{token}"
                List<Float> result = response.getFloatVals("probs");
                System.out.print("Predict Result: [");
                for (int j = 0; j < result.size(); j++) {
                    System.out.print(result.get(j).floatValue());
                    if (j != result.size() - 1) {
                        System.out.print(", ");
                    }
                }
                System.out.print("]\n");
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
        long endTime = System.currentTimeMillis();
        System.out.println("Spend Time: " + (endTime - startTime) + "ms");
        client.shutdown();
    }
}

#!/usr/bin/env python

from eas_prediction import PredictClient
from eas_prediction import StringRequest
from eas_prediction import TFRequest

if __name__ == '__main__':
    client = PredictClient('http://xxxxxxx.vpc.cn-hangzhou.pai-eas.aliyuncs.com', 'ali_rec_rnk_no_fg')
    client.set_token('')
    client.init()
    
    # 注： server_default をモデルの実際の signature_name に置き換えてください。詳細については、前述の SDK ガイドを参照してください。
    req = TFRequest('server_default') 
    req.add_feed('user_id', [3], TFRequest.DT_STRING, ['u0001'] * 3)
    req.add_feed('age', [3], TFRequest.DT_FLOAT, [18.0] * 3)
    # 注： INPUT_TILE=2 の最適化を有効にすると、先行する特徴量に対して単一の値を渡すことができます。
    #   req.add_feed('user_id', [1], TFRequest.DT_STRING, ['u0001'])
    #   req.add_feed('age', [1], TFRequest.DT_FLOAT, [18.0])
    req.add_feed('item_id', [3], TFRequest.DT_STRING, 
        ['i0001', 'i0002', 'i0003'])
    for x in range(0, 100):
        resp = client.predict(req)
        print(resp)

2.4 カスタムサービスリクエストの作成

Python と Java 以外の言語では、以下の .proto ファイルから予測リクエストコードを生成します。

• tf_predict.proto： TensorFlow モデルのリクエスト定義。

  syntax = "proto3";
  
  option cc_enable_arenas = true;
  option go_package = ".;tf";
  option java_package = "com.aliyun.openservices.eas.predict.proto";
  option java_outer_classname = "PredictProtos";
  
  enum ArrayDataType {
    // DataType の有効な値ではありません。DataType フィールドが設定されていないことを示すために使用されます。
    DT_INVALID = 0;
  
    // すべての計算デバイスでサポートされることが想定されるデータ型。
    DT_FLOAT = 1;
    DT_DOUBLE = 2;
    DT_INT32 = 3;
    DT_UINT8 = 4;
    DT_INT16 = 5;
    DT_INT8 = 6;
    DT_STRING = 7;
    DT_COMPLEX64 = 8;  // 単精度複素数
    DT_INT64 = 9;
    DT_BOOL = 10;
    DT_QINT8 = 11;     // 量子化 int8
    DT_QUINT8 = 12;    // 量子化 uint8
    DT_QINT32 = 13;    // 量子化 int32
    DT_BFLOAT16 = 14;  // 16 ビットに切り捨てられた Float32。キャスト操作専用。
    DT_QINT16 = 15;    // 量子化 int16
    DT_QUINT16 = 16;   // 量子化 uint16
    DT_UINT16 = 17;
    DT_COMPLEX128 = 18;  // 倍精度複素数
    DT_HALF = 19;
    DT_RESOURCE = 20;
    DT_VARIANT = 21;  // 任意の C++ データ型
  }
  
  // 配列の次元
  message ArrayShape {
    repeated int64 dim = 1 [packed = true];
  }
  
  // 配列を表すプロトコルバッファ
  message ArrayProto {
    // データ型。
    ArrayDataType dtype = 1;
  
    // 配列の形状。
    ArrayShape array_shape = 2;
  
    // DT_FLOAT。
    repeated float float_val = 3 [packed = true];
  
    // DT_DOUBLE。
    repeated double double_val = 4 [packed = true];
  
    // DT_INT32, DT_INT16, DT_INT8, DT_UINT8。
    repeated int32 int_val = 5 [packed = true];
  
    // DT_STRING。
    repeated bytes string_val = 6;
  
    // DT_INT64。
    repeated int64 int64_val = 7 [packed = true];
  
    // DT_BOOL。
    repeated bool bool_val = 8 [packed = true];
  }
  
  // PredictRequest は、実行する TensorFlow モデル、入力からテンソルへのマッピング方法、
  // およびユーザーに返される前の出力のフィルタリング方法を指定します。
  message PredictRequest {
    // 評価する名前付きシグネチャ。指定しない場合、デフォルトのシグネチャが使用されます。
    string signature_name = 1;
  
    // 入力テンソル。
    // 入力テンソルの名前はエイリアス名です。エイリアスから実際の
    // 入力テンソル名へのマッピングは、モデルエクスポートのキー "inputs" の下に
    // 名前付きジェネリックシグネチャとして保存されている必要があります。
    // "inputs" という名前のジェネリックシグネチャにリストされている各エイリアスは、
    // 予測を実行するためにそれぞれ正確に一度指定する必要があります。
    map<string, ArrayProto> inputs = 2;
  
    // 出力フィルター。
    // 指定された名前はエイリアス名です。エイリアスから実際の出力
    // テンソル名へのマッピングは、モデルエクスポートのキー "outputs" の下に
    // 名前付きジェネリックシグネチャとして保存されている必要があります。
    // ここで指定されたテンソルのみが実行・フェッチされて返されます。
    // ただし、何も指定されていない場合は、名前付きシグネチャで指定された
    // すべてのテンソルが実行・フェッチされて返されます。
    repeated string output_filter = 3;
    
    // デバッグフラグ
    // 0: 予測結果のみを返し、デバッグ情報は返しません。
    // 100: 予測結果を返し、リクエストを model_dir に保存します。
    // 101: タイムラインを model_dir に保存します。
    int32 debug_level = 100;
  }
  
  // 実行が成功した場合の PredictRequest へのレスポンス。
  message PredictResponse {
    // 出力テンソル。
    map<string, ArrayProto> outputs = 1;
  }

• easyrec_predict.proto： FG を使用する TensorFlow モデルのリクエスト定義。

  syntax = "proto3";
  
  option cc_enable_arenas = true;
  option go_package = ".;easyrec";
  option java_package = "com.aliyun.openservices.eas.predict.proto";
  option java_outer_classname = "EasyRecPredictProtos";
  
  import "tf_predict.proto";
  
  // コンテキスト特徴量
  message ContextFeatures {
    repeated PBFeature features = 1;
  }
  
  message PBFeature {
    oneof value {
      int32 int_feature = 1;
      int64 long_feature = 2;
      string string_feature = 3;
      float float_feature = 4;
    }
  }
  
  // PBRequest は、アグリゲーターへのリクエストを指定します。
  message PBRequest {
    // デバッグフラグ
    // 0: 予測結果のみを返し、デバッグ情報は返しません。
    // 3: FG モジュールによって生成された特徴量を返します。文字列形式で、特徴値は \u0002 で区切られます。
    //    特徴量の一貫性の確認や、オンラインでのディープラーニングサンプルの生成に使用できます。
    // 100: 予測結果を返し、リクエストを model_dir に保存します。
    // 101: タイムラインを model_dir に保存します。
    // 102: DSSM や MIND などのリコールモデルの場合、Faiss の検索結果だけでなく、
    //      ユーザーの埋め込みベクトルも返します。
    int32 debug_level = 1;
  
    // ユーザー特徴量
    map<string, PBFeature> user_features = 2;
  
    // アイテム ID です。静的な (毎日更新される) アイテム特徴量は、
    // item_ids に基づいて各プロセッサノードにある
    // 特徴量キャッシュからフェッチされます。
    repeated string item_ids = 3;
  
    // 各アイテムのコンテキスト特徴量です。リアルタイムのアイテム特徴量は
    //    コンテキスト特徴量として渡すことができます。
    map<string, ContextFeatures> context_features = 4;
  
    // 埋め込み検索の近傍数。
    int32 faiss_neigh_num = 5;
  }
  
  // 結果
  message Results {
    repeated double scores = 1 [packed = true];
  }
  
  enum StatusCode {
    OK = 0;
    INPUT_EMPTY = 1;
    EXCEPTION = 2;
  }
  
  // PBResponse は、アグリゲーターへのレスポンスを指定します。
  message PBResponse {
    // 結果
    map<string, Results> results = 1;
  
    // アイテム特徴量
    map<string, string> item_features = 2;
  
    // FG によって生成された特徴量
    map<string, string> generate_features = 3;
  
    // コンテキスト特徴量
    map<string, ContextFeatures> context_features = 4;
  
    string error_msg = 5;
  
    StatusCode status_code = 6;
  
    // アイテム ID
    repeated string item_ids = 7;
  
    repeated string outputs = 8;
  
    // すべての FG 入力特徴量
    map<string, string> raw_features = 9;
  
    // 出力テンソル
    map<string, ArrayProto> tf_outputs = 10;
  }