Environment Osztály

Reprodukálható Python-környezetet konfigurál gépi tanulási kísérletekhez.

A környezet a gépi tanulási kísérletekben használt Python-csomagokat, környezeti változókat és Docker-beállításokat határozza meg, beleértve az adat-előkészítést, a betanítást és a webszolgáltatásban való üzembe helyezést. A környezetek felügyeltek és verziószámozottak az Azure Machine Learningben Workspace. Frissíthet egy meglévő környezetet, és lekérhet egy verziót, hogy újra felhasználhassa. A környezetek kizárólag arra a munkaterületre tartoznak, amelyben létrehozták őket, és nem használhatók a különböző munkaterületeken.

További információ a környezetekről: Újrafelhasználható környezetek létrehozása és kezelése.

Öröklődés
azureml._base_sdk_common.abstract_run_config_element._AbstractRunConfigElement
Environment

Konstruktor

Environment(name, **kwargs)

Paraméterek

name
string
Kötelező

A környezet neve.

Megjegyzés

Ne kezdje el a környezet nevét a "Microsoft" vagy az "AzureML" kifejezéssel. A "Microsoft" és az "AzureML" előtagok válogatott környezetekhez vannak fenntartva. További információ a válogatott környezetekről: Újrafelhasználható környezetek létrehozása és kezelése.

Megjegyzések

Az Azure Machine Learning válogatott környezeteket biztosít, amelyek előre definiált környezetek, amelyek jó kiindulási pontokat kínálnak saját környezetek létrehozásához. A válogatott környezeteket gyorsítótárazott Docker-rendszerképek biztosítják, így alacsonyabb futtatási előkészítési költség érhető el. További információ a válogatott környezetekről: Újrafelhasználható környezetek létrehozása és kezelése.

A környezetek számos módon hozhatók létre az Azure Machine Learningben, többek között az alábbi esetekben:

Az alábbi példa bemutatja, hogyan lehet példányosítani egy új környezetet.


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

A környezetek a regisztrációval kezelhetők. Így nyomon követheti a környezet verzióit, és újra felhasználhatja őket a későbbi futtatások során.


   myenv.register(workspace=ws)

A környezetekkel végzett munkáról további példákat a Jupyter Notebook Környezetek használata című témakörben talál.

Változók

Environment.databricks

A szakasz konfigurálja az azureml.core.databricks.DatabricksSection kódtár függőségeit.

docker
DockerSection

Ez a szakasz konfigurálja a környezet specifikációinak megfelelően létrehozott végső Docker-lemezképhez kapcsolódó beállításokat, valamint azt, hogy Docker-tárolók használatával hozza-e létre a környezetet.

inferencing_stack_version
string

Ez a szakasz a lemezképhez hozzáadott következtetési veremverziót határozza meg. A következtetési verem hozzáadásának elkerülése érdekében ne állítsa be ezt az értéket. Érvényes érték: "latest".

python
PythonSection

Ez a szakasz határozza meg, hogy melyik Python-környezetet és -értelmezőt használja a célszámításhoz.

spark
SparkSection

A szakasz a Spark beállításait konfigurálja. Csak akkor használatos, ha a keretrendszer PySparkra van állítva.

r
RSection

Ez a szakasz a célszámításhoz használandó R-környezetet határozza meg.

version
string

A környezet verziója.

asset_id
string

Eszközazonosító. Feltölti, ha egy környezet regisztrálva van.

Metódusok

add_private_pip_wheel

Töltse fel a lemezen lévő privát pip kerékfájlt a munkaterülethez csatolt Azure Storage-blobba.

Kivételt jelez, ha egy azonos nevű privát pip kerék már létezik a munkaterület tárolóblobjában.

build

Docker-rendszerkép létrehozása ehhez a környezethez a felhőben.

build_local

Hozza létre a helyi Docker- vagy Conda-környezetet.

clone

Klónozza a környezeti objektumot.

A környezeti objektum új példányát adja vissza új névvel.

from_conda_specification

Környezeti objektum létrehozása környezeti specifikációs YAML-fájlból.

A környezet specifikációs YAML-fájljának beszerzéséhez tekintse meg a Környezetek kezelése című témakört a Conda felhasználói útmutatójában.

from_docker_build_context

Hozzon létre környezeti objektumot egy Docker-buildkörnyezetből.

from_docker_image

Környezeti objektum létrehozása alap Docker-rendszerképből választható Python-függőségekkel.

A Python-réteg akkor lesz hozzáadva a környezethez, ha conda_specification vagy pip_requirements van megadva. conda_specification és pip_requirements kölcsönösen kizárják egymást.

from_dockerfile

Hozzon létre környezeti objektumot egy Dockerfile-ból opcionális Python-függőségekkel.

A Python-réteg akkor lesz hozzáadva a környezethez, ha conda_specification vagy pip_requirements van megadva. conda_specification és pip_requirements kölcsönösen kizárják egymást.

from_existing_conda_environment

Hozzon létre egy helyileg meglévő Conda-környezetből létrehozott környezeti objektumot.

