Environment Klas

Hiermee configureert u een reproduceerbare Python-omgeving voor machine learning-experimenten.

Een omgeving definieert Python-pakketten, omgevingsvariabelen en Docker-instellingen die worden gebruikt in machine learning-experimenten, waaronder bij het voorbereiden, trainen en implementeren van gegevens naar een webservice. Een omgeving wordt beheerd en versiebeheerd in een Azure Machine Learning Workspace. U kunt een bestaande omgeving bijwerken en een versie ophalen om opnieuw te gebruiken. Omgevingen zijn exclusief voor de werkruimte waarin ze zijn gemaakt en kunnen niet worden gebruikt in verschillende werkruimten.

Zie Herbruikbare omgevingen maken en beheren voor meer informatie over omgevingen.

Klasse-omgevingsconstructor.

Overname

azureml._base_sdk_common.abstract_run_config_element._AbstractRunConfigElement

Environment

Constructor

Environment(name, **kwargs)

Parameters

Name	Description
name Vereist	string De naam van de omgeving. Notitie Start de naam van uw omgeving niet met 'Microsoft' of 'AzureML'. De voorvoegsels 'Microsoft' en 'AzureML' zijn gereserveerd voor gecureerde omgevingen. Zie Herbruikbare omgevingen maken en beheren voor meer informatie over gecureerde omgevingen.

Opmerkingen

Azure Machine Learning biedt gecureerde omgevingen. Dit zijn vooraf gedefinieerde omgevingen die goede uitgangspunten bieden voor het bouwen van uw eigen omgevingen. Gecureerde omgevingen worden ondersteund door Docker-installatiekopieën in de cache, waardoor de voorbereidingskosten voor de uitvoering lager zijn. Zie Herbruikbare omgevingen maken en beheren voor meer informatie over gecureerde omgevingen.

Er zijn een aantal manieren waarop omgevingen worden gemaakt in Azure Machine Learning, waaronder wanneer u:

• Initialiseer een nieuw omgevingsobject.

• Gebruik een van de omgevingsklassemethoden: from_conda_specification, from_pip_requirementsof from_existing_conda_environment.

• Gebruik de submit methode van de klasse Experiment om een experimentuitvoering te verzenden zonder een omgeving op te geven, inclusief met een Estimator -object.

In het volgende voorbeeld ziet u hoe u een nieuwe omgeving maakt.

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

U kunt een omgeving beheren door deze te registreren. Als u dit doet, kunt u de versies van de omgeving bijhouden en deze opnieuw gebruiken in toekomstige uitvoeringen.

   myenv.register(workspace=ws)

Zie de Jupyter Notebook Omgevingen gebruiken voor meer voorbeelden van het werken met omgevingen.

Variabelen

Name	Description
Environment.databricks	In de sectie worden bibliotheekafhankelijkheden van azureml.core.databricks.DatabricksSection geconfigureerd.
docker	DockerSection In deze sectie worden instellingen geconfigureerd die betrekking hebben op de uiteindelijke Docker-installatiekopieën die zijn gebouwd op basis van de specificaties van de omgeving en of Docker-containers moeten worden gebruikt om de omgeving te bouwen.
inferencing_stack_version	string In deze sectie wordt de deductiestackversie opgegeven die aan de installatiekopie is toegevoegd. Als u wilt voorkomen dat er een deductiestack wordt toegevoegd, moet u deze waarde niet instellen. Geldige waarde: 'laatste'.
python	PythonSection In deze sectie wordt aangegeven welke Python-omgeving en interpreter moeten worden gebruikt voor de doelberekening.
spark	SparkSection In de sectie worden Spark-instellingen geconfigureerd. Deze wordt alleen gebruikt wanneer het framework is ingesteld op PySpark.
r	RSection In deze sectie wordt aangegeven welke R-omgeving moet worden gebruikt voor de doelberekening.
version	string De versie van de omgeving.
asset_id	string Asset-id. Wordt ingevuld wanneer een omgeving is geregistreerd.

