Environment Třída

Konfiguruje reprodukovatelné prostředí Pythonu pro experimenty strojového učení.

Prostředí definuje balíčky Pythonu, proměnné prostředí a nastavení Dockeru, které se používají v experimentech strojového učení, včetně přípravy dat, trénování a nasazení do webové služby. Prostředí je spravované a s verzí ve službě Azure Machine Learning Workspace. Můžete aktualizovat existující prostředí a načíst verzi pro opakované použití. Prostředí jsou výhradní pro pracovní prostor, ve které jsou vytvořena, a nelze je používat v různých pracovních prostorech.

Další informace o prostředích najdete v tématu Vytváření a správa opakovaně použitelných prostředí.

Konstruktor prostředí třídy.

Dědičnost
azureml._base_sdk_common.abstract_run_config_element._AbstractRunConfigElement
Environment

Konstruktor

Environment(name, **kwargs)

Parametry

name
string
Vyžadováno

Název prostředí.

Poznámka

Nezačínejte název prostředí na "Microsoft" nebo "AzureML". Předpony Microsoft a AzureML jsou vyhrazené pro kurátorovaná prostředí. Další informace o kurátorovaných prostředích najdete v tématu Vytváření a správa opakovaně použitelných prostředí.

Poznámky

Azure Machine Learning poskytuje kurátorovaná prostředí, což jsou předdefinovaná prostředí, která nabízejí dobré výchozí body pro vytváření vlastních prostředí. Kurátorovaná prostředí jsou podporována imagemi Dockeru uloženými v mezipaměti, což snižuje náklady na přípravu spuštění. Další informace o kurátorovaných prostředích najdete v tématu Vytváření a správa opakovaně použitelných prostředí.

Existuje několik způsobů, jak se prostředí ve službě Azure Machine Learning vytváří, včetně následujících:

Následující příklad ukazuje, jak vytvořit instanci nového prostředí.


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

Prostředí můžete spravovat jeho registrací. To vám umožní sledovat verze prostředí a opakovaně je používat v budoucích spuštěních.


   myenv.register(workspace=ws)

Další ukázky práce s prostředími najdete v Jupyter Notebook Používání prostředí.

Proměnné

Environment.databricks

Oddíl konfiguruje závislosti knihovny azureml.core.databricks.DatabricksSection.

docker
DockerSection

Tato část konfiguruje nastavení související s konečnou image Dockeru sestavenou podle specifikací prostředí a to, jestli se mají k sestavení prostředí použít kontejnery Dockeru.

inferencing_stack_version
string

Tato část určuje verzi zásobníku pro odvozování přidanou do image. Pokud se chcete vyhnout přidávání zásobníku odvozování, nenastavujte tuto hodnotu. Platná hodnota: "latest".

python
PythonSection

Tato část určuje, které prostředí Pythonu a interpret se mají použít na cílových výpočetních prostředcích.

spark
SparkSection

Oddíl konfiguruje nastavení Sparku. Používá se pouze v případech, kdy je architektura nastavená na PySpark.

r
RSection

Tato část určuje, které prostředí R se má použít na cílových výpočetních prostředcích.

version
string

Verze prostředí.

asset_id
string

ID prostředku. Naplní se při registraci prostředí.

Metody

add_private_pip_wheel

Nahrajte soubor privátního kola pip na disk do objektu blob úložiště Azure připojeného k pracovnímu prostoru.

Vyvolá výjimku, pokud už v objektu blob úložiště pracovního prostoru existuje privátní kolo pip se stejným názvem.

build

Vytvořte image Dockeru pro toto prostředí v cloudu.

build_local

Sestavte místní prostředí Dockeru nebo Conda.

clone

Naklonujte objekt prostředí.

Vrátí novou instanci objektu prostředí s novým názvem.

from_conda_specification

Vytvořte objekt prostředí ze souboru YAML specifikace prostředí.

Pokud chcete získat soubor YAML se specifikací prostředí, přečtěte si téma Správa prostředí v uživatelské příručce conda.

from_docker_build_context

Vytvořte objekt prostředí z kontextu sestavení Dockeru.

from_docker_image

Vytvořte objekt prostředí ze základní image Dockeru s volitelnými závislostmi pythonu.

Pokud zadáte conda_specification nebo pip_requirements, přidá se do prostředí vrstva Pythonu. conda_specification a pip_requirements se vzájemně vylučují.

from_dockerfile

Vytvořte objekt prostředí ze souboru Dockerfile s volitelnými závislostmi pythonu.

Pokud zadáte conda_specification nebo pip_requirements, přidá se do prostředí vrstva Pythonu. conda_specification a pip_requirements se vzájemně vylučují.

from_existing_conda_environment

Vytvořte objekt prostředí vytvořený z místně existujícího prostředí Conda.