A meglévő Conda-környezetek listájának lekéréséhez futtassa a következőt conda env list: . További információ: Környezetek kezelése a Conda felhasználói útmutatójában.

from_pip_requirements

Hozzon létre egy környezeti objektumot egy pip-követelményfájlból.

A rendszer hozzáadja a nem rögzített pip-függőséget, ha nincs megadva pip_version .

get

Adja vissza a környezeti objektumot.

Ha a címke meg van adva, a rendszer a korábban az értékkel címkézett objektumot adja vissza. Csak egy verzió- vagy címkeparaméter adható meg. Ha mindkettő hiányzik, a rendszer a környezeti objektum legújabb verzióját adja vissza.

get_image_details

Adja vissza a kép részleteit.

label

A munkaterületen lévő környezeti objektum címkézése a megadott értékekkel.

list

A munkaterület környezeteit tartalmazó szótárat ad vissza.

load_from_directory

Töltse be a környezetdefiníciót egy könyvtárban lévő fájlokból.

register

Regisztrálja a környezeti objektumot a munkaterületen.

save_to_directory

Egyszerűen szerkeszthető formátumban menthet egy környezetdefiníciót egy könyvtárba.

add_private_pip_wheel

Töltse fel a lemezen lévő privát pip kerékfájlt a munkaterülethez csatolt Azure Storage-blobba.

Kivételt jelez, ha egy azonos nevű privát pip kerék már létezik a munkaterület tárolóblobjában.

static add_private_pip_wheel(workspace, file_path, exist_ok=False)

Paraméterek

workspace
Workspace
Kötelező

A privát pip kerék regisztrálásához használandó munkaterület-objektum.

file_path
str
Kötelező

A lemez helyi pipkerekének elérési útja, beleértve a fájlkiterjesztést is.

exist_ok
bool
alapértelmezett érték: False

Azt jelzi, hogy a rendszer kivételt jelez-e, ha a kerék már létezik.

Válaszok

Visszaadja a teljes URI-t a feltöltött pip kerékre az Azure Blob Storage-ban a Conda-függőségekben való használathoz.

Visszatérési típus

str

build

Docker-rendszerkép létrehozása ehhez a környezethez a felhőben.

build(workspace, image_build_compute=None)

Paraméterek

workspace
Workspace
Kötelező

A munkaterület és a hozzá tartozó Azure Container Registry, ahol a rendszerképet tárolja.

image_build_compute
str
alapértelmezett érték: None

A számítási név, ahol a rendszerkép buildelése történik

Válaszok

A kép buildelési részleteit tartalmazó objektumot adja vissza.

Visszatérési típus

build_local

Hozza létre a helyi Docker- vagy Conda-környezetet.

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

Paraméterek

workspace
Workspace
Kötelező

A munkaterület.

platform
str
alapértelmezett érték: None

Platform. Az egyik Linux, Windows vagy OSX. A rendszer alapértelmezés szerint az aktuális platformot használja.

kwargs
dict
Kötelező

Speciális kulcsszóargumentumok

Válaszok

Streameli a folyamatban lévő Docker- vagy Conda-kimenetet a konzolra.

Visszatérési típus

str

Megjegyzések

Az alábbi példák bemutatják, hogyan hozhat létre helyi környezetet. Győződjön meg arról, hogy a munkaterület példánya érvényes azureml.core.workspace.Workspace objektumként van létrehozva

Helyi Conda-környezet létrehozása


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

Helyi Docker-környezet létrehozása


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

Docker-rendszerkép helyi buildelése és igény szerint leküldése a munkaterülethez társított tárolóregisztrációs adatbázisba


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

clone

Klónozza a környezeti objektumot.

A környezeti objektum új példányát adja vissza új névvel.

clone(new_name)

Paraméterek

new_name
str
Kötelező

Új környezet neve

Válaszok

Új környezeti objektum

Visszatérési típus

from_conda_specification

Környezeti objektum létrehozása környezeti specifikációs YAML-fájlból.

A környezet specifikációs YAML-fájljának beszerzéséhez tekintse meg a Környezetek kezelése című témakört a Conda felhasználói útmutatójában.

static from_conda_specification(name, file_path)

Paraméterek

name
str
Kötelező

A környezet neve.

file_path
str
Kötelező

A Conda-környezet specifikációjának YAML-fájl elérési útja.

Válaszok

A környezeti objektum.

Visszatérési típus

from_docker_build_context

Hozzon létre környezeti objektumot egy Docker-buildkörnyezetből.

static from_docker_build_context(name, docker_build_context)

Paraméterek

name
str
Kötelező

A környezet neve.

docker_build_context
DockerBuildContext
Kötelező

A DockerBuildContext objektum.

Válaszok

A környezeti objektum.

Visszatérési típus

from_docker_image

Környezeti objektum létrehozása alap Docker-rendszerképből választható Python-függőségekkel.

A Python-réteg akkor lesz hozzáadva a környezethez, ha conda_specification vagy pip_requirements van megadva. conda_specification és pip_requirements kölcsönösen kizárják egymást.

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

Paraméterek