Methoden

add_private_pip_wheel	Upload het privé-pip wheel-bestand op schijf naar de Azure Storage-blob die is gekoppeld aan de werkruimte. Genereert een uitzondering als er al een privé-pip-wiel met dezelfde naam bestaat in de opslagblob van de werkruimte.
build	Bouw een Docker-installatiekopieën voor deze omgeving in de cloud.
build_local	Bouw de lokale Docker- of Conda-omgeving.
clone	Kloon het omgevingsobject. Retourneert een nieuw exemplaar van het omgevingsobject met een nieuwe naam.
from_conda_specification	Maak een omgevingsobject op basis van een YAML-bestand met de specificatie van de omgeving. Zie Omgevingen beheren in de gebruikershandleiding van Conda om een YAML-bestand met de specificatie van de omgeving op te halen.
from_docker_build_context	Omgevingsobject maken vanuit een Docker-buildcontext.
from_docker_image	Maak een omgevingsobject op basis van een docker-basisinstallatiekopieën met optionele Python-afhankelijkheden. De Python-laag wordt toegevoegd aan de omgeving als conda_specification of pip_requirements is opgegeven. conda_specification en pip_requirements sluiten elkaar uit.
from_dockerfile	Maak een omgevingsobject van een Dockerfile met optionele Python-afhankelijkheden. De Python-laag wordt toegevoegd aan de omgeving als conda_specification of pip_requirements is opgegeven. conda_specification en pip_requirements sluiten elkaar uit.
from_existing_conda_environment	Maak een omgevingsobject dat is gemaakt op basis van een lokaal bestaande Conda-omgeving. Voer uit om een lijst met bestaande Conda-omgevingen op te halen conda env list. Zie Omgevingen beheren in de gebruikershandleiding van Conda voor meer informatie.
from_pip_requirements	Maak een omgevingsobject dat is gemaakt op basis van een pip-vereistenbestand. Losgemaakte pip-afhankelijkheid wordt toegevoegd als pip_version niet is opgegeven.
get	Retourneer het omgevingsobject. Als label is opgegeven, wordt het object geretourneerd dat eerder is gelabeld met de waarde. Er kan slechts één versie- of labelparameters worden opgegeven. Als beide worden gemist, wordt de nieuwste versie van het object Environment geretourneerd.
get_image_details	Retourneer de afbeeldingsdetails.
label	Label omgevingsobject in uw werkruimte met de opgegeven waarden.
list	Retourneert een woordenlijst met omgevingen in de werkruimte.
load_from_directory	Laad een omgevingsdefinitie uit de bestanden in een map.
register	Registreer het omgevingsobject in uw werkruimte.
save_to_directory	Sla een omgevingsdefinitie op in een map in een eenvoudig bewerkbare indeling.

add_private_pip_wheel

Upload het privé-pip wheel-bestand op schijf naar de Azure Storage-blob die is gekoppeld aan de werkruimte.

Genereert een uitzondering als er al een privé-pip-wiel met dezelfde naam bestaat in de opslagblob van de werkruimte.

static add_private_pip_wheel(workspace, file_path, exist_ok=False)

Parameters

Name	Description
workspace Vereist	Workspace Het werkruimteobject dat moet worden gebruikt om het privé-pip-wiel te registreren.
file_path Vereist	str Pad naar het lokale pip-wiel op schijf, inclusief de bestandsextensie.
exist_ok	bool Geeft aan of er een uitzondering moet worden gegenereerd als het wiel al bestaat. Default value: False

Retouren

Type	Description
str	Retourneert de volledige URI naar het geüploade pip wheel in Azure Blob Storage voor gebruik in Conda-afhankelijkheden.

build

Bouw een Docker-installatiekopieën voor deze omgeving in de cloud.

build(workspace, image_build_compute=None)

