エンティティの操作

注釈

Snowflake Feature Store API は、Snowpark ML Pythonパッケージ（snowflake-ml-python）v1.5.0以降で利用可能です。

エンティティは、ユーザーが必要なフィーチャービューをより簡単に見つけることができるように、主題ごとにフィーチャービューを整理します。例えば、動画ストリーミングサービスのフィーチャーストアは、ユーザーと映画のエンティティを定義する場合があります。フィーチャーストアの各フィーチャービューには、映画関連、ユーザー関連、またはその両方のタグが付けられており、これらのエンティティに関連するフィーチャービューのリストを取得することができます。

エンティティは、フィーチャービューを整理するのに役立つだけでなく、抽出されたフィーチャを元のデータに結合するために使用できる主要な列の名前を格納します。

エンティティの作成

新しいエンティティを作成してフィーチャーストアに登録するには、フィーチャーストアの register_entity メソッドを使用します。ここで、 fs はフィーチャーストアのインスタンスです（ フィーチャーストアの作成と接続 をご参照ください）。

from snowflake.ml.feature_store import Entity

entity = Entity(
    name="MY_ENTITY",
    join_keys=["UNIQUE_ID"],
    desc="my entity"
)
fs.register_entity(entity)
Copy

エンティティの一覧表示

フィーチャーストアに登録されているすべてのエンティティを確認するには、フィーチャーストアの list_entities メソッドを使用します。このメソッドはSnowpark DataFrame を返します。 (fs がフィーチャストアインスタンス、 フィーチャーストアの作成と接続 をご参照ください)

fs.list_entities().show()
Copy

エンティティの取得

get_entity メソッドを使用して、以前に登録したエンティティを取得できます。例えば、その結合キーを取得するなどです。

entity = fs.get_entity(name="MY_ENTITY")
print(entity.join_keys)
Copy

アラートの変更

エンティティの説明を更新するには、フィーチャーストアの update_entity メソッドを使用します：

fs.update_entity(
    name="MY_ENTITY",
    desc="NEW DESCRIPTION"
)
Copy

結合キーなど、エンティティの他の側面は不変です。これらを変更するには、新しいエンティティを作成します。

エンティティの削除

エンティティを削除するには、フィーチャーストアの delete_entity メソッドを使用します。

fs.delete_entity(name="MY_ENTITY")
Copy

どのフィーチャービューからも参照されているエンティティは削除できません。

既知の制限

言語: 日本語