Pokud chcete získat seznam existujících prostředí Conda, spusťte příkaz conda env list. Další informace najdete v tématu Správa prostředí v uživatelské příručce pro conda.

from_pip_requirements

Vytvořte objekt prostředí vytvořený ze souboru požadavků pip.

Pokud není zadána pip_version , přidá se neodepnutá závislost pip.

get

Vraťte objekt prostředí.

Pokud je zadaný popisek, vrátí se objekt dříve označený hodnotou. Lze zadat pouze jeden z parametrů verze nebo popisku. Pokud dojde k vynechání obojího, vrátí se nejnovější verze objektu Environment.

get_image_details

Vraťte podrobnosti o obrázku.

label

Označte objekt prostředí v pracovním prostoru zadanými hodnotami.

list

Vrátí slovník obsahující prostředí v pracovním prostoru.

load_from_directory

Načtěte definici prostředí ze souborů v adresáři.

register

Zaregistrujte objekt prostředí v pracovním prostoru.

save_to_directory

Uložte definici prostředí do adresáře ve snadno upravitelném formátu.

add_private_pip_wheel

Nahrajte soubor privátního kola pip na disk do objektu blob úložiště Azure připojeného k pracovnímu prostoru.

Vyvolá výjimku, pokud už v objektu blob úložiště pracovního prostoru existuje privátní kolo pip se stejným názvem.

static add_private_pip_wheel(workspace, file_path, exist_ok=False)

Parametry

workspace
Workspace
Vyžadováno

Objekt pracovního prostoru, který se má použít k registraci privátního kola pip.

file_path
str
Vyžadováno

Cesta k místnímu kolečku pip na disku, včetně přípony souboru.

exist_ok
bool
výchozí hodnota: False

Určuje, zda se má vyvolat výjimka, pokud už kolečko existuje.

Návraty

Vrátí úplný identifikátor URI pro nahrané kolo pip ve službě Azure Blob Storage pro použití v závislostech conda.

Návratový typ

str

build

Vytvořte image Dockeru pro toto prostředí v cloudu.

build(workspace, image_build_compute=None)

Parametry

workspace
Workspace
Vyžadováno

Pracovní prostor a jeho přidružené Azure Container Registry, kde je image uložená.

image_build_compute
str
výchozí hodnota: None

Název výpočetního prostředí, ve kterém se bude sestavení image provádět

Návraty

Vrátí objekt podrobností o sestavení obrázku.

Návratový typ

build_local

Sestavte místní prostředí Dockeru nebo Conda.

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

Parametry

workspace
Workspace
Vyžadováno

Pracovní prostor.

platform
str
výchozí hodnota: None

Platforma. Jeden z Linuxu, Windows nebo OSX. Ve výchozím nastavení se použije aktuální platforma.

kwargs
dict
Vyžadováno

Rozšířené argumenty klíčových slov

Návraty

Streamuje průběžný výstup Dockeru nebo Conda sestavený do konzoly.

Návratový typ

str

Poznámky

Následující příklady ukazují, jak vytvořit místní prostředí. Ujistěte se, že je pracovní prostor instance jako platný objekt azureml.core.workspace.Workspace.

Vytvoření místního prostředí conda


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

Sestavení místního prostředí Dockeru


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

Sestavte image Dockeru místně a volitelně ji nasdílejte do registru kontejneru přidruženého k pracovnímu prostoru.


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

clone

Naklonujte objekt prostředí.

Vrátí novou instanci objektu prostředí s novým názvem.

clone(new_name)

Parametry

new_name
str
Vyžadováno

Název nového prostředí

Návraty

Nový objekt prostředí

Návratový typ

from_conda_specification

Vytvořte objekt prostředí ze souboru YAML specifikace prostředí.

Pokud chcete získat soubor YAML se specifikací prostředí, přečtěte si téma Správa prostředí v uživatelské příručce conda.

static from_conda_specification(name, file_path)

Parametry

name
str
Vyžadováno

Název prostředí.

file_path
str
Vyžadováno

Cesta k souboru YAML specifikace prostředí Conda.

Návraty

Objekt prostředí.

Návratový typ

from_docker_build_context

Vytvořte objekt prostředí z kontextu sestavení Dockeru.

static from_docker_build_context(name, docker_build_context)

Parametry

name
str
Vyžadováno

Název prostředí.

docker_build_context
DockerBuildContext
Vyžadováno

Objekt DockerBuildContext.

Návraty

Objekt prostředí.

Návratový typ

from_docker_image

Vytvořte objekt prostředí ze základní image Dockeru s volitelnými závislostmi pythonu.

Pokud zadáte conda_specification nebo pip_requirements, přidá se do prostředí vrstva Pythonu. conda_specification a pip_requirements se vzájemně vylučují.

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

Parametry

name
str
Vyžadováno

Název prostředí.

image
str
Vyžadováno

plně kvalifikovaný název image.