name
str
Kötelező

A környezet neve.

image
str
Kötelező

teljes képnév.

conda_specification
str
alapértelmezett érték: None

conda specification file.

container_registry
ContainerRegistry
alapértelmezett érték: None

privát tárolóadattár részletei.

pip_requirements
str
alapértelmezett érték: None

pip requirements file.

Válaszok

A környezeti objektum.

Visszatérési típus

Megjegyzések

Ha az alaprendszerkép hitelesítést igénylő privát adattárból származik, és az engedélyezés nincs beállítva az AzureML-munkaterület szintjén, container_registry szükséges

from_dockerfile

Hozzon létre környezeti objektumot egy Dockerfile-ból opcionális Python-függőségekkel.

A Python-réteg akkor lesz hozzáadva a környezethez, ha conda_specification vagy pip_requirements van megadva. conda_specification és pip_requirements kölcsönösen kizárják egymást.

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

Paraméterek

name
str
Kötelező

A környezet neve.

dockerfile
str
Kötelező

Dockerfile-tartalom vagy a fájl elérési útja.

conda_specification
str
alapértelmezett érték: None

conda specification file.

pip_requirements
str
alapértelmezett érték: None

pip requirements file.

Válaszok

A környezeti objektum.

Visszatérési típus

from_existing_conda_environment

Hozzon létre egy helyileg meglévő Conda-környezetből létrehozott környezeti objektumot.

A meglévő Conda-környezetek listájának lekéréséhez futtassa a következőt conda env list: . További információ: Környezetek kezelése a Conda felhasználói útmutatójában.

static from_existing_conda_environment(name, conda_environment_name)

Paraméterek

name
str
Kötelező

A környezet neve.

conda_environment_name
str
Kötelező

Egy helyileg meglévő Conda-környezet neve.

Válaszok

A környezeti objektum vagy a Nincs, ha a conda specifikációs fájl exportálása sikertelen.

Visszatérési típus

from_pip_requirements

Hozzon létre egy környezeti objektumot egy pip-követelményfájlból.

A rendszer hozzáadja a nem rögzített pip-függőséget, ha nincs megadva pip_version .

static from_pip_requirements(name, file_path, pip_version=None)

Paraméterek

name
str
Kötelező

A környezet neve.

file_path
str
Kötelező

A pip-követelmények fájl elérési útja.

pip_version
str
alapértelmezett érték: None

Pip-verzió a Conda-környezethez.

Válaszok

A környezeti objektum.

Visszatérési típus

get

Adja vissza a környezeti objektumot.

Ha a címke meg van adva, a rendszer a korábban az értékkel címkézett objektumot adja vissza. Csak egy verzió- vagy címkeparaméter adható meg. Ha mindkettő hiányzik, a rendszer a környezeti objektum legújabb verzióját adja vissza.

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

Paraméterek

workspace
Workspace
Kötelező

A környezetet tartalmazó munkaterület.

name
str
Kötelező

A visszaküldött környezet neve.

version
str
alapértelmezett érték: None

A visszatérendő környezet verziója.

label
str
alapértelmezett érték: None

Környezeti címke értéke.

Válaszok

A környezeti objektum.

Visszatérési típus

get_image_details

Adja vissza a kép részleteit.

get_image_details(workspace)

Paraméterek

workspace
Workspace
Kötelező

A munkaterület.

Válaszok

A kép részleteit adja vissza diktálásként

Visszatérési típus

label

A munkaterületen lévő környezeti objektum címkézése a megadott értékekkel.

static label(workspace, name, version, labels)

Paraméterek

workspace
Workspace
Kötelező

A(z)

name
str
Kötelező

Környezet neve

version
str
Kötelező

Környezeti verzió

labels
list[str]
Kötelező

A környezet címkézéséhez használandó értékek

list

A munkaterület környezeteit tartalmazó szótárat ad vissza.

static list(workspace)

Paraméterek

workspace
Workspace
Kötelező

A munkaterület, amelyből a környezeteket listázni szeretné.

Válaszok

A környezeti objektumok szótára.

Visszatérési típus

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

load_from_directory

Töltse be a környezetdefiníciót egy könyvtárban lévő fájlokból.

static load_from_directory(path)

Paraméterek

path
str
Kötelező

A forráskönyvtár elérési útja.

register

Regisztrálja a környezeti objektumot a munkaterületen.

register(workspace)

Paraméterek

workspace
Workspace
Kötelező

A(z)

name
str
Kötelező

Válaszok

A környezeti objektumot adja vissza

Visszatérési típus

save_to_directory

Egyszerűen szerkeszthető formátumban menthet egy környezetdefiníciót egy könyvtárba.

save_to_directory(path, overwrite=False)

Paraméterek

path
str
Kötelező

A célkönyvtár elérési útja.

overwrite
bool
alapértelmezett érték: False

Ha egy meglévő könyvtárat felül kell írni. Alapértelmezés szerint hamis.

Attribútumok

environment_variables

A futtatókörnyezet változóinak beállításához használja az azureml.core.RunConfiguration objektumot.