Environment Klasa

Konfiguruje powtarzalne środowisko języka Python na potrzeby eksperymentów uczenia maszynowego.

Środowisko definiuje pakiety języka Python, zmienne środowiskowe i ustawienia platformy Docker, które są używane w eksperymentach uczenia maszynowego, w tym w ramach przygotowywania danych, trenowania i wdrażania w usłudze internetowej. Środowisko jest zarządzane i wersjonowane w usłudze Azure Machine Learning Workspace. Możesz zaktualizować istniejące środowisko i pobrać wersję w celu ponownego użycia. Środowiska są przeznaczone wyłącznie do obszaru roboczego, w ramach którego są tworzone i nie mogą być używane w różnych obszarach roboczych.

Aby uzyskać więcej informacji na temat środowisk, zobacz Tworzenie środowisk wielokrotnego użytku i zarządzanie nimi.

Dziedziczenie
azureml._base_sdk_common.abstract_run_config_element._AbstractRunConfigElement
Environment

Konstruktor

Environment(name, **kwargs)

Parametry

name
string
Wymagane

Nazwa środowiska.

Uwaga

Nie uruchamiaj nazwy środowiska za pomocą ciągu "Microsoft" ani "AzureML". Prefiksy "Microsoft" i "AzureML" są zarezerwowane dla wyselekcjonowanych środowisk. Aby uzyskać więcej informacji na temat wyselekcjonowanych środowisk, zobacz Tworzenie środowisk wielokrotnego użytku i zarządzanie nimi.

Uwagi

Usługa Azure Machine Learning udostępnia wyselekcjonowane środowiska, które są wstępnie zdefiniowanymi środowiskami, które oferują dobre punkty wyjścia do tworzenia własnych środowisk. Wyselekcjonowane środowiska są wspierane przez buforowane obrazy platformy Docker, zapewniając obniżony koszt przygotowania przebiegu. Aby uzyskać więcej informacji na temat wyselekcjonowanych środowisk, zobacz Tworzenie środowisk wielokrotnego użytku i zarządzanie nimi.

Istnieje wiele sposobów tworzenia środowiska w usłudze Azure Machine Learning, w tym podczas wykonywania następujących zadań:

W poniższym przykładzie pokazano, jak utworzyć wystąpienie nowego środowiska.


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

Środowisko można zarządzać, rejestrując je. Dzięki temu można śledzić wersje środowiska i używać ich ponownie w przyszłych uruchomieniach.


   myenv.register(workspace=ws)

Aby uzyskać więcej przykładów pracy ze środowiskami, zobacz Jupyter Notebook Using environments (Korzystanie ze środowisk).

Zmienne

Environment.databricks

Sekcja konfiguruje zależności biblioteki azureml.core.databricks.DatabricksSection.

docker
DockerSection

Ta sekcja umożliwia skonfigurowanie ustawień związanych z końcowym obrazem platformy Docker utworzonym ze specyfikacjami środowiska oraz określenie, czy do kompilowania środowiska mają być używane kontenery platformy Docker.

inferencing_stack_version
string

Ta sekcja określa wersję stosu wnioskowania dodanego do obrazu. Aby uniknąć dodawania stosu wnioskowania, nie ustawiaj tej wartości. Prawidłowa wartość: "latest".

python
PythonSection

Ta sekcja określa, które środowisko języka Python i interpreter mają być używane w docelowym środowisku obliczeniowym.

spark
SparkSection

Sekcja konfiguruje ustawienia platformy Spark. Jest on używany tylko wtedy, gdy platforma jest ustawiona na PySpark.

r
RSection

Ta sekcja określa, które środowisko języka R ma być używane w docelowym środowisku obliczeniowym.

version
string

Wersja środowiska.

asset_id
string

Identyfikator zasobu. Wypełnia się, gdy środowisko jest zarejestrowane.

Metody

add_private_pip_wheel

Przekaż plik prywatnego koła pip na dysku do obiektu blob usługi Azure Storage dołączonego do obszaru roboczego.

