Environment Klasse

Konfiguriert eine reproduzierbare Python-Umgebung für Machine Learning-Experimente.

Eine Umgebung definiert Python-Pakete, Umgebungsvariablen und Docker-Einstellungen, die in Machine Learning-Experimenten verwendet werden, einschließlich der Datenvorbereitung, Schulung und Bereitstellung in einem Webdienst. Eine Umgebung wird in einem Azure Machine Learning Workspaceverwaltet und versioniert. Sie können eine vorhandene Umgebung aktualisieren und eine Version abrufen, um sie wiederzuverwenden. Umgebungen sind exklusiv für den Arbeitsbereich, in dem sie erstellt werden, und können nicht in verschiedenen Arbeitsbereichen verwendet werden.

Weitere Informationen zu Umgebungen finden Sie unter Erstellen und Verwalten wiederverwendbarer Umgebungen.

Class Environment-Konstruktor.

Konstruktor

Environment(name, **kwargs)

Parameter

Name	Beschreibung
name Erforderlich	string Der Name der Umgebung. Hinweis Starten Sie ihren Umgebungsnamen nicht mit "Microsoft" oder "AzureML". Die Präfixe "Microsoft" und "AzureML" sind für kuratierte Umgebungen reserviert. Weitere Informationen zu kuratierten Umgebungen finden Sie unter Erstellen und Verwalten wiederverwendbarer Umgebungen.

Hinweise

Azure Machine Learning bietet kuratierte Umgebungen, die vordefinierte Umgebungen sind, die gute Ausgangspunkte für die Erstellung Eigener Umgebungen bieten. Kuratierte Umgebungen werden durch zwischengespeicherte Docker-Images gesichert und bieten eine reduzierte Ausführungsvorbereitungskosten. Weitere Informationen zu kuratierten Umgebungen finden Sie unter Erstellen und Verwalten wiederverwendbarer Umgebungen.

Es gibt eine Reihe von Möglichkeiten, wie die Umgebung im Azure Machine Learning erstellt wird, z. B. wenn Sie:

• Initialisieren sie ein neues Environment-Objekt.

• Verwenden Sie eine der Environment-Klassenmethoden: from_conda_specification, , from_pip_requirements, oder from_existing_conda_environment.

• Verwenden Sie die submit Methode der Experimentklasse, um einen Experimentlauf zu übermitteln, ohne eine Umgebung anzugeben, einschließlich eines Estimator Objekts.

Das folgende Beispiel zeigt, wie Sie eine neue Umgebung instanziieren.

   from azureml.core import Environment
   myenv = Environment(name="myenv")

Sie können eine Umgebung verwalten, indem Sie sie registrieren. Auf diese Weise können Sie die Versionen der Umgebung nachverfolgen und in zukünftigen Läufen wiederverwenden.

   myenv.register(workspace=ws)

Weitere Beispiele für das Arbeiten mit Umgebungen finden Sie unter "Jupyter Notebook Using environments".

Variablen

Name	Beschreibung
Environment.databricks	Der Abschnitt konfiguriert Abhängigkeiten der azureml.core.databricks.DatabricksSection-Bibliothek.
docker	DockerSection In diesem Abschnitt werden Einstellungen im Zusammenhang mit dem endgültigen Docker-Image konfiguriert, das auf die Spezifikationen der Umgebung basiert und ob Docker-Container zum Erstellen der Umgebung verwendet werden sollen.
inferencing_stack_version	string In diesem Abschnitt wird die ableitende Stapelversion angegeben, die dem Image hinzugefügt wurde. Um das Hinzufügen eines Ableitungsstapels zu vermeiden, legen Sie diesen Wert nicht fest. Gültiger Wert: „latest“ (Aktuellste).
python	PythonSection In diesem Abschnitt wird angegeben, welche Python-Umgebung und welcher Dolmetscher für die Zielberechnung verwendet werden soll.
spark	SparkSection Der Abschnitt konfiguriert die Spark-Einstellungen. Es wird nur verwendet, wenn das Framework auf PySpark festgelegt ist.
r	RSection In diesem Abschnitt wird angegeben, welche R-Umgebung für die Zielberechnung verwendet werden soll.
version	string Die Version der Umgebung.
asset_id	string Objekt-ID. Füllt auf, wenn eine Umgebung registriert ist.

Methoden

