Environment Klass

Referens

Konfigurerar en reproducerbar Python-miljö för maskininlärningsexperiment.

En miljö definierar Python-paket, miljövariabler och Docker-inställningar som används i maskininlärningsexperiment, inklusive i förberedelse, träning och distribution av data till en webbtjänst. En miljö hanteras och versionshanteras i en Azure Machine Learning Workspace. Du kan uppdatera en befintlig miljö och hämta en version som ska återanvändas. Miljöer är exklusiva för arbetsytan som de skapas i och kan inte användas på olika arbetsytor.

Mer information om miljöer finns i Skapa och hantera återanvändbara miljöer.

Konstruktor för klassmiljö.

Arv: azureml._base_sdk_common.abstract_run_config_element._AbstractRunConfigElement

Environment

Konstruktor

Environment(name, **kwargs)

Parametrar

Name	Description
name Obligatorisk	string Namnet på miljön. Anteckning Starta inte ditt miljönamn med "Microsoft" eller "AzureML". Prefixen "Microsoft" och "AzureML" är reserverade för organiserade miljöer. Mer information om organiserade miljöer finns i Skapa och hantera återanvändbara miljöer.

Kommentarer

Azure Machine Learning tillhandahåller organiserade miljöer, som är fördefinierade miljöer som erbjuder bra utgångspunkter för att skapa egna miljöer. Organiserade miljöer backas upp av cachelagrade Docker-avbildningar, vilket ger en lägre kostnad för körningsförberedelse. Mer information om organiserade miljöer finns i Skapa och hantera återanvändbara miljöer.

Det finns ett antal sätt att skapa miljöer i Azure Machine Learning, bland annat när du:

Initiera ett nytt miljöobjekt.
Använd någon av miljöklassmetoderna: from_conda_specification, from_pip_requirementseller from_existing_conda_environment.
submit Använd metoden i experimentklassen för att skicka en experimentkörning utan att ange en miljö, inklusive med ett Estimator -objekt.

I följande exempel visas hur du instansierar en ny miljö.


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

Du kan hantera en miljö genom att registrera den. På så sätt kan du spåra miljöns versioner och återanvända dem i framtida körningar.


   myenv.register(workspace=ws)

Fler exempel på hur du arbetar med miljöer finns i Jupyter Notebook Använda miljöer.

Variabler

Name	Description
Environment.databricks	Avsnittet konfigurerar biblioteksberoenden för azureml.core.databricks.DatabricksSection.
docker	DockerSection Det här avsnittet konfigurerar inställningar relaterade till den slutliga Docker-avbildningen som skapats enligt miljöspecifikationerna och om du vill använda Docker-containrar för att skapa miljön.
inferencing_stack_version	string Det här avsnittet anger den version av slutsatsdragningsstacken som lagts till i avbildningen. Om du vill undvika att lägga till en slutsatsdragningsstack ska du inte ange det här värdet. Giltigt värde: "senaste".
python	PythonSection Det här avsnittet anger vilken Python-miljö och -tolk som ska användas för målberäkningen.
spark	SparkSection Avsnittet konfigurerar Spark-inställningar. Det används bara när ramverket är inställt på PySpark.
r	RSection Det här avsnittet anger vilken R-miljö som ska användas för målberäkningen.
version	string Versionen av miljön.
asset_id	string Tillgångs-ID. Fyller i när en miljö har registrerats.

Metoder

add_private_pip_wheel	Ladda upp den privata piphjulsfilen på disken till Azure Storage-bloben som är kopplad till arbetsytan. Utlöser ett undantag om det redan finns ett privat piphjul med samma namn i arbetsytans lagringsblob.
build	Skapa en Docker-avbildning för den här miljön i molnet.
build_local	Skapa den lokala Docker- eller conda-miljön.
clone	Klona miljöobjektet. Returnerar en ny instans av miljöobjektet med ett nytt namn.
from_conda_specification	Skapa miljöobjekt från en YAML-fil för miljöspecifikation. Information om hur du hämtar en YAML-fil för miljöspecifikation finns i Hantera miljöer i användarhandboken för conda.
from_docker_build_context	Skapa miljöobjekt från en Docker-byggkontext.
from_docker_image	Skapa miljöobjekt från en grundläggande Docker-avbildning med valfria Python-beroenden. Python-lagret läggs till i miljön om conda_specification eller pip_requirements anges. conda_specification och pip_requirements utesluter varandra.
from_dockerfile	Skapa miljöobjekt från en Dockerfile med valfria Python-beroenden. Python-lagret läggs till i miljön om conda_specification eller pip_requirements anges. conda_specification och pip_requirements utesluter varandra.
from_existing_conda_environment	Skapa ett miljöobjekt som skapats från en lokalt befintlig Conda-miljö. Om du vill hämta en lista över befintliga conda-miljöer kör du `conda env list`. Mer information finns i Hantera miljöer i användarhandboken för Conda.
from_pip_requirements	Skapa ett miljöobjekt som skapats från en pip-kravfil. Ej fästa pip-beroenden läggs till om pip_version inte har angetts.
get	Returnera miljöobjektet. Om etiketten anges returneras objektet som tidigare märkts med värdet. Endast en av version- eller etikettparametrarna kan anges. Om båda missas returneras den senaste versionen av miljöobjektet.
get_image_details	Returnera bildinformationen.
label	Märk miljöobjektet på arbetsytan med de angivna värdena.
list	Returnera en ordlista som innehåller miljöer på arbetsytan.
load_from_directory	Läs in en miljödefinition från filerna i en katalog.
register	Registrera miljöobjektet på din arbetsyta.
save_to_directory	Spara en miljödefinition i en katalog i ett enkelt redigerbart format.