Parameters

Name	Description
workspace Vereist	Workspace De werkruimte en de bijbehorende Azure Container Registry waar de afbeelding is opgeslagen.
image_build_compute	str De rekennaam waar de installatiekopieën worden gebouwd Default value: None

Retouren

Type	Description
ImageBuildDetails	Retourneert het build-detailobject van de installatiekopieën.

build_local

Bouw de lokale Docker- of Conda-omgeving.

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

Parameters

Name	Description
workspace Vereist	Workspace De werkruimte.
platform	str Platform. Een van Linux, Windows of OSX. Het huidige platform wordt standaard gebruikt. Default value: None
kwargs Vereist	dict Geavanceerde trefwoordargumenten

Retouren

Type	Description
str	Streamt de lopende docker- of conda-uitvoer naar de console.

Opmerkingen

In de volgende voorbeelden ziet u hoe u een lokale omgeving bouwt. Zorg ervoor dat de werkruimte is geïnstantieerd als een geldig azureml.core.workspace.Workspace-object

Lokale Conda-omgeving bouwen

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

Lokale Docker-omgeving bouwen

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

Bouw lokaal een docker-installatiekopieën en push deze desgewenst naar het containerregister dat is gekoppeld aan de werkruimte

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

clone

Kloon het omgevingsobject.

Retourneert een nieuw exemplaar van het omgevingsobject met een nieuwe naam.

clone(new_name)

Parameters

Name	Description
new_name Vereist	str Nieuwe omgevingsnaam

Retouren

Type	Description
Environment	Nieuw omgevingsobject

from_conda_specification

Maak een omgevingsobject op basis van een YAML-bestand met de specificatie van de omgeving.

Zie Omgevingen beheren in de gebruikershandleiding van Conda om een YAML-bestand met de specificatie van de omgeving op te halen.

static from_conda_specification(name, file_path)

Parameters

Name	Description
name Vereist	str De naam van de omgeving.
file_path Vereist	str Het YAML-bestandspad van conda-omgevingsspecificatie.

Retouren

Type	Description
Environment	Het omgevingsobject.

from_docker_build_context

Omgevingsobject maken vanuit een Docker-buildcontext.

static from_docker_build_context(name, docker_build_context)

Parameters

Name	Description
name Vereist	str De naam van de omgeving.
docker_build_context Vereist	DockerBuildContext Het DockerBuildContext-object.

Retouren

Type	Description
Environment	Het omgevingsobject.

from_docker_image

Maak een omgevingsobject op basis van een docker-basisinstallatiekopieën met optionele Python-afhankelijkheden.

De Python-laag wordt toegevoegd aan de omgeving als conda_specification of pip_requirements is opgegeven. conda_specification en pip_requirements sluiten elkaar uit.

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

Parameters

Name	Description
name Vereist	str De naam van de omgeving.
image Vereist	str volledig gekwalificeerde naam van installatiekopieën.
conda_specification	str conda-specificatiebestand. Default value: None
container_registry	ContainerRegistry details van privécontaineropslagplaats. Default value: None
pip_requirements	str pip-vereistenbestand. Default value: None

Retouren

Type	Description
Environment	Het omgevingsobject.

Opmerkingen

Als de basisinstallatiekopie afkomstig is van een privéopslagplaats waarvoor autorisatie is vereist en autorisatie niet is ingesteld op het niveau van de AzureML-werkruimte , is container_registry vereist

from_dockerfile

Maak een omgevingsobject van een Dockerfile met optionele Python-afhankelijkheden.

De Python-laag wordt toegevoegd aan de omgeving als conda_specification of pip_requirements is opgegeven. conda_specification en pip_requirements sluiten elkaar uit.

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

Parameters

Name	Description
name Vereist	str De naam van de omgeving.
dockerfile Vereist	str Dockerfile-inhoud of -pad naar het bestand.
conda_specification	str conda-specificatiebestand. Default value: None
pip_requirements	str pip-vereistenbestand. Default value: None