add_private_pip_wheel	Laden Sie die private Pip-Raddatei auf dem Datenträger in das Azure Storage-BLOB hoch, das an den Arbeitsbereich angefügt ist. Löst eine Ausnahme aus, wenn ein privates Pip-Rad mit demselben Namen bereits im Arbeitsbereichspeicher-BLOB vorhanden ist.
build	Erstellen Sie ein Docker-Image für diese Umgebung in der Cloud.
build_local	Erstellen Sie die lokale Docker- oder Conda-Umgebung.
clone	Klonen Sie das Umgebungsobjekt. Gibt eine neue Instanz des Umgebungsobjekts mit einem neuen Namen zurück.
from_conda_specification	Erstellen Sie ein Umgebungsobjekt aus einer YaML-Datei für die Umgebungsspezifikation. Informationen zum Abrufen einer YAML-Datei für die Umgebungsspezifikation finden Sie im Conda-Benutzerhandbuch zum Verwalten von Umgebungen .
from_docker_build_context	Erstellen Eines Umgebungsobjekts aus einem Docker-Buildkontext.
from_docker_image	Erstellen Eines Umgebungsobjekts aus einem Basis-Docker-Image mit optionalen Python-Abhängigkeiten. Python-Ebene wird der Umgebung hinzugefügt, wenn conda_specification oder pip_requirements angegeben ist. conda_specification und pip_requirements schließen sich gegenseitig aus.
from_dockerfile	Erstellen eines Umgebungsobjekts aus einer Dockerfile-Datei mit optionalen Python-Abhängigkeiten. Python-Ebene wird der Umgebung hinzugefügt, wenn conda_specification oder pip_requirements angegeben ist. conda_specification und pip_requirements schließen sich gegenseitig aus.
from_existing_conda_environment	Erstellen Sie ein Umgebungsobjekt, das aus einer lokal vorhandenen Conda-Umgebung erstellt wurde. Führen Sie zum Abrufen einer Liste vorhandener Conda-Umgebungen aus conda env list. Weitere Informationen finden Sie im Conda-Handbuch zum Verwalten von Umgebungen .
from_pip_requirements	Erstellen Sie ein Umgebungsobjekt, das aus einer Pip-Anforderungsdatei erstellt wurde. Wenn pip_version nicht angegeben ist, wird eine nicht angeheftete Pip-Abhängigkeit hinzugefügt.
get	Gibt das Umgebungsobjekt zurück. Wenn Beschriftung angegeben ist, wird das zuvor mit dem Wert beschriftete Objekt zurückgegeben. Es kann nur ein Versions- oder Bezeichnungsparameter angegeben werden. Wenn beide verpasst werden, wird die neueste Version des Environment-Objekts zurückgegeben.
get_image_details	Geben Sie die Bilddetails zurück.
label	Bezeichnungsumgebungsobjekt in Ihrem Arbeitsbereich mit den angegebenen Werten.
list	Gibt ein Wörterbuch zurück, das Umgebungen im Arbeitsbereich enthält.
load_from_directory	Laden Sie eine Umgebungsdefinition aus den Dateien in einem Verzeichnis.
register	Registrieren Sie das Umgebungsobjekt in Ihrem Arbeitsbereich.
save_to_directory	Speichern Sie eine Umgebungsdefinition in einem Verzeichnis in einem leicht bearbeitbaren Format.

add_private_pip_wheel

Laden Sie die private Pip-Raddatei auf dem Datenträger in das Azure Storage-BLOB hoch, das an den Arbeitsbereich angefügt ist.

Löst eine Ausnahme aus, wenn ein privates Pip-Rad mit demselben Namen bereits im Arbeitsbereichspeicher-BLOB vorhanden ist.

static add_private_pip_wheel(workspace, file_path, exist_ok=False)

Parameter

Name	Beschreibung
workspace Erforderlich	Workspace Das Arbeitsbereichsobjekt, das zum Registrieren des privaten Pip-Rads verwendet werden soll.
file_path Erforderlich	str Pfad zum lokalen Pip-Rad auf dem Datenträger, einschließlich der Dateierweiterung.
exist_ok	bool Gibt an, ob eine Ausnahme ausgelöst werden soll, wenn das Rad bereits vorhanden ist. Standardwert: False

Gibt zurück

Typ	Beschreibung
str	Gibt den vollständigen URI an das hochgeladene Piprad im Azure Blob Storage zurück, der in Conda-Abhängigkeiten verwendet werden soll.

build

Erstellen Sie ein Docker-Image für diese Umgebung in der Cloud.

build(workspace, image_build_compute=None)

Parameter

Name	Beschreibung
workspace Erforderlich	Workspace Der Arbeitsbereich und die zugehörige Azure-Containerregistrierung, in der das Image gespeichert ist.
image_build_compute	str Der Berechnungsname, in dem der Imagebuild stattfindet Standardwert: None

Gibt zurück

Typ	Beschreibung
ImageBuildDetails	Gibt das Bildbuilddetails-Objekt zurück.

build_local

Erstellen Sie die lokale Docker- oder Conda-Umgebung.

build_local(workspace, platform=None, **kwargs)

Parameter