conda_specification
str
výchozí hodnota: None

soubor specifikace conda.

container_registry
ContainerRegistry
výchozí hodnota: None

podrobnosti o úložišti privátního kontejneru.

pip_requirements
str
výchozí hodnota: None

pip requirements file.

Návraty

Objekt prostředí.

Návratový typ

Poznámky

Pokud je základní image z privátního úložiště, které vyžaduje autorizaci, a autorizace není nastavená na úrovni pracovního prostoru AzureML, je container_registry povinné.

from_dockerfile

Vytvořte objekt prostředí ze souboru Dockerfile s volitelnými závislostmi pythonu.

Pokud zadáte conda_specification nebo pip_requirements, přidá se do prostředí vrstva Pythonu. conda_specification a pip_requirements se vzájemně vylučují.

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

Parametry

name
str
Vyžadováno

Název prostředí.

dockerfile
str
Vyžadováno

Obsah souboru Dockerfile nebo cesta k souboru

conda_specification
str
výchozí hodnota: None

soubor specifikace conda.

pip_requirements
str
výchozí hodnota: None

pip requirements file.

Návraty

Objekt prostředí.

Návratový typ

from_existing_conda_environment

Vytvořte objekt prostředí vytvořený z místně existujícího prostředí Conda.

Pokud chcete získat seznam existujících prostředí Conda, spusťte příkaz conda env list. Další informace najdete v tématu Správa prostředí v uživatelské příručce pro conda.

static from_existing_conda_environment(name, conda_environment_name)

Parametry

name
str
Vyžadováno

Název prostředí.

conda_environment_name
str
Vyžadováno

Název místně existujícího prostředí Conda.

Návraty

Objekt prostředí nebo None, pokud export souboru specifikace conda selže.

Návratový typ

from_pip_requirements

Vytvořte objekt prostředí vytvořený ze souboru požadavků pip.

Pokud není zadána pip_version , přidá se neodepnutá závislost pip.

static from_pip_requirements(name, file_path, pip_version=None)

Parametry

name
str
Vyžadováno

Název prostředí.

file_path
str
Vyžadováno

Cesta k souboru pip.

pip_version
str
výchozí hodnota: None

Verze Pipu pro prostředí Conda.

Návraty

Objekt prostředí.

Návratový typ

get

Vraťte objekt prostředí.

Pokud je zadaný popisek, vrátí se objekt dříve označený hodnotou. Lze zadat pouze jeden z parametrů verze nebo popisku. Pokud dojde k vynechání obojího, vrátí se nejnovější verze objektu Environment.

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

Parametry

workspace
Workspace
Vyžadováno

Pracovní prostor, který obsahuje prostředí.

name
str
Vyžadováno

Název prostředí, které se má vrátit.

version
str
výchozí hodnota: None

Verze prostředí, která se má vrátit.

label
str
výchozí hodnota: None

Hodnota popisku prostředí.

Návraty

Objekt prostředí.

Návratový typ

get_image_details

Vraťte podrobnosti o obrázku.

get_image_details(workspace)

Parametry

workspace
Workspace
Vyžadováno

Pracovní prostor.

Návraty

Vrátí podrobnosti o obrázku jako dikt.

Návratový typ

label

Označte objekt prostředí v pracovním prostoru zadanými hodnotami.

static label(workspace, name, version, labels)

Parametry

workspace
Workspace
Vyžadováno

U pracovního prostoru

name
str
Vyžadováno

Název prostředí

version
str
Vyžadováno

Verze prostředí

labels
list[str]
Vyžadováno

Hodnoty k označení Prostředí pomocí

list

Vrátí slovník obsahující prostředí v pracovním prostoru.

static list(workspace)

Parametry

workspace
Workspace
Vyžadováno

Pracovní prostor, ze kterého chcete vypsat prostředí.

Návraty

Slovník objektů prostředí.

Návratový typ

<xref:builtin.dict>[str, Environment]

load_from_directory

Načtěte definici prostředí ze souborů v adresáři.

static load_from_directory(path)

Parametry

path
str
Vyžadováno

Cesta ke zdrojovému adresáři.

register

Zaregistrujte objekt prostředí v pracovním prostoru.

register(workspace)

Parametry

workspace
Workspace
Vyžadováno

U pracovního prostoru

name
str
Vyžadováno

Návraty

Vrátí objekt prostředí.

Návratový typ

save_to_directory

Uložte definici prostředí do adresáře ve snadno upravitelném formátu.

save_to_directory(path, overwrite=False)

Parametry

path
str
Vyžadováno

Cesta k cílovému adresáři.

overwrite
bool
výchozí hodnota: False

Pokud by měl být existující adresář přepsán. Výchozí hodnota false.

Atributy

environment_variables

K nastavení proměnných modulu runtime použijte objekt azureml.core.RunConfiguration.