add_private_pip_wheel

Ladda upp den privata piphjulsfilen på disken till Azure Storage-bloben som är kopplad till arbetsytan.

Utlöser ett undantag om det redan finns ett privat piphjul med samma namn i arbetsytans lagringsblob.

static add_private_pip_wheel(workspace, file_path, exist_ok=False)

Parametrar

Name	Description
workspace Obligatorisk	Workspace Arbetsyteobjektet som ska användas för att registrera det privata piphjulet.
file_path Obligatorisk	str Sökväg till det lokala piphjulet på disken, inklusive filnamnstillägget.
exist_ok	bool Anger om ett undantag ska utlösas om hjulet redan finns. Standardvärde: False

Returer

Typ	Description
str	Returnerar den fullständiga URI:n till det uppladdade pip-hjulet på Azure Blob Storage som ska användas i conda-beroenden.

build

Skapa en Docker-avbildning för den här miljön i molnet.

build(workspace, image_build_compute=None)

Parametrar

Name	Description
workspace Obligatorisk	Workspace Arbetsytan och dess associerade Azure Container Registry där avbildningen lagras.
image_build_compute	str Beräkningsnamnet där avbildningsversionen ska äga rum Standardvärde: None

Returer

Typ	Description
ImageBuildDetails	Returnerar objektet för avbildningsbyggesinformation.

build_local

Skapa den lokala Docker- eller conda-miljön.

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

Parametrar

Name	Description
workspace Obligatorisk	Workspace Arbetsytan.
platform	str Plattform. En av Linux, Windows eller OSX. Den aktuella plattformen används som standard. Standardvärde: None
kwargs Obligatorisk	dict Avancerade nyckelordsargument

Returer

Typ	Description
str	Strömmar de löpande Docker- eller Conda-skapade utdata till konsolen.

Kommentarer

I följande exempel visas hur du skapar en lokal miljö. Kontrollera att arbetsytan instansieras som ett giltigt azureml.core.workspace.Workspace-objekt

Skapa lokal conda-miljö


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

Skapa en lokal Docker-miljö


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

Skapa Docker-avbildning lokalt och push-överföra den till containerregistret som är associerat med arbetsytan


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

clone

Klona miljöobjektet.

Returnerar en ny instans av miljöobjektet med ett nytt namn.

clone(new_name)

Parametrar

Name	Description
new_name Obligatorisk	str Nytt miljönamn

Returer

Typ	Description
Environment	Nytt miljöobjekt

from_conda_specification

Skapa miljöobjekt från en YAML-fil för miljöspecifikation.

Information om hur du hämtar en YAML-fil för miljöspecifikation finns i Hantera miljöer i användarhandboken för conda.

static from_conda_specification(name, file_path)

Parametrar

Name	Description
name Obligatorisk	str Miljönamnet.
file_path Obligatorisk	str YAML-filsökvägen för conda-miljöspecifikationen.

Returer

Typ	Description
Environment	Miljöobjektet.

from_docker_build_context

Skapa miljöobjekt från en Docker-byggkontext.

static from_docker_build_context(name, docker_build_context)

Parametrar

Name	Description
name Obligatorisk	str Miljönamnet.
docker_build_context Obligatorisk	DockerBuildContext DockerBuildContext-objektet.

Returer

Typ	Description
Environment	Miljöobjektet.

from_docker_image

Skapa miljöobjekt från en grundläggande Docker-avbildning med valfria Python-beroenden.

Python-lagret läggs till i miljön om conda_specification eller pip_requirements anges. conda_specification och pip_requirements utesluter varandra.

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

Parametrar

Name	Description
name Obligatorisk	str Miljönamnet.
image Obligatorisk	str fullständigt kvalificerat avbildningsnamn.
conda_specification	str conda-specifikationsfil. Standardvärde: None
container_registry	ContainerRegistry information om lagringsplatsen för privata containrar. Standardvärde: None
pip_requirements	str pip requirements-fil. Standardvärde: None

Returer

Typ	Description
Environment	Miljöobjektet.

Kommentarer

Om basavbildningen kommer från en privat lagringsplats som kräver auktorisering och auktorisering inte har angetts på AzureML-arbetsytenivå krävs container_registry

from_dockerfile

