Snowflake Data Clean Rooms : enregistrer un modèle d’API du développeur dans l’application Web¶
Cette rubrique décrit comment un fournisseur peut créer et partager de manière programmatique une salle blanche avec un consommateur tout en fournissant une interface utilisateur que le consommateur peut utiliser pour exécuter une analyse dans l”application Web. Il est similaire au [flux de machine learning](machine learning), mais démontre comment fournir au consommateur une interface utilisateur pour un workflow de machine learning autrement complexe. Une fois que le fournisseur a enregistré la salle blanche dans l’application Web, le consommateur n’a pas besoin d’utiliser Snowsight ou les APIs du développeur, ce qui permet aux consommateurs non techniques d’utiliser une salle blanche personnalisée et complexe.
Un fournisseur peut enregistrer plusieurs modèles personnalisés pour une salle blanche, chacun d’entre eux apparaîtra dans l’application Web pour le consommateur. Le fournisseur appelle simplement les APIs connexes plusieurs fois.
Ce flux couvre les éléments suivants :
Fournisseur :
a. Ajoutez un modèle personnalisé exécutant une analyse de modélisation Lookalike.
b. Ajoutez en toute sécurité des modèles basés sur du code python de machine learning en tirant parti de XGBoost.
c. Appelez des UDFs de machine learning à l’intérieur de la salle blanche à l’aide du modèle personnalisé.
d. Enregistrez la salle blanche dans l’application Web avec un formulaire UI personnalisé.
Consommateur :
a. Utilisez l’application Web pour installer la salle blanche et y effectuer des analyses.
Note
La Modélisation Lookalike est un type d’analyse dans lequel un consommateur tente de trouver des clients « high value » à partir des données d’un fournisseur en entraînant un modèle statistique sur leurs clients à forte valeur (high value). Ce modèle utilise des indicateurs spécifiés par les consommateurs pour indiquer les utilisateurs à forte valeur (high value), tels que ceux dont les dépenses dépassent un certain seuil, dans l’ensemble de données du consommateur. Le modèle entraîné est ensuite utilisé pour déduire quels clients dans les données du fournisseur pourraient potentiellement être de type « high value » pour le consommateur.
Conditions préalables¶
Vous avez besoin de deux comptes Snowflake distincts pour réaliser ce flux. Utilisez le premier compte pour exécuter les commandes fournisseur, puis passez au second compte pour exécuter les commandes consommateur.
Fournisseur¶
Utilisez une feuille de calcul Snowflake dans le compte du fournisseur pour exécuter les commandes de cette section.
Mise en place de l’environnement¶
Avant d’utiliser les APIs du développeur, vous devez assumer le rôle SAMOOHA_APP_ROLE et spécifier l’entrepôt utilisé pour exécuter les APIs. Si vous n’avez pas le rôle SAMOOHA_APP_ROLE, contactez votre administrateur de compte.
Exécutez les commandes suivantes pour configurer votre environnement :
USE ROLE samooha_app_role;
USE WAREHOUSE app_wh;
Créer la salle blanche¶
Avant de créer une salle blanche, vous devez spécifier un nom alphanumérique pour la salle blanche. Le nom ne peut pas contenir de caractères spéciaux, à l’exception des espaces et des traits de soulignement. Veillez à ce que le nom de la salle blanche ne vienne pas dupliquer une salle blanche existante.
Pour spécifier le nom de la salle blanche, exécutez la commande suivante :
SET cleanroom_name = 'UI Registration ML Clean room';
Vous êtes maintenant prêt à exécuter la commande provider.cleanroom_init pour créer la salle blanche. Le deuxième argument définit la distribution de la salle blanche. Dans cet exemple, vous choisirez INTERNAL pour contourner l’analyse de sécurité automatisée qui a lieu avant que la salle blanche puisse être publiée aux collaborateurs. Les comptes du fournisseur et du consommateur doivent faire partie de la même organisation pour utiliser la méthode de distribution INTERNAL. Pour les salles blanches distribuées à un compte dans une autre organisation, vous devez utiliser une distribution EXTERNAL.
Pour créer la salle blanche, exécutez la commande suivante :
CALL samooha_by_snowflake_local_db.provider.cleanroom_init($cleanroom_name, 'INTERNAL');
Après avoir créé une salle blanche, vous devez définir sa directive de version avant de pouvoir la partager avec un collaborateur.
Note
Lorsque vous définissez la distribution d’une salle blanche sur EXTERNAL, vous devez attendre la fin de l’analyse de sécurité avant de définir la directive de version. Vous pouvez voir le statut de l’analyse de sécurité en exécutant :
CALL samooha_by_snowflake_local_db.provider.view_cleanroom_scan_status($cleanroom_name);
Vous pouvez continuer à exécuter des commandes pendant l’analyse de sécurité à condition de définir la directive de version avant d’essayer d’exécuter la commande provider.create_cleanroom_listing.
Pour définir la directive de version pour la salle blanche, exécutez la commande suivante :
CALL samooha_by_snowflake_local_db.provider.set_default_release_directive($cleanroom_name, 'V1_0', '0');
Partage interrégional¶
Pour partager une salle blanche avec un client de Snowflake dont le compte se trouve dans une région différente de votre compte, vous devez activer [l’exécution automatique inter-Cloud] (https://other-docs.snowflake.com/fr/collaboration/provider-listings-auto-fulfillment). Pour des informations sur les coûts supplémentaires liés à la collaboration avec des consommateurs d’autres régions, voir Coûts de l’exécution automatique inter-Cloud.
Lorsque vous utilisez les APIs du développeur, l’activation du partage interrégional se fait en deux étapes :
Un administrateur Snowflake ayant le rôle ACCOUNTADMIN active l’exécution automatique inter-Cloud pour votre compte Snowflake. Pour plus d’informations, voir Collaborer avec des comptes situés dans des régions différentes.
Vous exécutez la commande provider.enable_laf_for_cleanroom pour activer l’exécution automatique inter-Cloud pour la salle blanche. Par exemple :
CALL samooha_by_snowflake_local_db.provider.enable_laf_for_cleanroom($cleanroom_name);
Après avoir activé l’exécution automatique inter-Cloud pour la salle blanche, vous pouvez ajouter des consommateurs à votre annonce comme d’habitude à l’aide de la commande provider.create_cleanroom_listing. L’annonce est automatiquement répliquée vers des cloud et des régions distantes, selon les besoins.
Liez l’ensemble de données et définissez la politique de jointure pour l’ensemble de données¶
Liez les tables Snowflake à la salle blanche, parcourez la liste des tables de votre compte Snowflake et saisissez les noms de table entièrement qualifiés (Database.Schema.Table) sous la forme d’un tableau. La procédure rend automatiquement la table accessible à la salle blanche en créant une vue sécurisée de la table depuis l’intérieur de la salle blanche, évitant ainsi tout besoin de faire une copie de votre table.
CALL samooha_by_snowflake_local_db.provider.link_datasets($cleanroom_name, ['samooha_provider_sample_database.lookalike_modeling.customers']);
Note
Si cette étape ne fonctionne pas alors que votre table existe, il est probable que le rôle SAMOOHA_APP_ROLE n’ait pas encore reçu l’accès à cette table. Si c’est le cas, passez au rôle ACCOUNTADMIN, appelez la procédure ci-dessous sur la base de données, puis repassez au rôle suivant pour le reste du flux :
USE ROLE accountadmin;
CALL samooha_by_snowflake_local_db.provider.register_db('<DATABASE_NAME>');
USE ROLE samooha_app_role;
Vous pouvez voir les noms des ensembles de données liés à la salle blanche en appelant la procédure suivante.
CALL samooha_by_snowflake_local_db.provider.view_provider_datasets($cleanroom_name);
Vous pouvez voir les ensembles de données liés à la salle blanche en suivant la procédure suivante :
SELECT * FROM <PROVIDER_TABLE> LIMIT 10;
Indiquez quelles colonnes le consommateur est autorisé à joindre lors de l’exécution de modèles dans la salle blanche. Cette procédure doit être appelée sur les colonnes d’identité comme l’adresse e-mail. La politique de jointure est de type « remplacement uniquement », donc si la fonction est appelée à nouveau, la politique de jointure précédemment définie est entièrement remplacée par la nouvelle.
CALL samooha_by_snowflake_local_db.provider.set_join_policy($cleanroom_name, ['samooha_provider_sample_database.lookalike_modeling.customers:hashed_email']);
Si vous souhaitez voir toutes les colonnes pour décider des colonnes de la politique de jointure, appelez la procédure suivante.
CALL samooha_by_snowflake_local_db.provider.view_join_policy($cleanroom_name);
Ajouter du code Python confidentiel de machine learning à la salle blanche¶
Chargez quelques fonctions python dans la salle blanche pour le travail ML Lookalike. Toutes les fonctions python installées dans la salle blanche restent totalement confidentielles. Le consommateur ne peut pas les voir.
L’API suivante vous permet de définir vos fonctions Python directement en tant que fonctions en ligne dans la salle blanche. Vous pouvez également charger Python à partir de fichiers en zone de préparation que vous avez chargés dans la zone de préparation de la salle blanche. Voir le Guide de référence de l’API pour un exemple.
Note
Notez que cette mise en œuvre est limitée par la contrainte de taille totale de Snowflake sur la quantité de données qui peuvent être agrégées par ARRAY_AGG (c’est-à-dire 16MB). Une mise en œuvre tirant parti de la mise en lots et des modèles de flux qui peut s’étendre à des ensembles de données de taille arbitraire grâce à la mise en lots est disponible sur demande.
CALL samooha_by_snowflake_local_db.provider.load_python_into_cleanroom(
$cleanroom_name,
'lookalike_train',
['input_data variant', 'labels variant'],
['pandas', 'numpy', 'xgboost'],
'variant',
'train',
$$
import numpy as np
import pandas as pd
import xgboost
from sklearn import preprocessing
import sys
import os
import pickle
import codecs
import threading
class TrainXGBoostClassifier(object):
def __init__(self):
self.model = None
self._params = {
"objective": "binary:logistic",
"max_depth": 3,
"nthread": 1,
"eval_metric": "auc",
}
self.num_boosting_rounds = 10
def get_params(self):
if self.model is not None and "updater" not in self._params:
self._params.update(
{"process_type": "update", "updater": "refresh", "refresh_leaf": True}
)
return self._params
def train(self, X, y):
# Train the model in a threadsafe way
# pick only the categorical attributes
categorical = X.select_dtypes(include=[object])
# fit a one-hot-encoder to convert categorical features to binary features (required by XGBoost)
ohe = preprocessing.OneHotEncoder()
categorical_ohe = ohe.fit_transform(categorical)
self.ohe = ohe
# get the rest of the features and add them to the binary features
non_categorical = X.select_dtypes(exclude=[object])
train_x = np.concatenate((categorical_ohe.toarray(), non_categorical.to_numpy()), axis=1)
xg_train = xgboost.DMatrix(train_x, label=y)
params = self.get_params()
params["eval_metric"] = "auc"
evallist = [(xg_train, "train")]
evals_result = {}
self.model = xgboost.train(
params, xg_train, self.num_boosting_rounds, evallist, evals_result=evals_result
)
self.evals_result = evals_result
def __dump_model(self, model):
# Save down the model as a json string to load up for scoring/inference
pickle_jar = codecs.encode(pickle.dumps([model, self.ohe]), "base64").decode()
return pickle_jar
def dump_model(self):
# Save down the model as a json string to load up for scoring/inference
if self.model is not None:
return self.__dump_model(self.model)
else:
raise ValueError("Model needs to be trained first")
def train(d1, l1):
# get take training features and put them in a pandas dataframe
X = pd.DataFrame(d1)
# get the labels into a Numpy array
y = np.array(l1)
trainer = TrainXGBoostClassifier()
trainer.train(X, y)
# return training stats, accuracy, and the pickled model and pickled one-hot-encoder
return {
"total_rows": len(d1),
"total_bytes_in": sys.getsizeof(d1),
"model": trainer.dump_model(),
"iteration": trainer.num_boosting_rounds,
"auc": np.max(trainer.evals_result["train"]["auc"]),
"error": 1 - np.max(trainer.evals_result["train"]["auc"])
}
$$);
Installez maintenant une fonction de notation dans la salle blanche :
CALL samooha_by_snowflake_local_db.provider.load_python_into_cleanroom(
$cleanroom_name,
'lookalike_score',
['pickle_jar variant', 'emails variant', 'features variant'],
['pandas', 'numpy', 'xgboost', 'scikit-learn'],
'string',
'score',
$$
import numpy as np
import pandas as pd
import xgboost as xgb
import pickle
import codecs
import json
def score(model, emails, features):
# load model
model = model[0] if not isinstance(model, str) else model
model = pickle.loads(codecs.decode(model.encode(), "base64"))
# retrieve the XGBoost trainer from the pickle jar
bst = model[0]
# retrieve the fitted one-hot-encoder from the pickle jar
ohe2 = model[1]
# create pandas dataframe from the inference features
Y = pd.DataFrame(features)
# select the categorical attributes and one-hot-encode them
Y1 = Y.select_dtypes(include=[object])
Y2 = ohe2.transform(Y1)
# select the non-categorical attributes
Y3 = Y.select_dtypes(exclude=[object])
# join the results of the one-hot encoding to the rest of the attributes
Y_pred = np.concatenate((Y2.toarray(), Y3.to_numpy()), axis=1)
# inference
dscore = xgb.DMatrix(Y_pred)
pred = bst.predict(dscore)
retval = list(zip(np.array(emails), list(map(str, pred))))
retval = [{"email": r[0], "score": r[1]} for r in retval]
return json.dumps(retval)
$$);
Note
Le chargement de Python dans la salle blanche crée un nouveau correctif pour la salle blanche. Si la distribution de votre salle blanche est définie sur EXTERNAL, vous devez attendre la fin de l’analyse de sécurité, puis mettre à jour la directive de version par défaut à l’aide de :
-- See the versions available inside the cleanroom
SHOW VERSIONS IN APPLICATION PACKAGE samooha_cleanroom_UI_Registration_ML_clean_room;
-- Once the security scan is approved, update the release directive to the latest version
CALL samooha_by_snowflake_local_db.provider.set_default_release_directive($cleanroom_name, 'V1_0', '2');
Ajouter un modèle de modélisation Lookalike personnalisé¶
Pour ajouter un modèle d’analyse personnalisé à la salle blanche, vous avez besoin d’un espace réservé pour les noms des tables, tant du côté du fournisseur que du côté du consommateur, ainsi que des colonnes de jointure du côté du fournisseur. Dans les modèles SQL Jinja, ces espaces réservés doivent toujours être :
source_table : un tableau de noms de tables du fournisseur
my_table : un tableau de noms de tables du consommateur
Les noms des tables peuvent être rendus dynamiques par l’utilisation de ces variables, mais ils peuvent également être codés en dur dans le modèle si vous le souhaitez en utilisant le nom de la vue liée à la salle blanche. Les noms des colonnes peuvent être codés en dur dans le modèle, si vous le souhaitez, ou définis dynamiquement par le biais de paramètres. S’ils sont définis par des paramètres, rappelez-vous que vous devez appeler les paramètres dimensions ou measure_column, qui doivent être des tableaux, pour qu’ils soient vérifiés par rapport à la politique de colonne. Vous les ajoutez en tant que paramètres SQL Jinja dans le modèle, qui seront transmis ultérieurement par le consommateur lors de la requête. Les politiques de jointure garantissent que le consommateur ne peut pas effectuer de jointure sur des colonnes autres que celles qui sont autorisées.
Il est également possible de vérifier la conformité de tout argument d’un modèle SQL Jinja personnalisé avec les politiques de jointure et de colonne à l’aide des filtres suivants :
join_policy : vérifie si une valeur de chaîne ou une clause de filtre est conforme à la politique de jointure
politique_de_colonne : vérifie si une valeur de chaîne ou une clause de filtrage est conforme à la politique de colonne
join_and_column_policy : vérifie que les colonnes utilisées pour une jointure dans une clause de filtrage sont conformes à la politique de jointure et que les colonnes utilisées comme filtre sont conformes à la politique de colonne.
Par exemple, dans la clause {{ provider_id | sqlsafe | join_policy }}, une entrée p.HEM sera analysée pour vérifier si p.HEM figure dans la politique de jointure. Remarque : n’utilisez le filtre sqlsafe qu’avec précaution, car il permet aux collaborateurs d’introduire du code SQL pur dans le modèle.
Note
Toutes les tables fournisseur/consommateur doivent être référencées à l’aide de ces arguments, car le nom de la vue sécurisée effectivement liée à la salle blanche sera différent du nom de la table. Il est essentiel que les alias de table de fournisseurs doivent être p (ou p1), p2, p3, p4, etc., et que les alias de table de consommateurs doivent être c (ou c1), c2, c3, etc. C’est nécessaire pour appliquer les politiques de sécurité dans la salle blanche.
Notez que cette fonction remplace tout modèle existant portant le même nom. Si vous souhaitez mettre à jour un modèle existant, il vous suffit de rappeler cette fonction avec le modèle mis à jour.
Un ensemble de fonctions est sélectionné dans l’ensemble de données du fournisseur et un ensemble d’étiquettes est sélectionné dans l’ensemble de données du consommateur, ainsi qu’un indicateur « high value » (appelé valeur_étiquette). Ces deux tables sont ensuite jointes sur l’e-mail et transmises à l’algorithme d’entraînement de la forêt d’arbres décisionnels. Enfin, le résultat de l’étape d’entraînement des modèles est transmis à une fonction d’inférence, qui utilise le modèle entraîné pour « déduire » lesquels des clients fournisseurs qui ne sont pas dans les ensembles de données consommateurs pourraient être de type « high value ». Le nombre de ces personnes est alors retourné, ainsi que l’erreur de modèle.
Le seuil permettant de déterminer le score au-delà duquel un client est « likely high value » est fixé manuellement dans le modèle à 0,5. Ceci peut être facilement modifié lors de l’ajout du modèle à la salle blanche.
CALL samooha_by_snowflake_local_db.provider.add_custom_sql_template($cleanroom_name, 'prod_custom_lookalike_template',
$$
WITH
features AS (
SELECT
identifier({{ provider_join_col | join_policy }}) AS joincol,
array_construct({{ dimensions[0] | sqlsafe }} {% for feat in dimensions[1:] %} , {{ feat | sqlsafe }} {% endfor %}) AS features
FROM
identifier({{ source_table[0] }}) AS p
),
labels AS (
SELECT
c.{{ consumer_join_col | sqlsafe }} AS joincol,
c.{{ filter_column | default('SALES_DLR') | sqlsafe }} {{ operator | default('>=') | sqlsafe }} {{ filter_value | default(2000) | sqlsafe }} AS label_value
FROM
identifier({{ my_table[0] }}) AS c
),
trained_model AS (
SELECT
train_out:model::varchar AS model,
train_out:error::float AS error
FROM (
SELECT
cleanroom.{{ lookalike_train_function | default('lookalike_train') | sqlsafe }}(array_agg(f.features), array_agg(l.label_value)) AS train_out
FROM features f, labels l
WHERE f.joincol = l.joincol
)
),
inference_output AS (
SELECT
MOD(seq4(), 100) AS batch,
cleanroom.{{ lookalike_score_function | default('lookalike_score') | sqlsafe }}(
array_agg(distinct t.model),
array_agg(identifier({{ provider_join_col | join_policy }})),
array_agg(array_construct( identifier({{ dimensions[0] }}) {% for feat in dimensions[1:] %} , identifier({{ feat }}) {% endfor %}) )
) AS scores
FROM trained_model t, identifier({{ source_table[0] }}) p
WHERE identifier({{ provider_join_col | join_policy }}) NOT IN (SELECT c.{{ consumer_join_col | sqlsafe }} FROM identifier({{ my_table[0] }}) c)
GROUP BY batch
),
processed_output AS (
SELECT value:email::string as id, value:score::float AS score FROM (select scores from inference_output), lateral flatten(input => parse_json(scores))
), train_results AS (
SELECT {{ num_boosting_rounds | sqlsafe }} AS num_boosting_rounds, {{ trim_extremes | sqlsafe }} AS trim_extremes, p.audience_size AS audience_size, t.error AS error FROM (SELECT count(distinct id) AS audience_size FROM processed_output WHERE score > 0.5) p, trained_model t
), seed_size AS (
select count(*) AS seed_audience_size FROM features f, labels l WHERE f.joincol = l.joincol
)
SELECT s.seed_audience_size, t.audience_size AS num_lookalikes_found, t.error FROM train_results t, seed_size s
$$);
Note
Vous pouvez ajouter la sensibilité à la confidentialité différentielle à l’appel de procédure samooha_by_snowflake_local_db.provider.add_custom_sql_template ci-dessus en tant que dernier paramètre. Si vous ne l’ajoutez pas, la valeur par défaut est 1.
Si vous voulez voir les modèles qui sont actuellement actifs dans la salle blanche, appelez la procédure suivante. Vous pouvez apporter les modifications nécessaires pour activer les garanties de confidentialité différentielle sur votre analyse. Un modèle similaire peut être incorporé dans tout modèle personnalisé que vous choisissez de rédiger.
CALL samooha_by_snowflake_local_db.provider.view_added_templates($cleanroom_name);
Définir la politique des colonnes pour chaque table¶
Affichez les données liées pour voir les colonnes présentes dans la table. Pour voir les 10 premières lignes, appelez la procédure suivante.
SELECT * FROM <PROVIDER_TABLE> LIMIT 10;
Définissez les colonnes sur lesquelles vous souhaitez effectuer des regroupements, des agrégations (par exemple SUM/AVG) et, d’une manière générale, utiliser une analyse pour chaque combinaison de table et de modèle. Cela offre une certaine souplesse, de sorte qu’une même table peut permettre différentes sélections de colonnes en fonction du modèle sous-jacent. Cette fonction ne doit être appelée qu’après l’ajout du modèle.
Notez que la politique de colonnes est remplacement uniquement, donc si la fonction est appelée à nouveau, la politique de colonnes précédemment définie est complètement remplacée par la nouvelle.
La politique de colonnes ne doit pas être utilisée pour les colonnes d’identité telles que l’adresse e-mail, HEM, RampID, car vous ne souhaitez pas que le consommateur puisse effectuer des groupes en fonction de ces colonnes. Dans l’environnement de production, le système déduit intelligemment les colonnes PII et bloque cette opération, mais cette fonction n’est pas disponible dans l’environnement sandbox. Elle ne doit être utilisée que pour les colonnes par lesquelles vous souhaitez que le consommateur puisse faire des agrégations et des groupes, comme le statut, la tranche d’âge, le code de région, le nombre de jours d’activité, etc.
Notez que pour que les « column_policy » et « join_policy » effectuent des contrôles sur les requêtes d’analyse des consommateurs, il faut faire référence à tous les noms de colonnes en tant que dimensions ou measure_columns dans le modèle SQL Jinja. Veillez à utiliser ces balises pour faire référence aux colonnes que vous souhaitez vérifier dans les modèles personnalisés SQL Jinja.
CALL samooha_by_snowflake_local_db.provider.set_column_policy($cleanroom_name, [
'prod_custom_lookalike_template:samooha_provider_sample_database.lookalike_modeling.customers:status',
'prod_custom_lookalike_template:samooha_provider_sample_database.lookalike_modeling.customers:age',
'prod_custom_lookalike_template:samooha_provider_sample_database.lookalike_modeling.customers:region_code',
'prod_custom_lookalike_template:samooha_provider_sample_database.lookalike_modeling.customers:days_active',
'prod_custom_lookalike_template:samooha_provider_sample_database.lookalike_modeling.customers:income_bracket'
]);
Si vous souhaitez voir la politique de colonnes qui a été ajoutée à la salle blanche, appelez la procédure suivante.
CALL samooha_by_snowflake_local_db.provider.view_column_policy($cleanroom_name);
Enregistrer une salle blanche avec l’application Web¶
Maintenant que la salle blanche a été partagée avec le consommateur, vous pouvez enregistrer le modèle personnalisé afin qu’il soit disponible pour le consommateur dans l’application Web. Cela signifie que le consommateur peut exécuter des analyses personnalisées, y compris celles soutenues par un code de machine learning complexe, par le biais d’une interface utilisateur sans avoir besoin de recourir à des APIs du développeur.
L’enregistrement d’une salle blanche pour que le consommateur puisse y accéder dans l’application Web se fait en trois étapes. Vous devez procéder comme suit :
Appelez la commande provider.add_ui_form_customizations pour définir la manière dont le modèle apparaît dans l’application Web.
Appelez la commande provider.register_cleanroom_in_ui pour enregistrer le modèle.
Connectez-vous sur le Web en tant que fournisseur.
Création de l’interface utilisateur du modèle¶
La commande provider.add_ui_form_customizations définit la manière dont le modèle de la salle blanche apparaît dans l’application Web. Pour une description complète des personnalisations que vous pouvez utiliser pour concevoir l’interface utilisateur, consultez la section Méthodes d’enregistrement d’UI de la salle blanche de la référence d’API du fournisseur.
Note
Vous pouvez de façon facultative utiliser la personnalisation warehouse_hints
pour contrôler le type d”[entrepôt] (https://docs.snowflake.com/fr/user-guide/warehouses-overview) que le compte consommateur utilisera pour effectuer des analyses. Par exemple, pour la plupart des cas d’utilisation du machine learning, Snowflake recommande de spécifier un [entrepôt optimisé par Snowpark] (https://docs.snowflake.com/fr/user-guide/warehouses-snowpark-optimized). Pour connaître les valeurs valables pour warehouse_size
, voir CREATE WAREHOUSE.
Pour cet exemple, exécutez la commande provider.add_ui_form_customizations avec les personnalisations suivantes :
CALL samooha_by_snowflake_local_db.provider.add_ui_form_customizations(
$cleanroom_name,
'prod_custom_lookalike_template',
{
'display_name': 'Custom Lookalike Template',
'description': 'Use our customized ML techniques to find lookalike audiences.',
'methodology': 'Specify your own seed audience, while matching against our users. Then customize the lookalike model across number of boosting rounds and removing outliers.',
'warehouse_hints': {
'warehouse_size': 'medium',
'snowpark_optimized': TRUE
}
},
{
'num_boosting_rounds': {
'display_name': 'Number of Boosting Rounds',
'type': 'integer',
'default': 10,
'order': 7,
'description': 'How many rounds of boosting should the model do?',
'size': 'M',
'group': 'Training & Inference Configuration'
},
'trim_extremes': {
'display_name': 'Trim Extremes',
'type': 'boolean',
'default': False,
'order': 8,
'description': 'Remove outliers by default?',
'size': 'M',
'group': 'Training & Inference Configuration'
},
'lookalike_train_function': {
'display_name': 'Training Function',
'choices': ['lookalike_train'],
'type': 'dropdown',
'order': 9,
'description': 'Which function do you want to use for training?',
'size': 'M',
'group': 'Training & Inference Configuration'
},
'lookalike_score_function': {
'display_name': 'Scoring Function',
'choices': ['lookalike_score'],
'type': 'dropdown',
'order': 10,
'description': 'Which function do you want to use for scoring?',
'size': 'M',
'group': 'Training & Inference Configuration'
},
'provider_join_col': {
'display_name': 'Provider Join Column',
'choices': ['p.HASHED_EMAIL'],
'type': 'dropdown',
'order': 4,
'description': 'Select the provider column to join users on.',
'infoMessage': 'We recommend using HASHED_EMAIL.',
'size': 'M',
'group': 'Enable Provider Features'
},
'consumer_join_col': {
'display_name': 'Consumer Join Column',
'description': 'Specify column in your table that matches the providers (i.e. HASHED_EMAIL).',
'size': 'M',
'default': 'HASHED_EMAIL',
'infoMessage': 'We recommend using HASHED_EMAIL.',
'order': 5,
'group': 'Enable Provider Features'
},
'dimensions': {
'display_name': 'Feature Selection',
'choices': ['p.STATUS', 'p.AGE', 'p.REGION_CODE', 'p.DAYS_ACTIVE'],
'type': 'multiselect',
'order': 6,
'description': 'What features do you want to train on?',
'infoMessage': 'We recommend selecting all features for maximum signal.',
'size': 'M',
'group': 'Enable Provider Features'
},
'filter_column': {
'display_name': 'Filter Column',
'type': 'any',
'order': 1,
'description': 'Specify column in your table to filter for high value users (i.e. SALES_DLR)',
'size': 'S',
'default': 'SALES_DLR',
'infoMessage': 'We recommend you input SALES_DLR over here.',
'group': 'Seed Audience Selection'
},
'operator': {
'display_name': 'Operator',
'choices': ['>=', '=', '<='],
'type': 'dropdown',
'order': 2,
'description': 'What is the operator your want to use for the filter?',
'size': 'S',
'group': 'Seed Audience Selection'
},
'filter_value': {
'display_name': 'Filter Value',
'order': 3,
'description': 'What value do you want to filter to?',
'default': 2000,
'size': 'S',
'group': 'Seed Audience Selection'
}
}, {
'measure_columns': ['seed_audience_size', 'audience_size', 'num_lookalikes_found', 'error'],
'default_output_type': 'BAR'
});
Enregistrer le modèle¶
Après avoir défini l’apparence du modèle dans l’application Web, exécutez la commande provider.register_cleanroom_in_ui pour enregistrer le modèle afin qu’il devienne disponible dans l’environnement de salle blanche du consommateur.
La commande provider.register_cleanroom_in_ui accepte les arguments suivants :
Nom de la salle blanche.
Nom du modèle.
Compte du consommateur avec lequel la salle blanche est partagée.
Adresse e-mail d’un utilisateur de l’application Web dans l’environnement de la salle blanche du consommateur. Snowflake utilise l’adresse e-mail à des fins de vérification.
Note
La commande provider.register_cleanroom_in_ui, contrairement aux commandes provider.add_consumers et provider.create_cleanroom_listing, a besoin de l’identificateur complet du compte du consommateur, spécifié sous le format LOCATOR.REGION.CLOUD
. Pour obtenir des informations sur la recherche de cet identificateur de compte, voir [Utiliser un localisateur de compte comme identificateur] (https://docs.snowflake.com/fr/user-guide/admin-account-identifier#using-an-account-locator-as-an-identifier).
Les exemples incluent :
ABC01234.us-west-2.aws
XYZ01234.us-east-1.aws
MNO01234.west-us-2.azure
Pour enregistrer le modèle prod_custom_lookalike_template
que vous avez créé dans cet exemple, exécutez la commande suivante :
CALL samooha_by_snowflake_local_db.provider.register_cleanroom_in_ui($cleanroom_name, 'prod_custom_lookalike_template', '<CONSUMER_ACCOUNT_IDENTIFIER>', '<CONSUMER_USER_EMAIL>');
Pour consulter les demandes d’enregistrement précédentes, exécutez la commande suivante :
CALL samooha_by_snowflake_local_db.provider.view_ui_registration_request_log();
Connectez-vous à l’application Web.¶
Après avoir exécuté la commande provider.register_cleanroom_in_ui, le fournisseur doit se connecter à l’application Web pour terminer le processus d’enregistrement. Jusqu’à ce que vous vous connectiez à l’application Web en tant que fournisseur, la requête reste dans l’état « PENDING ». Pour vous connecter à l’application Web, voir [Snowflake Data Clean Room : application Web] (https://docs.snowflake.com/user-guide/cleanrooms/web-app-introduction).
Méthodes d’aide¶
Plusieurs localisateurs de comptes de consommateurs peuvent être transmis à la fonction provider.add_consumers sous la forme d’une chaîne séparée par des virgules ou sous la forme d’appels distincts à provider.add_consumers.
Si vous souhaitez voir les consommateurs qui ont été ajoutés à cette salle blanche, appelez la procédure suivante.
CALL samooha_by_snowflake_local_db.provider.view_consumers($cleanroom_name);
Si vous souhaitez voir les salles blanches qui ont été créées récemment, utilisez la procédure suivante.
CALL samooha_by_snowflake_local_db.provider.view_cleanrooms();
Si vous souhaitez obtenir plus d’informations sur la salle blanche que vous avez créée, suivez la procédure suivante.
CALL samooha_by_snowflake_local_db.provider.describe_cleanroom($cleanroom_name);
Toute salle blanche créée peut également être supprimée. La commande suivante supprime entièrement la salle blanche, de sorte que les consommateurs qui avaient auparavant accès à la salle blanche ne pourront plus l’utiliser. Si une salle blanche portant le même nom est souhaitée à l’avenir, elle doit être réinitialisée à l’aide du flux ci-dessus.
CALL samooha_by_snowflake_local_db.provider.drop_cleanroom($cleanroom_name);
Flux de consommateurs¶
La salle blanche que vous venez de créer en tant que fournisseur est désormais disponible dans l’application Web dans l’environnement de la salle blanche du consommateur.
Note
Vous pouvez continuer à modifier le formulaire d’UI dans le compte du fournisseur, puis voir les changements dans l’environnement de la salle blanche du consommateur en temps réel.
Accéder au compte du consommateur sur l’application Web¶
Pour se connecter à la salle blanche en tant que consommateur :
Connectez-vous à l’application Web de la Snowflake Data Clean Room. Pour plus d’informations, voir [Snowflake Data Clean Room : application Web] (https://docs.snowflake.com/user-guide/cleanrooms/web-app-introduction).
Saisissez votre adresse e-mail et sélectionnez Continuer.
Entrez votre mot de passe.
Sélectionnez le compte Snowflake associé au compte du consommateur.
Installer la salle blanche¶
Sur la page Salles blanches, recherchez la vignette correspondant à la salle blanche que vous venez de créer et sélectionnez Installer. La vignette pourrait ressembler à ce qui suit :
Effectuer une analyse¶
Effectuer une analyse dans la salle blanche :
Sur la page Analyses et requêtes, sélectionnez Nouvelle analyse et requête.
Sélectionnez la vignette correspondant au modèle Lookalike personnalisé que vous avez créé, puis sélectionnez Suivant.
Sélectionnez la salle blanche, puis cliquez sur Suivant.
Remplissez le formulaire personnalisé que vous avez créé pour la salle blanche.