Retouren

Type	Description
Environment	Het omgevingsobject.

from_existing_conda_environment

Maak een omgevingsobject dat is gemaakt op basis van een lokaal bestaande Conda-omgeving.

Voer uit om een lijst met bestaande Conda-omgevingen op te halen conda env list. Zie Omgevingen beheren in de gebruikershandleiding van Conda voor meer informatie.

static from_existing_conda_environment(name, conda_environment_name)

Parameters

Name	Description
name Vereist	str De naam van de omgeving.
conda_environment_name Vereist	str De naam van een lokaal bestaande Conda-omgeving.

Retouren

Type	Description
Environment	Het omgevingsobject of Geen als het exporteren van het conda-specificatiebestand mislukt.

from_pip_requirements

Maak een omgevingsobject dat is gemaakt op basis van een pip-vereistenbestand.

Losgemaakte pip-afhankelijkheid wordt toegevoegd als pip_version niet is opgegeven.

static from_pip_requirements(name, file_path, pip_version=None)

Parameters

Name	Description
name Vereist	str De naam van de omgeving.
file_path Vereist	str Het pip-vereistenbestandspad.
pip_version	str Pip-versie voor conda-omgeving. Default value: None

Retouren

Type	Description
Environment	Het omgevingsobject.

get

Retourneer het omgevingsobject.

Als label is opgegeven, wordt het object geretourneerd dat eerder is gelabeld met de waarde. Er kan slechts één versie- of labelparameters worden opgegeven. Als beide worden gemist, wordt de nieuwste versie van het object Environment geretourneerd.

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

Parameters

Name	Description
workspace Vereist	Workspace De werkruimte die de omgeving bevat.
name Vereist	str De naam van de omgeving die moet worden geretourneerd.
version	str De versie van de omgeving die moet worden geretourneerd. Default value: None
label	str Waarde van omgevingslabel. Default value: None

Retouren

Type	Description
Environment	Het omgevingsobject.

get_image_details

Retourneer de afbeeldingsdetails.

get_image_details(workspace)

Parameters

Name	Description
workspace Vereist	Workspace De werkruimte.

Retouren

Type	Description
DockerImageDetails	Retourneert de afbeeldingsdetails als dict

label

Label omgevingsobject in uw werkruimte met de opgegeven waarden.

static label(workspace, name, version, labels)

Parameters

Name	Description
workspace Vereist	Workspace De werkruimte
name Vereist	str Omgevingsnaam
version Vereist	str Omgevingsversie
labels Vereist	list[str] Waarden om omgeving te labelen met

list

Retourneert een woordenlijst met omgevingen in de werkruimte.

static list(workspace)

Parameters

Name	Description
workspace Vereist	Workspace De werkruimte waaruit omgevingen moeten worden weergegeven.

Retouren

Type	Description
<xref:builtin.dict>[str, Environment]	Een woordenlijst met omgevingsobjecten.

load_from_directory

Laad een omgevingsdefinitie uit de bestanden in een map.

static load_from_directory(path)

Parameters

Name	Description
path Vereist	str Pad naar de bronmap.

register

Registreer het omgevingsobject in uw werkruimte.

register(workspace)

Parameters

Name	Description
workspace Vereist	Workspace De werkruimte
name Vereist	str

Retouren

Type	Description
Environment	Retourneert het omgevingsobject

save_to_directory

Sla een omgevingsdefinitie op in een map in een eenvoudig bewerkbare indeling.

save_to_directory(path, overwrite=False)

Parameters

Name	Description
path Vereist	str Pad naar de doelmap.
overwrite	bool Als een bestaande map moet worden overschreven. Standaardwaarden onwaar. Default value: False

Kenmerken

environment_variables

Gebruik het object azureml.core.RunConfiguration om runtimevariabelen in te stellen.