Skapa miljöobjekt från en Dockerfile med valfria Python-beroenden.

Python-lagret läggs till i miljön om conda_specification eller pip_requirements anges. conda_specification och pip_requirements utesluter varandra.

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

Parametrar

Name	Description
name Obligatorisk	str Miljönamnet.
dockerfile Obligatorisk	str Dockerfile-innehåll eller sökväg till filen.
conda_specification	str conda-specifikationsfil. Standardvärde: None
pip_requirements	str pip requirements-fil. Standardvärde: None

Returer

Typ	Description
Environment	Miljöobjektet.

from_existing_conda_environment

Skapa ett miljöobjekt som skapats från en lokalt befintlig Conda-miljö.

Om du vill hämta en lista över befintliga conda-miljöer kör du conda env list. Mer information finns i Hantera miljöer i användarhandboken för Conda.

static from_existing_conda_environment(name, conda_environment_name)

Parametrar

Name	Description
name Obligatorisk	str Miljönamnet.
conda_environment_name Obligatorisk	str Namnet på en lokalt befintlig conda-miljö.

Returer

Typ	Description
Environment	Miljöobjektet eller Ingen om det inte går att exportera conda-specifikationsfilen.

from_pip_requirements

Skapa ett miljöobjekt som skapats från en pip-kravfil.

Ej fästa pip-beroenden läggs till om pip_version inte har angetts.

static from_pip_requirements(name, file_path, pip_version=None)

Parametrar

Name	Description
name Obligatorisk	str Miljönamnet.
file_path Obligatorisk	str Sökvägen till pip-kravfilen.
pip_version	str Pip-version för Conda-miljön. Standardvärde: None

Returer

Typ	Description
Environment	Miljöobjektet.

get

Returnera miljöobjektet.

Om etiketten anges returneras objektet som tidigare märkts med värdet. Endast en av version- eller etikettparametrarna kan anges. Om båda missas returneras den senaste versionen av miljöobjektet.

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

Parametrar

Name	Description
workspace Obligatorisk	Workspace Arbetsytan som innehåller miljön.
name Obligatorisk	str Namnet på den miljö som ska returneras.
version	str Den version av miljön som ska returneras. Standardvärde: None
label	str Miljöetikettvärde. Standardvärde: None

Returer

Typ	Description
Environment	Miljöobjektet.

get_image_details

Returnera bildinformationen.

get_image_details(workspace)

Parametrar

Name	Description
workspace Obligatorisk	Workspace Arbetsytan.

Returer

Typ	Description
DockerImageDetails	Returnerar bildinformationen som diktamen

label

Märk miljöobjektet på arbetsytan med de angivna värdena.

static label(workspace, name, version, labels)

Parametrar

Name	Description
workspace Obligatorisk	Workspace Arbetsytan
name Obligatorisk	str Miljönamn
version Obligatorisk	str Miljöversion
labels Obligatorisk	list[str] Värden att märka miljö med

list

Returnera en ordlista som innehåller miljöer på arbetsytan.

static list(workspace)

Parametrar

Name	Description
workspace Obligatorisk	Workspace Arbetsytan som miljöer ska listas från.

Returer

Typ	Description
<xref:builtin.dict>[str, Environment]	En ordlista med miljöobjekt.

load_from_directory

Läs in en miljödefinition från filerna i en katalog.

static load_from_directory(path)

Parametrar

Name	Description
path Obligatorisk	str Sökväg till källkatalogen.

register

Registrera miljöobjektet på din arbetsyta.

register(workspace)

Parametrar

Name	Description
workspace Obligatorisk	Workspace Arbetsytan
name Obligatorisk	str

Returer

Typ	Description
Environment	Returnerar miljöobjektet

save_to_directory

Spara en miljödefinition i en katalog i ett enkelt redigerbart format.

save_to_directory(path, overwrite=False)

Parametrar

Name	Description
path Obligatorisk	str Sökväg till målkatalogen.
overwrite	bool Om en befintlig katalog ska skrivas över. Standardvärdet är falskt. Standardvärde: False

Attribut

environment_variables

Använd objektet azureml.core.RunConfiguration för att ange körningsvariabler.

Dela via

Environment Klass

Konstruktor

Parametrar

Kommentarer

Variabler

Metoder

add_private_pip_wheel

Parametrar

Returer

build

Parametrar

Returer

build_local

Parametrar

Returer

Kommentarer

clone

Parametrar

Returer

from_conda_specification

Parametrar

Returer

from_docker_build_context

Parametrar

Returer

from_docker_image

Parametrar

Returer

Kommentarer

from_dockerfile

Parametrar

Returer

from_existing_conda_environment

Parametrar

Returer

from_pip_requirements

Parametrar

Returer

get

Parametrar

Returer

get_image_details

Parametrar

Returer

label

Parametrar

list

Parametrar

Returer

load_from_directory

Parametrar

register

Parametrar

Returer

save_to_directory

Parametrar

Attribut

environment_variables

Feedback

Ytterligare resurser