Name	Beschreibung
workspace Erforderlich	Workspace Der Arbeitsbereich.
platform	str Bahnsteig. Einer von Linux, Windows oder OSX. Die aktuelle Plattform wird standardmäßig verwendet. Standardwert: None
kwargs Erforderlich	dict Erweiterte Schlüsselwortargumente

Gibt zurück

Typ	Beschreibung
str	Streamt die laufende Docker- oder Conda-integrierte Ausgabe an die Konsole.

Hinweise

Die folgenden Beispiele zeigen, wie Sie eine lokale Umgebung erstellen. Stellen Sie sicher, dass der Arbeitsbereich als gültiges azureml.core.workspace.Workspace.Workspace-Objekt instanziiert wird.

Erstellen einer lokalen Conda-Umgebung

   from azureml.core import Environment
   myenv = Environment(name="myenv")
   registered_env = myenv.register(workspace)
   registered_env.build_local(workspace)

Erstellen einer lokalen Docker-Umgebung

   from azureml.core import Environment
   myenv = Environment(name="myenv")
   registered_env = myenv.register(workspace)
   registered_env.build_local(workspace, useDocker=True)

Erstellen eines Docker-Images lokal und optional per Push an die Containerregistrierung, die dem Arbeitsbereich zugeordnet ist

   from azureml.core import Environment
   myenv = Environment(name="myenv")
   registered_env = myenv.register(workspace)
   registered_env.build_local(workspace, useDocker=True, pushImageToWorkspaceAcr=True)

clone

Klonen Sie das Umgebungsobjekt.

Gibt eine neue Instanz des Umgebungsobjekts mit einem neuen Namen zurück.

clone(new_name)

Parameter

Name	Beschreibung
new_name Erforderlich	str Neuer Umgebungsname

Gibt zurück

Typ	Beschreibung
Environment	Neues Umgebungsobjekt

from_conda_specification

Erstellen Sie ein Umgebungsobjekt aus einer YaML-Datei für die Umgebungsspezifikation.

Informationen zum Abrufen einer YAML-Datei für die Umgebungsspezifikation finden Sie im Conda-Benutzerhandbuch zum Verwalten von Umgebungen .

static from_conda_specification(name, file_path)

Parameter

Name	Beschreibung
name Erforderlich	str Der Umgebungsname.
file_path Erforderlich	str Der YaML-Dateipfad der Conda-Umgebung.

Gibt zurück

Typ	Beschreibung
Environment	Das Umgebungsobjekt.

from_docker_build_context

Erstellen Eines Umgebungsobjekts aus einem Docker-Buildkontext.

static from_docker_build_context(name, docker_build_context)

Parameter

Name	Beschreibung
name Erforderlich	str Der Umgebungsname.
docker_build_context Erforderlich	DockerBuildContext Das DockerBuildContext-Objekt.

Gibt zurück

Typ	Beschreibung
Environment	Das Umgebungsobjekt.

from_docker_image

Erstellen Eines Umgebungsobjekts aus einem Basis-Docker-Image mit optionalen Python-Abhängigkeiten.

Python-Ebene wird der Umgebung hinzugefügt, wenn conda_specification oder pip_requirements angegeben ist. conda_specification und pip_requirements schließen sich gegenseitig aus.

static from_docker_image(name, image, container_registry=None, conda_specification=None, pip_requirements=None)

Parameter

Name	Beschreibung
name Erforderlich	str Der Umgebungsname.
image Erforderlich	str vollqualifizierter Bildname.
conda_specification	str conda-Spezifikationsdatei. Standardwert: None
container_registry	ContainerRegistry Details des privaten Container-Repositorys. Standardwert: None
pip_requirements	str pip requirements file. Standardwert: None

Gibt zurück

Typ	Beschreibung
Environment	Das Umgebungsobjekt.

Hinweise

Wenn das Basisimage aus einem privaten Repository stammt, das eine Autorisierung erfordert und die Autorisierung nicht auf der AzureML-Arbeitsbereichsebene festgelegt ist, ist container_registry erforderlich.

from_dockerfile

Erstellen eines Umgebungsobjekts aus einer Dockerfile-Datei mit optionalen Python-Abhängigkeiten.

Python-Ebene wird der Umgebung hinzugefügt, wenn conda_specification oder pip_requirements angegeben ist. conda_specification und pip_requirements schließen sich gegenseitig aus.

static from_dockerfile(name, dockerfile, conda_specification=None, pip_requirements=None)

Parameter

Name	Beschreibung
name Erforderlich	str Der Umgebungsname.
dockerfile Erforderlich	str Dockerfile-Inhalt oder Pfad zur Datei.
conda_specification	str conda-Spezifikationsdatei. Standardwert: None
pip_requirements	str pip requirements file. Standardwert: None