Zgłasza wyjątek, jeśli prywatne koło pip o tej samej nazwie już istnieje w obiekcie blob magazynu obszarów roboczych.

build

Utwórz obraz platformy Docker dla tego środowiska w chmurze.

build_local

Skompiluj lokalne środowisko platformy Docker lub conda.

clone

Sklonuj obiekt środowiska.

Zwraca nowe wystąpienie obiektu środowiska o nowej nazwie.

from_conda_specification

Utwórz obiekt środowiska na podstawie pliku YAML specyfikacji środowiska.

Aby uzyskać plik YAML specyfikacji środowiska, zobacz Zarządzanie środowiskami w podręczniku użytkownika środowiska conda.

from_docker_build_context

Utwórz obiekt środowiska na podstawie kontekstu kompilacji platformy Docker.

from_docker_image

Utwórz obiekt środowiska na podstawie podstawowego obrazu platformy Docker z opcjonalnymi zależnościami języka Python.

Warstwa języka Python zostanie dodana do środowiska, jeśli określono conda_specification lub pip_requirements. conda_specification i pip_requirements wzajemnie się wykluczają.

from_dockerfile

Utwórz obiekt środowiska na podstawie pliku Dockerfile z opcjonalnymi zależnościami języka Python.

Warstwa języka Python zostanie dodana do środowiska, jeśli określono conda_specification lub pip_requirements. conda_specification i pip_requirements wzajemnie się wykluczają.

from_existing_conda_environment

Utwórz obiekt środowiska utworzony na podstawie lokalnie istniejącego środowiska conda.

Aby uzyskać listę istniejących środowisk conda, uruchom polecenie conda env list. Aby uzyskać więcej informacji, zobacz Managing environments in the conda user guide ( Zarządzanie środowiskami w podręczniku użytkownika środowiska conda).

from_pip_requirements

Utwórz obiekt środowiska utworzony na podstawie pliku wymagań pip.

Odpiętą zależność pip zostanie dodana, jeśli nie określono pip_version .

get

Zwróć obiekt środowiska.

Jeśli określono etykietę, obiekt wcześniej oznaczony wartością zostanie zwrócony. Można określić tylko jeden z parametrów wersji lub etykiety. Jeśli oba te elementy zostaną pominięte, zostanie zwrócona najnowsza wersja obiektu Environment.

get_image_details

Zwróć szczegóły obrazu.

label

Etykieta obiektu środowiska w obszarze roboczym z określonymi wartościami.

list

Zwróć słownik zawierający środowiska w obszarze roboczym.

load_from_directory

Załaduj definicję środowiska z plików w katalogu.

register

Zarejestruj obiekt środowiska w obszarze roboczym.

save_to_directory

Zapisz definicję środowiska w katalogu w łatwym do edycji formacie.

add_private_pip_wheel

Przekaż plik prywatnego koła pip na dysku do obiektu blob usługi Azure Storage dołączonego do obszaru roboczego.

Zgłasza wyjątek, jeśli prywatne koło pip o tej samej nazwie już istnieje w obiekcie blob magazynu obszarów roboczych.

static add_private_pip_wheel(workspace, file_path, exist_ok=False)

Parametry

workspace
Workspace
Wymagane

Obiekt obszaru roboczego do zarejestrowania prywatnego koła pip.

file_path
str
Wymagane

Ścieżka do lokalnego koła pip na dysku, w tym rozszerzenie pliku.

exist_ok
bool
wartość domyślna: False

Wskazuje, czy zgłosić wyjątek, jeśli koło już istnieje.

Zwraca

Zwraca pełny identyfikator URI do przekazanego koła pip w usłudze Azure Blob Storage do użycia w zależnościach conda.

Typ zwracany

str

build

Utwórz obraz platformy Docker dla tego środowiska w chmurze.

build(workspace, image_build_compute=None)

Parametry

workspace
Workspace
Wymagane

Obszar roboczy i skojarzone z nim Azure Container Registry, w którym jest przechowywany obraz.

image_build_compute
str
wartość domyślna: None

