promptflow.azure Modul#

class promptflow.azure.PFClient(credential: Optional[TokenCredential] = None, subscription_id: Optional[str] = None, resource_group_name: Optional[str] = None, workspace_name: Optional[str] = None, **kwargs)#

Basiert auf: object

Eine Clientklasse zur Interaktion mit dem Promptflow-Dienst.

Verwenden Sie diesen Client, um Promptflow-Ressourcen zu verwalten, z. B. Läufe.

Parameter:

  • credential (TokenCredential) – Anmeldeinformationen für die Authentifizierung, optional

  • subscription_id (Optional[str]) – Azure-Abonnement-ID, optional nur für Registry-Assets, optional

  • resource_group_name (Optional[str]) – Azure-Ressourcengruppe, optional nur für Registry-Assets, optional

  • workspace_name (Optional[str]) – Arbeitsbereich, der im Client verwendet werden soll, optional nur für nicht-arbeitsbereichabhängige Operationen, optional.

  • kwargs (dict) – Ein Wörterbuch mit zusätzlichen Konfigurationsparametern.

property flows#

Gibt das Flow-Operationsobjekt zurück, das Flows verwalten kann.

classmethod from_config(credential: TokenCredential, *, path: Optional[Union[str, PathLike]] = None, file_name=None, **kwargs) → PFClient#

Gibt ein PFClient-Objekt zurück, das mit dem Azure Machine Learning-Arbeitsbereich verbunden ist.

Liest die Arbeitsbereichskonfiguration aus einer Datei. Löst eine Ausnahme aus, wenn die Konfigurationsdatei nicht gefunden werden kann.

