MLClient Clase

Referencia

Una clase de cliente para interactuar con los servicios de Azure ML.

Use este cliente para administrar recursos de Azure ML, como áreas de trabajo, trabajos, modelos, etc.

Herencia: builtins.object

MLClient

Constructor

MLClient(credential: TokenCredential, subscription_id: str | None = None, resource_group_name: str | None = None, workspace_name: str | None = None, registry_name: str | None = None, **kwargs: Any)

Parámetros

credential: TokenCredential

Requerido

Credencial que se va a usar para la autenticación.

subscription_id: Optional[str]

valor predeterminado: None

El identificador de la suscripción de Azure. Opcional solo para los recursos del Registro. El valor predeterminado es None.

resource_group_name: Optional[str]

valor predeterminado: None

El grupo de recursos de Azure. Opcional solo para los recursos del Registro. El valor predeterminado es None.

workspace_name: Optional[str]

valor predeterminado: None

Área de trabajo que se va a usar en el cliente. Opcional solo para las operaciones que no dependen del área de trabajo. El valor predeterminado es None.

registry_name: Optional[str]

valor predeterminado: None

Registro que se va a usar en el cliente. Opcional solo para las operaciones que no dependen del área de trabajo. El valor predeterminado es None.

show_progress: Optional[bool]

Especifica si se deben mostrar o no barras de progreso para las operaciones de ejecución prolongada (por ejemplo, los clientes pueden considerar establecer esta opción en False si no se usa este SDK en una configuración interactiva). El valor predeterminado es True.

enable_telemetry: Optional[bool]

Especifica si se va a habilitar o no la telemetría. Se invalidará en False si no está en un Jupyter Notebook. El valor predeterminado es True si está en un Jupyter Notebook.

cloud: Optional[str]

Nombre de la nube que se va a usar. El valor predeterminado es "AzureCloud".

Ejemplos

Al usar dominios soberanos (es decir, cualquier nube que no sea AZURE_PUBLIC_CLOUD), debe pasar el nombre de la nube en kwargs y debe usar una autoridad con DefaultAzureCredential.


   from azure.ai.ml import MLClient
   from azure.identity import AzureAuthorityHosts, DefaultAzureCredential

   kwargs = {"cloud": "AzureChinaCloud"}
   ml_client = MLClient(
       subscription_id=subscription_id,
       resource_group_name=resource_group,
       credential=DefaultAzureCredential(authority=AzureAuthorityHosts.AZURE_CHINA),
       **kwargs,
   )

Métodos

begin_create_or_update

Crea o actualiza un recurso de Azure ML de forma asincrónica.

create_or_update

Crea o actualiza un recurso de Azure ML.

from_config

Devuelve un cliente de un área de trabajo de Azure Machine Learning existente mediante una configuración de archivo.

Este método proporciona una manera sencilla de reutilizar el mismo área de trabajo en varios cuadernos o proyectos de Python. Puede guardar las propiedades de Azure Resource Manager (ARM) de un área de trabajo en un archivo de configuración JSON con este formato:


   {
       "subscription_id": "<subscription-id>",
       "resource_group": "<resource-group>",
       "workspace_name": "<workspace-name>"
   }

A continuación, puede usar este método para cargar el mismo área de trabajo en distintos cuadernos o proyectos de Python sin volver a establecer las propiedades de ARM del área de trabajo.

begin_create_or_update

Crea o actualiza un recurso de Azure ML de forma asincrónica.

begin_create_or_update(entity: R, **kwargs) -> LROPoller[R]

Parámetros

entity: Union[Workspace , Registry, Compute, OnlineDeployment , OnlineEndpoint, BatchDeployment , BatchEndpoint, Schedule]

Requerido

Recurso que se va a crear o actualizar.

Devoluciones

El recurso después de la operación de creación o actualización.

Tipo de valor devuelto

LROPoller[Union[Workspace , Registry, Compute, OnlineDeployment , OnlineEndpoint, BatchDeployment , BatchEndpoint, Schedule]]

create_or_update

Crea o actualiza un recurso de Azure ML.

create_or_update(entity: T, **kwargs) -> T

Parámetros

entity: Union[Job , Model, Environment, Component , Datastore]

Requerido

Recurso que se va a crear o actualizar.

Devoluciones

Recurso creado o actualizado.

Tipo de valor devuelto

Union[Job, Model , Environment, Component, Datastore]

from_config

Devuelve un cliente de un área de trabajo de Azure Machine Learning existente mediante una configuración de archivo.


   {
       "subscription_id": "<subscription-id>",
       "resource_group": "<resource-group>",
       "workspace_name": "<workspace-name>"
   }

A continuación, puede usar este método para cargar el mismo área de trabajo en distintos cuadernos o proyectos de Python sin volver a establecer las propiedades de ARM del área de trabajo.

from_config(credential: TokenCredential, *, path: PathLike | str | None = None, file_name=None, **kwargs) -> MLClient

Parámetros

credential: TokenCredential

Requerido

Objeto de credencial del área de trabajo.

path: Optional[Union[PathLike, str]]

Ruta de acceso al archivo de configuración o directorio inicial en el que se va a buscar el archivo de configuración. El valor predeterminado es Ninguno, lo que indica que se usará el directorio actual.

file_name: Optional[str]

Nombre del archivo de configuración que se va a buscar cuando la ruta de acceso es una ruta de acceso de directorio. El valor predeterminado es "config.json".

cloud: Optional[str]

Nombre de la nube que se va a usar. El valor predeterminado es "AzureCloud".

Devoluciones

El cliente de un área de trabajo de Azure ML existente.

Tipo de valor devuelto

MLClient

Excepciones

ValidationException

Se genera si "config.json" o file_name si se invalida, no se encuentra en el directorio . Los detalles se proporcionarán en el mensaje de error.

Ejemplos

Creación de mlClient a partir de un archivo denominado "config.json" en el directorio "src".


   from azure.ai.ml import MLClient

   client = MLClient.from_config(credential=DefaultAzureCredential(), path="./sdk/ml/azure-ai-ml/samples/src")

Crear un mlClient a partir de un archivo denominado "team_workspace_configuration.json" en el directorio actual.


   from azure.ai.ml import MLClient

   client = MLClient.from_config(
       credential=DefaultAzureCredential(),
       file_name="./sdk/ml/azure-ai-ml/samples/team_workspace_configuration.json",
   )

aka.ms/azuremlexperimental para obtener más información.

Colección de operaciones relacionadas con el conjunto de características.

Devoluciones

Operaciones FeatureSet

Tipo de valor devuelto

FeatureSetOperations

feature_store_entities

aka.ms/azuremlexperimental para obtener más información.

Colección de operaciones relacionadas con entidades de almacén de características.

Devoluciones

Operaciones featureStoreEntity

Tipo de valor devuelto

FeatureStoreEntityOperations

feature_stores

registries

workspace_hubs

R

R = ~R

T

T = ~T