Snowflake ML Jobs¶

Python-Funktion als Snowflake ML-Job ausführen¶

Verwenden Sie Function Dispatch, um einzelne Python-Funktionen mit dem Decorator @remote auf den Rechenressourcen von Snowflake auszuführen.

Mithilfe von @remote können Sie Folgendes tun:

• Serialisieren Sie die Funktion und ihre Abhängigkeiten.

• Laden Sie sie in einen bestimmten Snowflake Stagingbereich hoch.

• Führen Sie sie innerhalb einer bestimmten Container-Laufzeit aus.

Der folgende beispielhafte Python-Code verwendet den Decorator @remote, um einen Funktionsaufruf als Snowflake-ML-Job zu übermitteln:

from snowflake.ml.jobs import remote

@remote("MY_COMPUTE_POOL", stage_name="payload_stage", session=session)
def train_model(data_table: str):
  # Provide your ML code here, including imports and function calls
  ...

job = train_model("my_training_data")

Der Aufruf einer dekorierten @remote-Funktion gibt ein Snowflake MLJob-Objekt zurück, das zur Verwaltung und Überwachung der Jobausführung verwendet werden kann. Weitere Informationen dazu finden Sie unter Verwalten von ML-Jobs.

Eine Python-Datei als Snowflake ML Job ausführen¶

Führen Sie Python-Dateien oder Projektverzeichnisse auf Snowflake-Rechenressourcen aus. Dies ist nützlich, wenn:

• Sie komplexe ML-Projekte mit mehreren Modulen und Abhängigkeiten haben.

• Sie die Trennung zwischen lokaler Entwicklung und Produktionscode aufrechterhalten wollen.

• Sie Skripte ausführen müssen, die Befehlszeilenargumente verwenden.

• Sie mit bestehenden ML-Projekten arbeiten, die nicht speziell für die Ausführung auf Snowflake Compute entwickelt wurden.

Die Snowflake Job-API bietet drei Hauptmethoden für die Übermittlung von dateibasierten Nutzlasten:

• :meth:submit_file()`submit_file: Für die Ausführung einzelner Python-Dateien

• submit_directory(): Für die Ausführung von Python-Projekten, die mehrere Dateien und Ressourcen umfassen

• :meth:submit_from_stage()`submit_from_stage: Für die Ausführung von Python-Projekten, die in einem Snowflake-Stagingbereich gespeichert sind

Beide Methoden unterstützen Folgendes:

• Übergabe von Argumenten in der Befehlszeile

• Konfiguration der Umgebungsvariablen

• Benutzerdefinierte Abhängigkeitsangaben

• Verwaltung der Projektressourcen über die Snowflake-Stagingbereiche

File Dispatch ist besonders nützlich, um bestehende ML-Workflows zu produzieren und eine klare Trennung zwischen Entwicklungs- und Ausführungsumgebung aufrechtzuerhalten.

Der folgende Python-Code übermittelt eine Datei als Snowflake ML-Job:

from snowflake.ml.jobs import submit_file

# Run a single file
job1 = submit_file(
  "train.py",
  "MY_COMPUTE_POOL",
  stage_name="payload_stage",
  args=["--data-table", "my_training_data"],
  session=session,
)

Der folgende Python-Code übermittelt ein Verzeichnis als Snowflake ML-Job:

from snowflake.ml.jobs import submit_directory

# Run from a directory
job2 = submit_directory(
  "./ml_project/",
  "MY_COMPUTE_POOL",
  entrypoint="train.py",
  stage_name="payload_stage",
  session=session,
)

Der folgende Python-Code übermittelt ein Verzeichnis aus einem Snowflake-Stagingbereich als Snowflake ML-Job:

from snowflake.ml.jobs import submit_from_stage

# Run from a directory
job3 = submit_from_stage(
  "@source_stage/ml_project/"
  "MY_COMPUTE_POOL",
  entrypoint="@source_stage/ml_project/train.py",
  stage_name="payload_stage",
  session=session,
)

# Entrypoint may also be a relative path
job4 = submit_from_stage(
  "@source_stage/ml_project/",
  "MY_COMPUTE_POOL",
  entrypoint="train.py",  # Resolves to @source_stage/ml_project/train.py
  stage_name="payload_stage",
  session=session,
)

Die Übermittlung einer Datei oder eines Verzeichnisses gibt ein Snowflake MLJob-Objekt zurück, das zur Verwaltung und Überwachung der Jobausführung verwendet werden kann. Weitere Informationen dazu finden Sie unter Verwalten von ML-Jobs.

Ausführen eines Snowflake-ML-Jobs für eine bestimmte Container-Laufzeit¶

Der Decorator @remote sowie die Funktionen functions submit_directory(), submit_from_stage() und submit_file() unterstützen alle das Schlüsselwort runtime_environment. Wenn Sie dieses Schlüsselwort nicht in Ihrem Decorator-Element oder Funktionsaufruf angeben, verwendet Snowflake automatisch die neueste verfügbare Version von Snowflake Container Runtime in Ihrem Computepool.