Die Methode bietet eine einfache Möglichkeit, denselben Arbeitsbereich über mehrere Python-Notebooks oder Projekte hinweg wiederzuverwenden. Benutzer können die Azure Resource Manager (ARM)-Eigenschaften des Arbeitsbereichs mit der Methode [workspace.write_config](https://aka.ms/ml-workspace-class) speichern und diese Methode verwenden, um denselben Arbeitsbereich in verschiedenen Python-Notebooks oder Projekten zu laden, ohne die ARM-Eigenschaften des Arbeitsbereichs neu eingeben zu müssen.

Parameter:

  • credential (TokenCredential) – Das Anmeldeinformations-Objekt für den Arbeitsbereich.

  • path (Union[os.PathLike, str]) – Der Pfad zur Konfigurationsdatei oder zum Startverzeichnis, das durchsucht werden soll. Der Parameter steht standardmäßig für die Suche im aktuellen Verzeichnis. Optional

  • file_name (str) – Ermöglicht die Überschreibung des zu suchenden Konfigurationsdateinamens, wenn path ein Verzeichnispfad ist. (Standardwert = None)

get_details(run: Union[str, Run], max_results: int = 100, all_results: bool = False) → DataFrame#

Gibt die Details des Laufs einschließlich Eingaben und Ausgaben zurück.

Hinweis

Wenn all_results auf True gesetzt ist, wird max_results auf sys.maxsize überschrieben.

Parameter:

  • run (Union[str, Run]) – Der Laufname oder das Laufobjekt

  • max_results (int) – Die maximale Anzahl der zurückzugebenden Läufe, standardmäßig 100

  • all_results (bool) – Ob alle Ergebnisse zurückgegeben werden sollen, standardmäßig False

Löst aus:

RunOperationParameterError – Wenn max_results keine positive Ganzzahl ist.

Gibt zurück:

Der Details-Datenrahmen.

Rückgabetyp:

pandas.DataFrame

get_metrics(run: Union[str, Run]) → dict#

Gibt Lauf-Metriken auf der Konsole aus.

Parameter:

run (Union[str, Run]) – Laufobjekt oder Name des Laufs.

Gibt zurück:

Die Metriken des Laufs

Rückgabetyp:

dict

property ml_client#

Gibt einen Client zur Interaktion mit Azure ML-Diensten zurück.

run(flow: Optional[Union[str, PathLike]] = None, *, data: Optional[Union[str, PathLike]] = None, run: Optional[Union[str, Run]] = None, column_mapping: Optional[dict] = None, variant: Optional[str] = None, connections: Optional[dict] = None, environment_variables: Optional[dict] = None, name: Optional[str] = None, display_name: Optional[str] = None, tags: Optional[Dict[str, str]] = None, resume_from: Optional[Union[str, Run]] = None, code: Optional[Union[str, PathLike]] = None, init: Optional[dict] = None, **kwargs) → Run#

Führt den Flow mit den bereitgestellten Daten oder dem Lauf aus.

Hinweis

mindestens eine der Optionen data oder run muss angegeben werden.

Daten können eine lokale Datei oder ein Remote-Pfad sein. - Beispiel: - data = „pfad/zur/lokalen/datei“ - data = „azureml:datenname:datenversion“ - data = „azureml://datastores/datastorename/pfad/zur/datei“ - data = „https://example.com/data.jsonl“

Die Spaltenzuordnung ist eine Zuordnung vom Flow-Eingabenamen zu angegebenen Werten. Wenn angegeben, wird der Flow mit dem bereitgestellten Wert für die angegebenen Eingaben ausgeführt. Der Wert kann sein

  • aus Daten

    • data.col1

  • aus Lauf

    • run.inputs.col1: wenn auf die Eingaben des Laufs verwiesen werden muss

    • run.output.col1: wenn auf die Ausgaben des Laufs verwiesen werden muss

  • Beispiel

    • {"ground_truth": "${data.answer}", "prediction": "${run.outputs.answer}"}

Parameter:

  • flow (Union[str, PathLike]) – Pfad zum Flow-Verzeichnis zur Ausführung der Auswertung

  • data (Union[str, PathLike]) – Zeiger auf Testdaten (für Bulk-Läufe von Varianten) für Eval-Läufe

  • run (Union[str, Run]) – Flow-Lauf-ID oder Flow-Lauf, behält die Herkunft zwischen dem aktuellen Lauf und den Variantenläufen bei, Batch-Ausgaben können als ${run.outputs.col_name} in inputs_mapping referenziert werden

  • column_mapping (dict) – Definiert eine Datenflusslogik zum Zuordnen von Eingabedaten.

  • variant (str) – Knoten- &-Variantenname im Format ${node_name.variant_name}, es wird die Standardvariante verwendet, wenn nicht angegeben.

  • connections (dict) – Überschreibt Knoten-spezifische Verbindungen mit dem angegebenen Wert. Beispiel: {"node1": {"connection": "new_connection", "deployment_name": "gpt-35-turbo"}}

  • environment_variables (dict) – Umgebungsvariablen, die durch Angabe eines Eigenschaftspfads und eines Werts gesetzt werden sollen. Beispiel: {"key1": "${my_connection.api_key}", "key2"="value2"} Der Wert, der auf Schlüssel der Verbindung verweist, wird auf den tatsächlichen Wert aufgelöst, und alle angegebenen Umgebungsvariablen werden in os.environ gesetzt.

  • name (str) – Name des Laufs.

  • display_name (str) – Anzeigename des Laufs.

  • tags (Dict[str, str]) – Tags des Laufs.

  • resume_from (str) – Erstellt einen Lauf, der von einem vorhandenen Lauf fortgesetzt wird.

  • code (Union[str, PathLike]) – Pfad zum zu kompilierenden Codeverzeichnis.

  • init (dict) – Initialisierungsparameter für Flex-Flow, nur unterstützt, wenn der Flow eine aufrufbare Klasse ist.

Gibt zurück:

Flow-Lauf-Info.

Rückgabetyp:

Ausführen

property runs#

Gibt das Lauf-Operationsobjekt zurück, das Läufe verwalten kann.

stream(run: Union[str, Run], raise_on_error: bool = True) → Run#

Streamt Run-Protokolle an die Konsole.

Parameter:

  • run (Union[str, Run]) – Laufobjekt oder Name des Laufs.

  • raise_on_error (bool) – Löst eine Ausnahme aus, wenn ein Lauf fehlschlägt oder abgebrochen wird.

Gibt zurück:

Flow-Lauf-Info.

visualize(runs: Union[List[str], List[Run]]) → None#

Visualisiert Lauf(e).

Parameter:

run (Union[str, Run]) – Laufobjekt oder Name des Laufs.

Unterpakete#