Nazwa obliczeniowa, w której będzie odbywać się kompilacja obrazu

Zwraca

Zwraca obiekt szczegółów kompilacji obrazu.

Typ zwracany

build_local

Skompiluj lokalne środowisko platformy Docker lub conda.

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

Parametry

workspace
Workspace
Wymagane

Obszar roboczy.

platform
str
wartość domyślna: None

Platformy. Jeden z systemów Linux, Windows lub OSX. Bieżąca platforma będzie używana domyślnie.

kwargs
dict
Wymagane

Zaawansowane argumenty słów kluczowych

Zwraca

Przesyła strumieniowo dane wyjściowe kompilowane do konsoli platformy Docker lub conda.

Typ zwracany

str

Uwagi

W poniższych przykładach pokazano, jak utworzyć środowisko lokalne. Upewnij się, że wystąpienie obszaru roboczego jest tworzone jako prawidłowy obiekt azureml.core.workspace.Workspace

Tworzenie lokalnego środowiska conda


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

Kompilowanie lokalnego środowiska platformy Docker


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

Lokalnie skompiluj obraz platformy Docker i opcjonalnie wypchnij go do rejestru kontenerów skojarzonego z obszarem roboczym


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

clone

Sklonuj obiekt środowiska.

Zwraca nowe wystąpienie obiektu środowiska o nowej nazwie.

clone(new_name)

Parametry

new_name
str
Wymagane

Nazwa nowego środowiska

Zwraca

Nowy obiekt środowiska

Typ zwracany

from_conda_specification

Utwórz obiekt środowiska na podstawie pliku YAML specyfikacji środowiska.

Aby uzyskać plik YAML specyfikacji środowiska, zobacz Zarządzanie środowiskami w podręczniku użytkownika środowiska conda.

static from_conda_specification(name, file_path)

Parametry

name
str
Wymagane

Nazwa środowiska.

file_path
str
Wymagane

Ścieżka pliku YAML specyfikacji środowiska conda.

Zwraca

Obiekt środowiska.

Typ zwracany

from_docker_build_context

Utwórz obiekt środowiska na podstawie kontekstu kompilacji platformy Docker.

static from_docker_build_context(name, docker_build_context)

Parametry

name
str
Wymagane

Nazwa środowiska.

docker_build_context
DockerBuildContext
Wymagane

Obiekt DockerBuildContext.

Zwraca

Obiekt środowiska.

Typ zwracany

from_docker_image

Utwórz obiekt środowiska na podstawie podstawowego obrazu platformy Docker z opcjonalnymi zależnościami języka Python.

Warstwa języka Python zostanie dodana do środowiska, jeśli określono conda_specification lub pip_requirements. conda_specification i pip_requirements wzajemnie się wykluczają.

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

Parametry

name
str
Wymagane

Nazwa środowiska.

image
str
Wymagane

w pełni kwalifikowana nazwa obrazu.

conda_specification
str
wartość domyślna: None

plik specyfikacji conda.

container_registry
ContainerRegistry
wartość domyślna: None

szczegóły repozytorium kontenerów prywatnych.

pip_requirements
str
wartość domyślna: None

plik wymagań pip.

Zwraca

Obiekt środowiska.

Typ zwracany

Uwagi

Jeśli obraz podstawowy pochodzi z repozytorium prywatnego, które wymaga autoryzacji, a autoryzacja nie jest ustawiona na poziomie obszaru roboczego usługi AzureML, container_registry jest wymagana

from_dockerfile

Utwórz obiekt środowiska na podstawie pliku Dockerfile z opcjonalnymi zależnościami języka Python.

Warstwa języka Python zostanie dodana do środowiska, jeśli określono conda_specification lub pip_requirements. conda_specification i pip_requirements wzajemnie się wykluczają.

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

Parametry

name
str
Wymagane

Nazwa środowiska.

dockerfile
str
Wymagane

Zawartość pliku Dockerfile lub ścieżka do pliku.

conda_specification
str
wartość domyślna: None

plik specyfikacji conda.

