Environment Classe
Configura un ambiente Python riproducibile per gli esperimenti di Machine Learning.
Un ambiente definisce pacchetti Python, variabili di ambiente e impostazioni Docker usati negli esperimenti di Machine Learning, tra cui preparazione dei dati, training e distribuzione in un servizio Web. Un ambiente viene gestito e sottoposto a controllo delle versioni in un'istanza di Azure Machine Learning Workspace. È possibile aggiornare un ambiente esistente e recuperare una versione da riutilizzare. Gli ambienti sono esclusivi dell'area di lavoro in cui vengono creati e non possono essere usati in aree di lavoro diverse.
Per altre informazioni sugli ambienti, vedere Creare e gestire ambienti riutilizzabili.
Costruttore Dell'ambiente di classe.
- Ereditarietà
-
azureml._base_sdk_common.abstract_run_config_element._AbstractRunConfigElementEnvironment
Costruttore
Environment(name, **kwargs)Parametri
| Nome | Descrizione |
|---|---|
|
name
Necessario
|
Il nome dell'ambiente. Nota Non avviare il nome dell'ambiente con "Microsoft" o "AzureML". I prefissi "Microsoft" e "AzureML" sono riservati agli ambienti curati. Per altre informazioni sugli ambienti curati, vedere Creare e gestire ambienti riutilizzabili. |
Commenti
Azure Machine Learning offre ambienti curati, che sono ambienti predefiniti che offrono buoni punti di partenza per la creazione di ambienti personalizzati. Gli ambienti curati sono supportati dalle immagini Docker memorizzate nella cache, offrendo un costo di preparazione ridotto per l'esecuzione. Per altre informazioni sugli ambienti curati, vedere Creare e gestire ambienti riutilizzabili.
Esistono diversi modi in cui viene creato l'ambiente in Azure Machine Learning, tra cui quando:
Inizializzare un nuovo oggetto Environment.
Usare uno dei metodi della classe Environment: from_conda_specification, from_pip_requirementso from_existing_conda_environment.
Usare il submit metodo della classe Experiment per inviare un'esecuzione dell'esperimento senza specificare un ambiente, incluso con un Estimator oggetto .
Nell'esempio seguente viene illustrato come creare un'istanza di un nuovo ambiente.
from azureml.core import Environment
myenv = Environment(name="myenv")
È possibile gestire un ambiente registrandolo. In questo modo è possibile tenere traccia delle versioni dell'ambiente e riutilizzarle in esecuzioni future.
myenv.register(workspace=ws)
Per altri esempi sull'uso degli ambienti, vedere la Jupyter Notebook Uso degli ambienti.
Variabili
| Nome | Descrizione |
|---|---|
|
Environment.databricks
|
La sezione configura le dipendenze della libreria azureml.core.databricks.DatabricksSection. |
|
docker
|
In questa sezione vengono configurate le impostazioni correlate all'immagine Docker finale compilata in base alle specifiche dell'ambiente e all'uso di contenitori Docker per compilare l'ambiente. |
|
inferencing_stack_version
|
Questa sezione specifica la versione dello stack di inferenza aggiunta all'immagine. Per evitare di aggiungere uno stack di inferenza, non impostare questo valore. Valore valido: "latest". |
|
python
|
Questa sezione specifica l'ambiente e l'interprete Python da usare nel calcolo di destinazione. |
|
spark
|
La sezione configura le impostazioni di Spark. Si usa solo quando il framework è impostato su PySpark. |
|
r
|
Questa sezione specifica l'ambiente R da usare nel calcolo di destinazione. |
|
version
|
La versione dell'ambiente. |
|
asset_id
|
ID asset. Popola quando viene registrato un ambiente. |
Metodi
| add_private_pip_wheel |
Caricare il file pip wheel privato su disco nel BLOB di archiviazione di Azure collegato all'area di lavoro. Genera un'eccezione se una ruota pip privata con lo stesso nome esiste già nel BLOB di archiviazione dell'area di lavoro. |
| build |
Creare un'immagine Docker per questo ambiente nel cloud. |
| build_local |
Compilare l'ambiente Docker locale o conda. |
| clone |
Clonare l'oggetto ambiente. Restituisce una nuova istanza dell'oggetto ambiente con un nuovo nome. |
| from_conda_specification |
Creare un oggetto ambiente da un file YAML di specifica dell'ambiente. Per ottenere un file YAML di specifica dell'ambiente, vedere Gestione degli ambienti nella guida dell'utente conda. |
| from_docker_build_context |
Creare un oggetto ambiente da un contesto di compilazione Docker. |
| from_docker_image |
Creare un oggetto ambiente da un'immagine docker di base con dipendenze python facoltative. Il livello Python verrà aggiunto all'ambiente se è specificato conda_specification o pip_requirements. conda_specification e pip_requirements si escludono a vicenda. |
| from_dockerfile |
Creare un oggetto ambiente da un Dockerfile con dipendenze python facoltative. Il livello Python verrà aggiunto all'ambiente se è specificato conda_specification o pip_requirements. conda_specification e pip_requirements si escludono a vicenda. |
| from_existing_conda_environment |
Creare un oggetto ambiente creato da un ambiente conda esistente in locale. Per ottenere un elenco di ambienti conda esistenti, eseguire |
| from_pip_requirements |
Creare un oggetto ambiente creato da un file di requisiti pip. La dipendenza pip non bloccata verrà aggiunta se pip_version non è specificato. |
| get |
Restituisce l'oggetto ambiente. Se viene specificata l'etichetta, l'oggetto etichettato in precedenza con il valore verrà restituito. È possibile specificare solo uno dei parametri di versione o etichetta. Se entrambi vengono mancanti, verrà restituita la versione più recente dell'oggetto Environment. |
| get_image_details |
Restituisce i dettagli dell'immagine. |
| label |
Etichettare l'oggetto ambiente nell'area di lavoro con i valori specificati. |
| list |
Restituisce un dizionario contenente gli ambienti nell'area di lavoro. |
| load_from_directory |
Caricare una definizione di ambiente dai file in una directory. |
| register |
Registrare l'oggetto ambiente nell'area di lavoro. |
| save_to_directory |
Salvare una definizione di ambiente in una directory in un formato facilmente modificabile. |
add_private_pip_wheel
Caricare il file pip wheel privato su disco nel BLOB di archiviazione di Azure collegato all'area di lavoro.
Genera un'eccezione se una ruota pip privata con lo stesso nome esiste già nel BLOB di archiviazione dell'area di lavoro.
static add_private_pip_wheel(workspace, file_path, exist_ok=False)Parametri
| Nome | Descrizione |
|---|---|
|
workspace
Necessario
|
Oggetto area di lavoro da usare per registrare la ruota pip privata. |
|
file_path
Necessario
|
Percorso della ruota pip locale su disco, inclusa l'estensione del file. |
|
exist_ok
|
Indica se generare un'eccezione se la ruota esiste già. Valore predefinito: False
|
Restituisce
| Tipo | Descrizione |
|---|---|
|
Restituisce l'URI completo alla rotellina pip caricata nell'archiviazione BLOB di Azure da usare nelle dipendenze conda. |
build
Creare un'immagine Docker per questo ambiente nel cloud.
build(workspace, image_build_compute=None)Parametri
| Nome | Descrizione |
|---|---|
|
workspace
Necessario
|
L'area di lavoro e il relativo Registro Azure Container associato in cui viene archiviata l'immagine. |
|
image_build_compute
|
Nome di calcolo in cui verrà eseguita la compilazione dell'immagine Valore predefinito: None
|
Restituisce
| Tipo | Descrizione |
|---|---|
|
Restituisce l'oggetto dettagli della compilazione dell'immagine. |
build_local
Compilare l'ambiente Docker locale o conda.
build_local(workspace, platform=None, **kwargs)Parametri
| Nome | Descrizione |
|---|---|
|
workspace
Necessario
|
Area di lavoro. |
|
platform
|
Piattaforma. Uno di Linux, Windows o OSX. La piattaforma corrente verrà usata per impostazione predefinita. Valore predefinito: None
|
|
kwargs
Necessario
|
Argomenti di parole chiave avanzati |
Restituisce
| Tipo | Descrizione |
|---|---|
|
Trasmette l'output predefinito Docker o conda alla console. |
Commenti
Gli esempi seguenti illustrano come creare un ambiente locale. Assicurarsi che l'area di lavoro sia creata un'istanza come oggetto azureml.core.workspace.Workspace valido
Creare un ambiente conda locale
from azureml.core import Environment
myenv = Environment(name="myenv")
registered_env = myenv.register(workspace)
registered_env.build_local(workspace)
Creare un ambiente docker locale
from azureml.core import Environment
myenv = Environment(name="myenv")
registered_env = myenv.register(workspace)
registered_env.build_local(workspace, useDocker=True)
Creare un'immagine docker in locale e eseguire il push nel Registro contenitori associato all'area di lavoro
from azureml.core import Environment
myenv = Environment(name="myenv")
registered_env = myenv.register(workspace)
registered_env.build_local(workspace, useDocker=True, pushImageToWorkspaceAcr=True)
clone
Clonare l'oggetto ambiente.
Restituisce una nuova istanza dell'oggetto ambiente con un nuovo nome.
clone(new_name)Parametri
| Nome | Descrizione |
|---|---|
|
new_name
Necessario
|
Nuovo nome dell'ambiente |
Restituisce
| Tipo | Descrizione |
|---|---|
|
Nuovo oggetto ambiente |
from_conda_specification
Creare un oggetto ambiente da un file YAML di specifica dell'ambiente.
Per ottenere un file YAML di specifica dell'ambiente, vedere Gestione degli ambienti nella guida dell'utente conda.
static from_conda_specification(name, file_path)Parametri
| Nome | Descrizione |
|---|---|
|
name
Necessario
|
Nome dell'ambiente. |
|
file_path
Necessario
|
Percorso file YAML della specifica dell'ambiente conda. |
Restituisce
| Tipo | Descrizione |
|---|---|
|
Oggetto ambiente. |
from_docker_build_context
Creare un oggetto ambiente da un contesto di compilazione Docker.
static from_docker_build_context(name, docker_build_context)Parametri
| Nome | Descrizione |
|---|---|
|
name
Necessario
|
Nome dell'ambiente. |
|
docker_build_context
Necessario
|
Oggetto DockerBuildContext. |
Restituisce
| Tipo | Descrizione |
|---|---|
|
Oggetto ambiente. |
from_docker_image
Creare un oggetto ambiente da un'immagine docker di base con dipendenze python facoltative.
Il livello Python verrà aggiunto all'ambiente se è specificato conda_specification o pip_requirements. conda_specification e pip_requirements si escludono a vicenda.
static from_docker_image(name, image, container_registry=None, conda_specification=None, pip_requirements=None)Parametri
| Nome | Descrizione |
|---|---|
|
name
Necessario
|
Nome dell'ambiente. |
|
image
Necessario
|
Nome immagine completo. |
|
conda_specification
|
file di specifica conda. Valore predefinito: None
|
|
container_registry
|
Dettagli del repository del contenitore privato. Valore predefinito: None
|
|
pip_requirements
|
file di requisiti pip. Valore predefinito: None
|
Restituisce
| Tipo | Descrizione |
|---|---|
|
Oggetto ambiente. |
Commenti
Se l'immagine di base è dal repository privato che richiede l'autorizzazione e l'autorizzazione non è impostata sul livello dell'area di lavoro azureML, è necessario container_registry
from_dockerfile
Creare un oggetto ambiente da un Dockerfile con dipendenze python facoltative.
Il livello Python verrà aggiunto all'ambiente se è specificato conda_specification o pip_requirements. conda_specification e pip_requirements si escludono a vicenda.
static from_dockerfile(name, dockerfile, conda_specification=None, pip_requirements=None)Parametri
| Nome | Descrizione |
|---|---|
|
name
Necessario
|
Nome dell'ambiente. |
|
dockerfile
Necessario
|
Contenuto dockerfile o percorso del file. |
|
conda_specification
|
file di specifica conda. Valore predefinito: None
|
|
pip_requirements
|
file di requisiti pip. Valore predefinito: None
|
Restituisce
| Tipo | Descrizione |
|---|---|
|
Oggetto ambiente. |
from_existing_conda_environment
Creare un oggetto ambiente creato da un ambiente conda esistente in locale.
Per ottenere un elenco di ambienti conda esistenti, eseguire conda env list. Per altre informazioni, vedere Gestione degli ambienti nella guida dell'utente conda.
static from_existing_conda_environment(name, conda_environment_name)Parametri
| Nome | Descrizione |
|---|---|
|
name
Necessario
|
Nome dell'ambiente. |
|
conda_environment_name
Necessario
|
Nome di un ambiente conda esistente in locale. |
Restituisce
| Tipo | Descrizione |
|---|---|
|
Oggetto ambiente o None se l'esportazione del file di specifica conda ha esito negativo. |
from_pip_requirements
Creare un oggetto ambiente creato da un file di requisiti pip.
La dipendenza pip non bloccata verrà aggiunta se pip_version non è specificato.
static from_pip_requirements(name, file_path, pip_version=None)Parametri
| Nome | Descrizione |
|---|---|
|
name
Necessario
|
Nome dell'ambiente. |
|
file_path
Necessario
|
Percorso del file dei requisiti pip. |
|
pip_version
|
Versione pip per l'ambiente conda. Valore predefinito: None
|
Restituisce
| Tipo | Descrizione |
|---|---|
|
Oggetto ambiente. |
get
Restituisce l'oggetto ambiente.
Se viene specificata l'etichetta, l'oggetto etichettato in precedenza con il valore verrà restituito. È possibile specificare solo uno dei parametri di versione o etichetta. Se entrambi vengono mancanti, verrà restituita la versione più recente dell'oggetto Environment.
static get(workspace, name, version=None, label=None)Parametri
| Nome | Descrizione |
|---|---|
|
workspace
Necessario
|
Area di lavoro che contiene l'ambiente. |
|
name
Necessario
|
Nome dell'ambiente da restituire. |
|
version
|
Versione dell'ambiente da restituire. Valore predefinito: None
|
|
label
|
Valore dell'etichetta dell'ambiente. Valore predefinito: None
|
Restituisce
| Tipo | Descrizione |
|---|---|
|
Oggetto ambiente. |
get_image_details
Restituisce i dettagli dell'immagine.
get_image_details(workspace)Parametri
| Nome | Descrizione |
|---|---|
|
workspace
Necessario
|
Area di lavoro. |
Restituisce
| Tipo | Descrizione |
|---|---|
|
Restituisce i dettagli dell'immagine come dict |
label
Etichettare l'oggetto ambiente nell'area di lavoro con i valori specificati.
static label(workspace, name, version, labels)Parametri
| Nome | Descrizione |
|---|---|
|
workspace
Necessario
|
L'area di lavoro |
|
name
Necessario
|
Nome ambiente |
|
version
Necessario
|
Versione dell'ambiente |
|
labels
Necessario
|
Valori per etichettare Environment con |
list
Restituisce un dizionario contenente gli ambienti nell'area di lavoro.
static list(workspace)Parametri
| Nome | Descrizione |
|---|---|
|
workspace
Necessario
|
Area di lavoro da cui elencare gli ambienti. |
Restituisce
| Tipo | Descrizione |
|---|---|
|
<xref:builtin.dict>[str, Environment]
|
Dizionario di oggetti ambiente. |
load_from_directory
Caricare una definizione di ambiente dai file in una directory.
static load_from_directory(path)Parametri
| Nome | Descrizione |
|---|---|
|
path
Necessario
|
Percorso della directory di origine. |
register
Registrare l'oggetto ambiente nell'area di lavoro.
register(workspace)Parametri
| Nome | Descrizione |
|---|---|
|
workspace
Necessario
|
L'area di lavoro |
|
name
Necessario
|
|
Restituisce
| Tipo | Descrizione |
|---|---|
|
Restituisce l'oggetto ambiente |
save_to_directory
Salvare una definizione di ambiente in una directory in un formato facilmente modificabile.
save_to_directory(path, overwrite=False)Parametri
| Nome | Descrizione |
|---|---|
|
path
Necessario
|
Percorso della directory di destinazione. |
|
overwrite
|
Se una directory esistente deve essere sovrascritta. Il valore predefinito è false. Valore predefinito: False
|
Attributi
environment_variables
Usare l'oggetto azureml.core.RunConfiguration per impostare le variabili di runtime.