Environment Klasse

  • Referenz

Umgebung für Schulungen.

Vererbung
azure.ai.ml.entities._assets.asset.Asset
Environment
azure.ai.ml.entities._mixins.LocalizableMixin
Environment

Konstruktor

Environment(*, name: str | None = None, version: str | None = None, description: str | None = None, image: str | None = None, build: BuildContext | None = None, conda_file: str | PathLike | None = None, tags: Dict | None = None, properties: Dict | None = None, datastore: str | None = None, **kwargs)

Parameter

name
str
Erforderlich

Der Name der Ressource.

version
str
Erforderlich

Version des Medienobjekts.

description
str
Erforderlich

Beschreibung der Ressource.

image
str
Erforderlich

URI eines benutzerdefinierten Basisimages.

build
BuildContext
Erforderlich

Docker-Buildkontext zum Erstellen der Umgebung. Sich gegenseitig ausschließen mit "Image"

conda_file
Union[str, PathLike]
Erforderlich

Pfad zur Konfigurationsdatei, in der die zu installierenden Conda-Pakete aufgeführt sind.

tags
dict[str, str]
Erforderlich

Tagwörterbuch. Tags können hinzugefügt, entfernt und aktualisiert werden.

properties
dict[str, str]
Erforderlich

Das Ressourceneigenschaftenverzeichnis.

datastore
str
Erforderlich

Der Datenspeicher, in den das lokale Artefakt hochgeladen werden soll.

kwargs
dict
Erforderlich

Ein Wörterbuch mit zusätzlichen Konfigurationsparametern.

Beispiele

Erstellen Sie ein Environment-Objekt.


   from azure.ai.ml.entities._assets.environment import Environment

   environment = Environment(
       name="env-name",
       version="2.0",
       description="env-description",
       image="env-image",
       conda_file="./sdk/ml/azure-ai-ml/tests/test_configs/deployments/model-1/environment/conda.yml",
       tags={"tag1": "value1", "tag2": "value2"},
       properties={"prop1": "value1", "prop2": "value2"},
       datastore="datastore",
   )

Methoden

dump

Speichern Sie den Medienobjektinhalt in eine Datei im YAML-Format.
validate

Überprüfen Sie die Umgebung, indem Sie den Namen, das Image und den Build überprüfen.

dump

Speichern Sie den Medienobjektinhalt in eine Datei im YAML-Format.

dump(dest: str | PathLike | IO, **kwargs) -> None

Parameter

dest
Union[<xref:PathLike>, str, IO[AnyStr]]
Erforderlich

Der lokale Pfad oder Dateistream, in den der YAML-Inhalt geschrieben werden soll. Wenn dest ein Dateipfad ist, wird eine neue Datei erstellt. Wenn dest eine geöffnete Datei ist, wird die Datei direkt in geschrieben.

kwargs
dict

Zusätzliche Argumente, die an das YAML-Serialisierungsprogramm übergeben werden sollen.

Ausnahmen

FileExistsError

Wird ausgelöst, wenn dest ein Dateipfad ist und die Datei bereits vorhanden ist.

IOError

Wird ausgelöst, wenn dest eine geöffnete Datei ist und die Datei nicht beschreibbar ist.

validate

Überprüfen Sie die Umgebung, indem Sie den Namen, das Image und den Build überprüfen.

validate()

Ausnahmen

FileExistsError

Wird ausgelöst, wenn dest ein Dateipfad ist und die Datei bereits vorhanden ist.

IOError

Wird ausgelöst, wenn dest eine geöffnete Datei ist und die Datei nicht beschreibbar ist.

Beispiele

Beispiel für eine Überprüfung der Umgebung.


   from azure.ai.ml.entities import BuildContext, Environment

   env_docker_context = Environment(
       build=BuildContext(
           path="./sdk/ml/azure-ai-ml/tests/test_configs/environment/environment_files",
           dockerfile_path="DockerfileNonDefault",
       ),
       name="create-environment",
       version="2.0",
       description="Environment created from a Docker context.",
   )

   env_docker_context.validate()

Attribute

base_path

Der Basispfad der Ressource.

Gibt zurück

Der Basispfad der Ressource.

Rückgabetyp

str

conda_file

Conda-Umgebungsspezifikation.

Gibt zurück

Aus conda_file Param geladene Conda-Abhängigkeiten .

Rückgabetyp

Dict

creation_context

Der Erstellungskontext der Ressource.

Gibt zurück

Die Erstellungsmetadaten für die Ressource.

Rückgabetyp

Optional[SystemData]

id

Die Ressourcen-ID.

Gibt zurück

Die globale ID der Ressource, eine Arm-ID (Azure Resource Manager).

Rückgabetyp

Optional[str]

version

Die Medienobjektversion.

Gibt zurück

Die Medienobjektversion.

Rückgabetyp

str