pip_requirements
str
wartość domyślna: None

plik wymagań pip.

Zwraca

Obiekt środowiska.

Typ zwracany

from_existing_conda_environment

Utwórz obiekt środowiska utworzony na podstawie lokalnie istniejącego środowiska conda.

Aby uzyskać listę istniejących środowisk conda, uruchom polecenie conda env list. Aby uzyskać więcej informacji, zobacz Managing environments in the conda user guide ( Zarządzanie środowiskami w podręczniku użytkownika środowiska conda).

static from_existing_conda_environment(name, conda_environment_name)

Parametry

name
str
Wymagane

Nazwa środowiska.

conda_environment_name
str
Wymagane

Nazwa lokalnie istniejącego środowiska Conda.

Zwraca

Obiekt środowiska lub Brak, jeśli eksportowanie pliku specyfikacji conda nie powiedzie się.

Typ zwracany

from_pip_requirements

Utwórz obiekt środowiska utworzony na podstawie pliku wymagań pip.

Odpiętą zależność pip zostanie dodana, jeśli nie określono pip_version .

static from_pip_requirements(name, file_path, pip_version=None)

Parametry

name
str
Wymagane

Nazwa środowiska.

file_path
str
Wymagane

Ścieżka pliku wymagań pip.

pip_version
str
wartość domyślna: None

Wersja narzędzia Pip dla środowiska conda.

Zwraca

Obiekt środowiska.

Typ zwracany

get

Zwróć obiekt środowiska.

Jeśli określono etykietę, obiekt wcześniej oznaczony wartością zostanie zwrócony. Można określić tylko jeden z parametrów wersji lub etykiety. Jeśli oba te elementy zostaną pominięte, zostanie zwrócona najnowsza wersja obiektu Environment.

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

Parametry

workspace
Workspace
Wymagane

Obszar roboczy zawierający środowisko.

name
str
Wymagane

Nazwa środowiska do zwrócenia.

version
str
wartość domyślna: None

Wersja środowiska do zwrócenia.

label
str
wartość domyślna: None

Wartość etykiety środowiska.

Zwraca

Obiekt środowiska.

Typ zwracany

get_image_details

Zwróć szczegóły obrazu.

get_image_details(workspace)

Parametry

workspace
Workspace
Wymagane

Obszar roboczy.

Zwraca

Zwraca szczegóły obrazu jako dykt

Typ zwracany

label

Etykieta obiektu środowiska w obszarze roboczym z określonymi wartościami.

static label(workspace, name, version, labels)

Parametry

workspace
Workspace
Wymagane

Obszar roboczy

name
str
Wymagane

Nazwa środowiska

version
str
Wymagane

Wersja środowiska

labels
list[str]
Wymagane

Wartości do etykietowania Środowisko za pomocą polecenia

list

Zwróć słownik zawierający środowiska w obszarze roboczym.

static list(workspace)

Parametry

workspace
Workspace
Wymagane

Obszar roboczy, z którego mają być wyświetlone środowiska.

Zwraca

Słownik obiektów środowiskowych.

Typ zwracany

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

load_from_directory

Załaduj definicję środowiska z plików w katalogu.

static load_from_directory(path)

Parametry

path
str
Wymagane

Ścieżka do katalogu źródłowego.

register

Zarejestruj obiekt środowiska w obszarze roboczym.

register(workspace)

Parametry

workspace
Workspace
Wymagane

Obszar roboczy

name
str
Wymagane

Zwraca

Zwraca obiekt środowiska

Typ zwracany

save_to_directory

Zapisz definicję środowiska w katalogu w łatwym do edycji formacie.

save_to_directory(path, overwrite=False)

Parametry

path
str
Wymagane

Ścieżka do katalogu docelowego.

overwrite
bool
wartość domyślna: False

Jeśli istniejący katalog powinien zostać zastąpiony. Wartość domyślna to fałsz.

Atrybuty

environment_variables

Użyj obiektu azureml.core.RunConfiguration, aby ustawić zmienne uruchomieniowe.