Um eine Container-Laufzeit für Ihren ML-Job anzugeben, verwenden Sie das Schlüsselwort runtime_environment mit einem Zeichenfolgenwert der zu verwendenden Container Runtime-Version. Die vollständige Liste der verfügbaren Versionen und die standardmäßig in diesen Umgebungen enthaltenen Informationen finden Sie unter :doc:` Container Runtime-Releases </developer-guide/snowflake-ml/container-runtime/releases>`.

Das folgende Beispiel zeigt, wie Sie eine Funktion mit dem Decorator @remote an Snowflake Container Runtime Version 2.3 anheften:

from snowflake.ml.jobs import remote

@remote("MY_COMPUTE_POOL", stage_name="payload_stage", session=session, runtime_environment="2.3")
def train_model(data_table: str):
  # Provide your ML code here, including imports and function calls
  ...

Unterstützung zusätzlicher Nutzlasten in Übermittlungen¶

Beim Übermitteln einer Datei, eines Verzeichnisses oder aus einem Stagingbereich werden zusätzliche Nutzdaten für die Verwendung während der Jobausführung unterstützt. Der Importpfad kann explizit angegeben werden. Andernfalls wird er vom Speicherort der zusätzlichen Nutzlast abgeleitet.

# Run from a file
 job1 = submit_file(
   "train.py",
   "MY_COMPUTE_POOL",
   stage_name="payload_stage",
   session=session,
   imports=[
     ("src/utils/", "utils"), # the import path is utils
   ],
 )

 # Run from a directory
 job2 = submit_directory(
   "./ml_project/",
   "MY_COMPUTE_POOL",
   entrypoint="train.py",
   stage_name="payload_stage",
   session=session,
   imports=[
     ("src/utils/"), # the import path is utils
   ],
 )

 # Run from a stage
 job3 = submit_from_stage(
   "@source_stage/ml_project/",
   "MY_COMPUTE_POOL",
   entrypoint="@source_stage/ml_project/train.py",
   stage_name="payload_stage",
   session=session,
   imports=[
     ("@source_stage/src/utils/sub_utils/", "utils.sub_utils"),
   ],
 )

Zugriff auf Snowpark-Sitzung über ML-Jobs¶

Beim Ausführen von ML-Jobs in Snowflake ist eine Snowpark-Sitzung im Ausführungskontext automatisch verfügbar. Sie können über die folgenden Ansätze auf das Sitzungsobjekt aus Ihrer ML-Job-Nutzlast zugreifen:

from snowflake.ml.jobs import remote
from snowflake.snowpark import Session

@remote("MY_COMPUTE_POOL", stage_name="payload_stage")
def my_function():
  # This approach works for all payload types, including file and directory payloads
  session = Session.builder.getOrCreate()
  print(session.sql("SELECT CURRENT_VERSION()").collect())

@remote("MY_COMPUTE_POOL", stage_name="payload_stage")
def my_function_with_injected_session(session: Session):
  # This approach works only for function dispatch payloads
  # The session is injected automatically by the Snowflake ML Job API
  print(session.sql("SELECT CURRENT_VERSION()").collect())

Die Snowpark-Sitzung kann für den Zugriff auf Snowflake-Tabellen, -Stagingbereiche und andere Datenbankobjekte innerhalb Ihres ML-Jobs verwendet werden.

Rückgabe von Ergebnissen aus ML-Jobs¶

Snowflake ML-Jobs unterstützen die Rückgabe von Ausführungsergebnissen an die Clientumgebung. So können Sie berechnete Werte, trainierte Modelle oder andere Artefakte abrufen, die durch Ihre Job-Nutzlasten erzeugt werden.

Für das Dispatching von Funktionen geben Sie einfach einen Wert aus Ihrer dekorierten Funktion zurück. Der zurückgegebene Wert wird serialisiert und über die result()-Methode zur Verfügung gestellt.

from snowflake.ml.jobs import remote

@remote("MY_COMPUTE_POOL", stage_name="payload_stage")
def train_model(data_table: str):
  # Your ML code here
  model = XGBClassifier()
  model.fit(data_table)
  return model

job1 = train_model("my_training_data")

Für dateibasierte Jobs verwenden Sie die spezielle __return__-Variable zur Angabe des Rückgabewerts.

# Example: /path/to/repo/my_script.py
def main():
    # Your ML code here
    model = XGBClassifier()
    model.fit(data_table)
    return model

if __name__ == "__main__":
    __return__ = main()

from snowflake.ml.jobs import submit_file

job2 = submit_file(
    "/path/to/repo/my_script.py",
    "MY_COMPUTE_POOL",
    stage_name="payload_stage",
    session=session,
)