Gibt zurück

Typ	Beschreibung
Environment	Das Umgebungsobjekt.

from_existing_conda_environment

Erstellen Sie ein Umgebungsobjekt, das aus einer lokal vorhandenen Conda-Umgebung erstellt wurde.

Führen Sie zum Abrufen einer Liste vorhandener Conda-Umgebungen aus conda env list. Weitere Informationen finden Sie im Conda-Handbuch zum Verwalten von Umgebungen .

static from_existing_conda_environment(name, conda_environment_name)

Parameter

Name	Beschreibung
name Erforderlich	str Der Umgebungsname.
conda_environment_name Erforderlich	str Der Name einer lokal vorhandenen Conda-Umgebung.

Gibt zurück

Typ	Beschreibung
Environment	Das Umgebungsobjekt oder "None", wenn beim Exportieren der Conda-Spezifikationsdatei ein Fehler auftritt.

from_pip_requirements

Erstellen Sie ein Umgebungsobjekt, das aus einer Pip-Anforderungsdatei erstellt wurde.

Wenn pip_version nicht angegeben ist, wird eine nicht angeheftete Pip-Abhängigkeit hinzugefügt.

static from_pip_requirements(name, file_path, pip_version=None)

Parameter

Name	Beschreibung
name Erforderlich	str Der Umgebungsname.
file_path Erforderlich	str Der Dateipfad für pip requirements.
pip_version	str Pip-Version für conda-Umgebung. Standardwert: None

Gibt zurück

Typ	Beschreibung
Environment	Das Umgebungsobjekt.

get

Gibt das Umgebungsobjekt zurück.

Wenn Beschriftung angegeben ist, wird das zuvor mit dem Wert beschriftete Objekt zurückgegeben. Es kann nur ein Versions- oder Bezeichnungsparameter angegeben werden. Wenn beide verpasst werden, wird die neueste Version des Environment-Objekts zurückgegeben.

static get(workspace, name, version=None, label=None)

Parameter

Name	Beschreibung
workspace Erforderlich	Workspace Der Arbeitsbereich, der die Umgebung enthält.
name Erforderlich	str Der Name der zurückzugebenden Umgebung.
version	str Die Zurückzugebende Version der Umgebung. Standardwert: None
label	str Wert der Umgebungsbezeichnung. Standardwert: None

Gibt zurück

Typ	Beschreibung
Environment	Das Umgebungsobjekt.

get_image_details

Geben Sie die Bilddetails zurück.

get_image_details(workspace)

Parameter

Name	Beschreibung
workspace Erforderlich	Workspace Der Arbeitsbereich.

Gibt zurück

Typ	Beschreibung
DockerImageDetails	Gibt die Bilddetails als Diktat zurück.

label

Bezeichnungsumgebungsobjekt in Ihrem Arbeitsbereich mit den angegebenen Werten.

static label(workspace, name, version, labels)

Parameter

Name	Beschreibung
workspace Erforderlich	Workspace Der Arbeitsbereich
name Erforderlich	str Umgebungsname
version Erforderlich	str Umgebungsversion
labels Erforderlich	list[str] Werte für die Bezeichnung "Umgebung" mit

list

Gibt ein Wörterbuch zurück, das Umgebungen im Arbeitsbereich enthält.

static list(workspace)

Parameter

Name	Beschreibung
workspace Erforderlich	Workspace Der Arbeitsbereich, aus dem Umgebungen aufgeführt werden sollen.

Gibt zurück

Typ	Beschreibung
<xref:builtin.dict>[str, Environment]	Ein Wörterbuch von Umgebungsobjekten.

load_from_directory

Laden Sie eine Umgebungsdefinition aus den Dateien in einem Verzeichnis.

static load_from_directory(path)

Parameter

Name	Beschreibung
path Erforderlich	str Pfad zum Quellverzeichnis.

register

Registrieren Sie das Umgebungsobjekt in Ihrem Arbeitsbereich.

register(workspace)

Parameter

Name	Beschreibung
workspace Erforderlich	Workspace Der Arbeitsbereich
name Erforderlich	str

Gibt zurück

Typ	Beschreibung
Environment	Gibt das Umgebungsobjekt zurück.

save_to_directory

Speichern Sie eine Umgebungsdefinition in einem Verzeichnis in einem leicht bearbeitbaren Format.

save_to_directory(path, overwrite=False)

Parameter

Name	Beschreibung
path Erforderlich	str Pfad zum Zielverzeichnis.
overwrite	bool Wenn ein vorhandenes Verzeichnis überschrieben werden soll. Standardwert ist "false". Standardwert: False

Attribute

environment_variables

Verwenden Sie das Objekt "azureml.core.RunConfiguration", um Laufzeitvariablen festzulegen.