DatabricksStep Clase
Crea un paso de canalización de Azure Machine Learning para agregar un cuaderno de DataBricks, un script de Python o un archivo JAR como nodo.
Para obtener un ejemplo del uso de DatabricksStep, consulte el cuaderno https://aka.ms/pl-databricks.
Cree un paso de canalización de Azure ML para agregar un cuaderno de DataBricks, un script de Python o un archivo JAR como nodo.
Para obtener un ejemplo del uso de DatabricksStep, consulte el cuaderno https://aka.ms/pl-databricks.
:p aram python_script_name:[Obligatorio] Nombre de un script de Python relativo a source_directory
.
Si el script toma entradas y salidas, se pasarán al script como parámetros.
Si se especifica python_script_name
, también se debe especificar source_directory
.
Especifique exactamente uno entre notebook_path
, python_script_path
, python_script_name
o main_class_name
.
Si especifica un objeto DataReference como entrada con data_reference_name=input1 y un objeto PipelineData como salida con name=output1, las entradas y salidas se pasarán al script como parámetros. Este será su aspecto y tendrá que analizar los argumentos del script para acceder a las rutas de acceso de cada entrada y salida: "-input1","wasbs://test@storagename.blob.core.windows.net/test","-output1", "wasbs://test@storagename.blob.core.windows.net/b3e26de1-87a4-494d-a20f-1988d22b81a2/output1"
Además, los parámetros siguientes estarán disponibles en el script:
- AZUREML_RUN_TOKEN: token de AML para autenticarse con Azure Machine Learning.
- AZUREML_RUN_TOKEN_EXPIRY: hora de expiración del token de AML.
- AZUREML_RUN_ID: identificador de ejecución de Azure Machine Learning para esta ejecución.
- AZUREML_ARM_SUBSCRIPTION: suscripción de Azure del área de trabajo de AML.
- AZUREML_ARM_RESOURCEGROUP: grupo de recursos de Azure del área de trabajo de Azure Machine Learning.
- AZUREML_ARM_WORKSPACE_NAME: nombre del área de trabajo de Azure Machine Learning.
- AZUREML_ARM_PROJECT_NAME: nombre del experimento de Azure Machine Learning.
- AZUREML_SERVICE_ENDPOINT: dirección URL del punto de conexión de los servicios de AML.
- AZUREML_WORKSPACE_ID: id. del área de trabajo de Azure Machine Learning.
- AZUREML_EXPERIMENT_ID: id. del experimento de Azure Machine Learning.
- AZUREML_SCRIPT_DIRECTORY_NAME: ruta de acceso de directorios en DBFS donde se ha copiado source_directory.
(This parameter is only populated when `python_script_name` is used. See more details below.)
Al ejecutar un script de Python desde la máquina local en Databricks con los parámetros source_directory
y python_script_name
de Databricks, se copia source_directory en DBFS y la ruta de acceso de directorios en DBFS se pasa como un parámetro al script cuando comienza la ejecución.
Este parámetro se etiqueta como --AZUREML_SCRIPT_DIRECTORY_NAME. Debe agregar un prefijo con la cadena "dbfs:/". o "/dbfs/" para acceder al directorio en DBFS.
- Herencia
-
azureml.pipeline.core._databricks_step_base._DatabricksStepBaseDatabricksStep
Constructor
DatabricksStep(name, inputs=None, outputs=None, existing_cluster_id=None, spark_version=None, node_type=None, instance_pool_id=None, num_workers=None, min_workers=None, max_workers=None, spark_env_variables=None, spark_conf=None, init_scripts=None, cluster_log_dbfs_path=None, notebook_path=None, notebook_params=None, python_script_path=None, python_script_params=None, main_class_name=None, jar_params=None, python_script_name=None, source_directory=None, hash_paths=None, run_name=None, timeout_seconds=None, runconfig=None, maven_libraries=None, pypi_libraries=None, egg_libraries=None, jar_libraries=None, rcran_libraries=None, compute_target=None, allow_reuse=True, version=None, permit_cluster_restart=None)
Parámetros
Nombre | Description |
---|---|
name
Requerido
|
[Obligatorio] Nombre del paso. |
inputs
|
Lista de conexiones de entrada para los datos consumidos por este paso. Recupera esto dentro del cuaderno mediante dbutils.widgets.get("input_name"). Puede ser un elemento DataReference o PipelineData. DataReference representa un fragmento de datos existente en un almacén de datos. Básicamente, se trata de una ruta de acceso en un almacén de datos. DatabricksStep admite almacenes de datos que encapsulan DBFS, blobs de Azure o ADLS v1. PipelineData representa los datos intermedios generados por otro paso de una canalización. Valor predeterminado: None
|
outputs
|
Lista de definiciones de puerto de salida para las salidas producidas por este paso. Recupera esto dentro del cuaderno mediante dbutils.widgets.get("output_name"). Debe ser un elemento PipelineData. Valor predeterminado: None
|
existing_cluster_id
|
Identificador de un clúster interactivo existente en el área de trabajo de Databricks. Si va a pasar este parámetro, no puede pasar ninguno de los parámetros siguientes, que se usan para crear un nuevo clúster:
Nota: Para crear un nuevo clúster de trabajos, deberá pasar los parámetros anteriores. Puede pasar estos parámetros directamente o puede pasarlos como parte del objeto RunConfiguration mediante el parámetro runconfig. Si se pasan estos parámetros directamente y mediante RunConfiguration, se produce un error. Valor predeterminado: None
|
spark_version
|
La versión de Spark para el clúster de ejecución de Databricks, por ejemplo: "10.4.x-scala2.12".
Para más información, consulte la descripción del parámetro Valor predeterminado: None
|
node_type
|
[Obligatorio] Tipos de nodo de máquina virtual de Azure para el clúster de ejecución de Databricks, por ejemplo: "Standard_D3_v2". Especifique Valor predeterminado: None
|
instance_pool_id
|
[Obligatorio] Identificador del grupo de instancias al que se debe asociar el clúster.
Especifique Valor predeterminado: None
|
num_workers
|
[Obligatorio] Número estático de nodos de trabajo para el clúster de ejecución de Databricks.
Debe especificar Valor predeterminado: None
|
min_workers
|
[Obligatorio] Número mínimo de nodos de trabajo que se usarán para el escalado automático del clúster de ejecución de Databricks.
Debe especificar Valor predeterminado: None
|
max_workers
|
[Obligatorio] Número máximo de nodos de trabajo que se usarán para el escalado automático del clúster de ejecución de Databricks.
Debe especificar Valor predeterminado: None
|
spark_env_variables
|
Variables de entorno de Spark para el clúster de ejecución de Databricks.
Para más información, consulte la descripción del parámetro Valor predeterminado: None
|
spark_conf
|
Configuración de Spark para el clúster de ejecución de Databricks.
Para más información, consulte la descripción del parámetro Valor predeterminado: None
|
init_scripts
|
[str]
Desusado. Databricks anunció que el script de inicialización almacenado en DBFS dejará de funcionar después del 1 de dic de 2023. Para mitigar el problema, use scripts de inicialización globales en databricks después https://learn.microsoft.com/azure/databricks/init-scripts/global de 2) convierta en comentario la línea de init_scripts en el paso de Databricks de AzureML. Valor predeterminado: None
|
cluster_log_dbfs_path
|
Rutas de acceso DBFS donde se van a entregar los registros de los clústeres. Valor predeterminado: None
|
notebook_path
|
[Obligatorio] Ruta de acceso al cuaderno en la instancia de Databricks. Esta clase permite cuatro maneras de especificar el código que se va a ejecutar en el clúster de Databricks.
Especifique exactamente uno entre Valor predeterminado: None
|
notebook_params
|
Diccionario de parámetros que se van a pasar al cuaderno. Los elementos Valor predeterminado: None
|
python_script_path
|
[Obligatorio] Ruta de acceso al script de Python en DBFS.
Especifique exactamente uno entre Valor predeterminado: None
|
python_script_params
|
Parámetros para el script de Python. Valor predeterminado: None
|
main_class_name
|
[Obligatorio] Nombre del punto de entrada en un módulo JAR.
Especifique exactamente uno entre Valor predeterminado: None
|
jar_params
|
Parámetros del módulo JAR. Valor predeterminado: None
|
python_script_name
|
[Obligatorio] Nombre de un script de Python relativo a Especifique exactamente uno entre Si especifica un objeto DataReference como entrada con data_reference_name=input1 y un objeto PipelineData como salida con name=output1, las entradas y salidas se pasarán al script como parámetros. Este será su aspecto y tendrá que analizar los argumentos del script para acceder a las rutas de acceso de cada entrada y salida: "-input1","wasbs://test@storagename.blob.core.windows.net/test","-output1", "wasbs://test@storagename.blob.core.windows.net/b3e26de1-87a4-494d-a20f-1988d22b81a2/output1" Además, los parámetros siguientes estarán disponibles en el script:
Al ejecutar un script de Python desde la máquina local en Databricks con los parámetros Valor predeterminado: None
|
source_directory
|
Carpeta que contiene el script y otros archivos.
Si se especifica Valor predeterminado: None
|
hash_paths
|
[str]
EN DESUSO: ya no es necesario. Una lista de rutas de acceso a hash al comprobar si hay cambios en el contenido del paso. Si no se detecta ningún cambio, la canalización reutilizará el contenido del paso de una ejecución anterior. De manera predeterminada, se aplica un algoritmo hash al contenido de Valor predeterminado: None
|
run_name
|
El nombre en Databricks de esta ejecución. Valor predeterminado: None
|
timeout_seconds
|
Tiempo de espera para la ejecución de Databricks. Valor predeterminado: None
|
runconfig
|
Elemento runconfig que se va a usar. Nota: Puede pasar tantas bibliotecas como quiera como dependencias a su trabajo mediante los parámetros siguientes: Valor predeterminado: None
|
maven_libraries
|
Bibliotecas de Maven que se usarán para la ejecución de Databricks. Valor predeterminado: None
|
pypi_libraries
|
Bibliotecas de PyPi que se usarán para la ejecución de Databricks. Valor predeterminado: None
|
egg_libraries
|
Bibliotecas de Egg que se usarán para la ejecución de Databricks. Valor predeterminado: None
|
jar_libraries
|
Bibliotecas Jar que se usarán para la ejecución de Databricks. Valor predeterminado: None
|
rcran_libraries
|
Bibliotecas de RCran que se usarán para la ejecución de Databricks. Valor predeterminado: None
|
compute_target
|
[Obligatorio] Un recurso de proceso de Azure Databricks. Para poder usar DatabricksStep para ejecutar los scripts o los cuadernos en un área de trabajo de Azure Databricks, debe agregar el área de trabajo de Azure Databricks como destino de proceso al área de trabajo de Azure Machine Learning. Valor predeterminado: None
|
allow_reuse
|
Indica si el paso debe volver a usar los resultados anteriores cuando se vuelve a ejecutar con la misma configuración. La reutilización está habilitada de manera predeterminada. Si el contenido del paso (scripts o dependencias), así como las entradas y los parámetros permanecen sin cambios, se reutiliza la salida de la ejecución anterior de este paso. Al volver a usar el paso, en lugar de enviar el trabajo al proceso, los resultados de la ejecución anterior se hacen disponibles inmediatamente para los pasos posteriores. Si usa conjuntos de datos de Azure Machine Learning como entradas, la reutilización viene determinada por si la definición del conjunto de datos ha cambiado, no por si los datos subyacentes han cambiado. Valor predeterminado: True
|
version
|
Etiqueta de versión opcional para indicar un cambio en la funcionalidad del paso. Valor predeterminado: None
|
permit_cluster_restart
|
Si se especifica existing_cluster_id, este parámetro indica si el clúster se puede reiniciar en nombre del usuario. Valor predeterminado: None
|
name
Requerido
|
[Obligatorio] El nombre del paso. |
inputs
Requerido
|
Lista de conexiones de entrada para los datos consumidos por este paso. Recupera esto dentro del cuaderno mediante dbutils.widgets.get("input_name"). Puede ser un elemento DataReference o PipelineData. DataReference representa un fragmento de datos existente en un almacén de datos. Básicamente, se trata de una ruta de acceso en un almacén de datos. DatabricksStep admite almacenes de datos que encapsulan DBFS, blob de Azure o ADLS v1. PipelineData representa los datos intermedios generados por otro paso de una canalización. |
outputs
Requerido
|
list[Union[OutputPortBinding, <xref:azureml.pipeline.core.pipeline_output_dataset.PipelineOutputDataset>, PipelineData]]
Lista de definiciones de puerto de salida para las salidas producidas por este paso. Recupera esto dentro del cuaderno mediante dbutils.widgets.get("output_name"). Debe ser un elemento PipelineData. |
existing_cluster_id
Requerido
|
Identificador de un clúster interactivo existente en el área de trabajo de Databricks. Si va a pasar este parámetro, no puede pasar ninguno de los parámetros siguientes, que se usan para crear un nuevo clúster:
Nota: Para crear un nuevo clúster de trabajos, deberá pasar los parámetros anteriores. Puede pasar estos parámetros directamente o puede pasarlos como parte del objeto RunConfiguration mediante el parámetro runconfig. Si se pasan estos parámetros directamente y mediante RunConfiguration, se produce un error. |
spark_version
Requerido
|
La versión de Spark para el clúster de ejecución de Databricks, por ejemplo: "10.4.x-scala2.12".
Para más información, consulte la descripción del parámetro |
node_type
Requerido
|
[Obligatorio] Tipos de nodo de máquina virtual de Azure para el clúster de ejecución de Databricks, por ejemplo: "Standard_D3_v2". Especifique |
instance_pool_id
Requerido
|
[Obligatorio] Identificador del grupo de instancias al que se debe asociar el clúster.
Especifique |
num_workers
Requerido
|
[Obligatorio] Número estático de nodos de trabajo para el clúster de ejecución de Databricks.
Debe especificar Para más información, consulte la descripción del parámetro |
min_workers
Requerido
|
[Obligatorio] Número mínimo de nodos de trabajo que se usarán para el escalado automático del clúster de ejecución de Databricks.
Debe especificar Para más información, consulte la descripción del parámetro |
max_workers
Requerido
|
[Obligatorio] Número máximo de nodos de trabajo que se usarán para el escalado automático del clúster de ejecución de Databricks.
Debe especificar Para más información, consulte la descripción del parámetro |
spark_env_variables
Requerido
|
Variables de entorno de Spark para el clúster de ejecución de Databricks.
Para más información, consulte la descripción del parámetro |
spark_conf
Requerido
|
Configuración de Spark para el clúster de ejecución de Databricks.
Para más información, consulte la descripción del parámetro |
init_scripts
Requerido
|
[str]
Desusado. Databricks anunció que el script de inicialización almacenado en DBFS dejará de funcionar después del 1 de dic de 2023. Para mitigar el problema, use scripts de inicialización globales en databricks después https://learn.microsoft.com/azure/databricks/init-scripts/global de 2) comente la línea de init_scripts en el paso de Databricks de AzureML. |
cluster_log_dbfs_path
Requerido
|
Rutas de acceso DBFS donde se van a entregar los registros de los clústeres. |
notebook_path
Requerido
|
[Obligatorio] Ruta de acceso al cuaderno en la instancia de Databricks. Esta clase permite cuatro maneras de especificar el código que se va a ejecutar en el clúster de Databricks.
Especifique exactamente uno entre |
notebook_params
Requerido
|
Diccionario de parámetros que se van a pasar al cuaderno. Los elementos |
python_script_path
Requerido
|
[Obligatorio] Ruta de acceso al script de Python en DBFS.
Especifique exactamente uno entre |
python_script_params
Requerido
|
Parámetros para el script de Python. |
main_class_name
Requerido
|
[Obligatorio] Nombre del punto de entrada en un módulo JAR.
Especifique exactamente uno entre |
jar_params
Requerido
|
Parámetros del módulo JAR. |
source_directory
Requerido
|
Carpeta que contiene el script y otros archivos.
Si se especifica |
hash_paths
Requerido
|
[str]
EN DESUSO: ya no es necesario. Una lista de rutas de acceso a hash al comprobar si hay cambios en el contenido del paso. Si no se detecta ningún cambio, la canalización reutilizará el contenido del paso de una ejecución anterior. De manera predeterminada, se aplica un algoritmo hash al contenido de |
run_name
Requerido
|
El nombre en Databricks de esta ejecución. |
timeout_seconds
Requerido
|
Tiempo de espera para la ejecución de Databricks. |
runconfig
Requerido
|
Elemento runconfig que se va a usar. Nota: Puede pasar tantas bibliotecas como quiera como dependencias a su trabajo mediante los parámetros siguientes: |
maven_libraries
Requerido
|
list[<xref:azureml.core.runconfig.MavenLibrary>]
Bibliotecas de Maven que se usarán para la ejecución de Databricks.
Para obtener más información sobre la especificación de las bibliotecas de Maven, vea |
pypi_libraries
Requerido
|
list[<xref:azureml.core.runconfig.PyPiLibrary>]
Bibliotecas de PyPi que se usarán para la ejecución de Databricks.
Para obtener más información sobre la especificación de bibliotecas de PyPi, consulte |
egg_libraries
Requerido
|
list[<xref:azureml.core.runconfig.EggLibrary>]
Bibliotecas de Egg que se usarán para la ejecución de Databricks.
Para obtener más información sobre la especificación de bibliotecas egg, vea |
jar_libraries
Requerido
|
list[<xref:azureml.core.runconfig.JarLibrary>]
Bibliotecas Jar que se usarán para la ejecución de Databricks.
Para obtener más información sobre la especificación de las bibliotecas Jar, vea |
rcran_libraries
Requerido
|
list[<xref:azureml.core.runconfig.RCranLibrary>]
Bibliotecas de RCran que se usarán para la ejecución de Databricks.
Para obtener más información sobre la especificación de las bibliotecas de RCran, vea |
compute_target
Requerido
|
[Obligatorio] Proceso de Azure Databricks. Para poder usar DatabricksStep para ejecutar los scripts o los cuadernos en un área de trabajo de Azure Databricks, debe agregar el área de trabajo de Azure Databricks como destino de proceso al área de trabajo de Azure Machine Learning. |
allow_reuse
Requerido
|
Indica si el paso debe volver a usar los resultados anteriores cuando se vuelve a ejecutar con la misma configuración. La reutilización está habilitada de manera predeterminada. Si el contenido del paso (scripts o dependencias), así como las entradas y los parámetros permanecen sin cambios, se reutiliza la salida de la ejecución anterior de este paso. Al volver a usar el paso, en lugar de enviar el trabajo al proceso, los resultados de la ejecución anterior se hacen disponibles inmediatamente para los pasos posteriores. Si usa conjuntos de datos de Azure Machine Learning como entradas, la reutilización viene determinada por si la definición del conjunto de datos ha cambiado, no por si los datos subyacentes han cambiado. |
version
Requerido
|
Etiqueta de versión opcional para indicar un cambio en la funcionalidad del paso. |
permit_cluster_restart
Requerido
|
Si se especifica existing_cluster_id, este parámetro indica si el clúster se puede reiniciar en nombre del usuario. |
Métodos
create_node |
Crea un nodo a partir del paso de Databricks y lo agrega al grafo especificado. Este método no está pensado para usarse directamente. Cuando se crea una instancia de una canalización con este paso, Azure ML pasa automáticamente los parámetros necesarios mediante este método para que ese paso se pueda agregar a un grafo de canalización que represente el flujo de trabajo. |
create_node
Crea un nodo a partir del paso de Databricks y lo agrega al grafo especificado.
Este método no está pensado para usarse directamente. Cuando se crea una instancia de una canalización con este paso, Azure ML pasa automáticamente los parámetros necesarios mediante este método para que ese paso se pueda agregar a un grafo de canalización que represente el flujo de trabajo.
create_node(graph, default_datastore, context)
Parámetros
Nombre | Description |
---|---|
graph
Requerido
|
El objeto de grafo al que se agrega el nodo. |
default_datastore
Requerido
|
El almacén de datos predeterminado. |
context
Requerido
|
<xref:azureml.pipeline.core._GraphContext>
El contexto del grafo. |
Devoluciones
Tipo | Description |
---|---|
Nodo creado. |