Sie können das Ergebnis der Jobausführung über die MLJob.result()-API abrufen. Die API blockiert den aufrufenden Thread, bis der Job einen Endzustand erreicht hat, und gibt dann den Rückgabewert der Nutzlast zurück oder löst bei fehlgeschlagener Ausführung eine Ausnahme aus. Wenn die Nutzlast keinen Rückgabewert definiert, ist das Ergebnis None bei Erfolg.

# These will block until the respective job is done and return the trained model
model1 = job1.result()
model2 = job2.result()

Private Paketzuführungen¶

Snowflake ML Jobs unterstützt auch das Laden von Paketen aus privaten Feeds wie JFrog Artifactory und Sonatype Nexus Repository. Diese Feeds werden häufig verwendet, um interne und proprietäre Pakete zu verteilen, die Kontrolle über die Versionen von Abhängigkeiten zu behalten und Sicherheit und Compliance zu gewährleisten.

Um Pakete aus einem privaten Feed zu installieren, müssen Sie Folgendes tun:

1. Erstellen Sie eine Netzwerkregel, um den Zugriff auf die URL des privaten Feeds zu erlauben.

   1. Für Quellen, die eine einfache Authentifizierung verwenden, können Sie einfach eine Netzwerkregel erstellen.

      CopyExpand

      CREATE OR REPLACE NETWORK RULE private_feed_nr
      MODE = EGRESS
      TYPE = HOST_PORT
      VALUE_LIST = ('<your-repo>.jfrog.io');
      

      Show lessSee more

      Scroll to top

   2. Um den Zugriff auf eine Quelle über private Konnektivität (d. h. Private Link) zu konfigurieren, folgen Sie den Schritten unter Netzwerkausgang über private Konnektivität.

2. Erstellen Sie eine externe Zugriffsintegration mit der Netzwerkregel. Erteilen Sie der Rolle, die Aufträge einreichen wird, die Erlaubnis zur Verwendung von EAI.

   CopyExpand

   CREATE OR REPLACE EXTERNAL ACCESS INTEGRATION private_feed_eai
   ALLOWED_NETWORK_RULES = (PRIVATE_FEED_NR)
   ENABLED = true;
   
   GRANT USAGE ON INTEGRATION private_feed_eai TO ROLE <role_name>;
   

   Show lessSee more

   Scroll to top

3. Geben Sie die URL des privaten Feeds, die externe Zugriffsintegration und das/die Paket(e) an, wenn Sie den Job übermitteln.

   CopyExpand

   # Option 1: Specify private feed URL in pip_requirements
   job = submit_file(
     "/path/to/script.py",
     compute_pool="MY_COMPUTE_POOL",
     stage_name="payload_stage",
     pip_requirements=[
       "--index-url=https://your.private.feed.url",
       "internal-package==1.2.3"
     ],
     external_access_integrations=["PRIVATE_FEED_EAI"]
   )
   

   Show lessSee more

   Scroll to top

   CopyExpand

   # Option 2: Specify private feed URL by environment variable
   job = submit_directory(
     "/path/to/code/",
     compute_pool="MY_COMPUTE_POOL",
     entrypoint="script.py",
     stage_name="payload_stage",
     pip_requirements=["internal-package==1.2.3"],
     external_access_integrations=["PRIVATE_FEED_EAI"],
     env_vars={'PIP_INDEX_URL': 'https://your.private.feed.url'},
   )
   

   Show lessSee more

   Scroll to top

Wenn Ihre private Feed-URL sensible Informationen wie Authentifizierungstoken enthält, verwalten Sie die URL durch Erstellen eines Snowflake-Geheimnisses. Erstellen Sie ein Geheimnis mithilfe von CREATE SECRET. Konfigurieren Sie Geheimnisse während der Übermittlung des Jobs mit dem spec_overrides-Argument.

# Create secret for private feed URL with embedded auth token
feed_url = "<your-repo>.jfrog.io/artifactory/api/pypi/test-pypi/simple"
user = "<auth_user>"
token = "<auth_token>"
session.sql(f"""
CREATE SECRET IF NOT EXISTS PRIVATE_FEED_URL_SECRET
 TYPE = GENERIC_STRING
 SECRET_STRING = 'https://{auth_user}:{auth_token}@{feed_url}'
""").collect()

# Prepare service spec override for mounting secret into job execution
spec_overrides = {
 "spec": {
  "containers": [
    {
     "name": "main",  # Primary container name is always "main"
     "secrets": [
      {
        "snowflakeSecret": "PRIVATE_FEED_URL_SECRET",
        "envVarName": "PIP_INDEX_URL",
        "secretKeyRef": "secret_string"
      },
     ],
    }
  ]
 }
}

# Load private feed URL from secret (e.g. if URL includes auth token)
job = submit_file(
  "/path/to/script.py",
  compute_pool="MY_COMPUTE_POOL",
  stage_name="payload_stage",
  pip_requirements=[
    "internal-package==1.2.3"
  ],
  external_access_integrations=["PRIVATE_FEED_EAI"],
  spec_overrides=spec_overrides,
)

Weitere Informationen über container.secrets finden Sie unter Feld containers.secrets.