다음을 통해 공유

Workspace 클래스

  • 참조

학습 및 배포 아티팩트를 관리하기 위한 Azure Machine Learning 리소스를 정의합니다.

작업 영역은 Azure Machine Learning의 기계 학습을 위한 기본 리소스입니다. 작업 영역을 사용하여 기계 학습 모델을 실험, 학습, 배포합니다. 각 작업 영역은 Azure 구독 및 리소스 그룹에 연결되며 연결된 SKU가 있습니다.

작업 영역에 대한 자세한 내용은 다음을 참조하세요.

기존 Azure Machine Learning 작업 영역을 로드하는 클래스 작업 영역 생성자입니다.

상속
builtins.object
Workspace

생성자

Workspace(subscription_id, resource_group, workspace_name, auth=None, _location=None, _disable_service_check=False, _workspace_id=None, sku='basic', tags=None, _cloud='AzureCloud')

매개 변수

Name Description
subscription_id
필수
str

작업 영역이 포함된 Azure 구독 ID입니다.
resource_group
필수
str

작업 영역을 포함하는 리소스 그룹입니다.
workspace_name
필수
str

기존 작업 영역 이름입니다.
auth
ServicePrincipalAuthentication 또는 InteractiveLoginAuthentication 또는 MsiAuthentication

인증 개체입니다. 자세한 내용은 https://aka.ms/aml-notebook-auth를 참조하세요. None인 경우 기본 Azure CLI 자격 증명이 사용되거나 API에서 자격 증명을 묻는 메시지가 표시됩니다.

Default value: None
_location
str

내부 전용입니다.

Default value: None
_disable_service_check
bool

내부 전용입니다.

Default value: False
_workspace_id
str

내부 전용입니다.

Default value: None
sku
str

매개 변수는 이전 버전과의 호환성을 위해 존재하며 무시됩니다.

Default value: basic
_cloud
str

내부 전용입니다.

Default value: AzureCloud
subscription_id
필수
str

작업 영역이 포함된 Azure 구독 ID입니다.
resource_group
필수
str

작업 영역을 포함하는 리소스 그룹입니다.
workspace_name
필수
str

작업 영역 이름입니다. 이름은 2자에서 32자 사이여야 합니다. 이름의 첫 번째 문자는 영숫자(문자 또는 숫자)여야 하지만 이름의 나머지 부분에는 영숫자, 하이픈 및 밑줄이 포함될 수 있습니다. 공백은 허용되지 않습니다.
auth
필수
ServicePrincipalAuthentication 또는 InteractiveLoginAuthentication 또는 MsiAuthentication

인증 개체입니다. 자세한 내용은 https://aka.ms/aml-notebook-auth를 참조하세요. None인 경우 기본 Azure CLI 자격 증명이 사용되거나 API에서 자격 증명을 묻는 메시지가 표시됩니다.
_location
필수
str

내부 전용입니다.
_disable_service_check
필수
bool

내부 전용입니다.
_workspace_id
필수
str

내부 전용입니다.
sku
필수
str

매개 변수는 이전 버전과의 호환성을 위해 존재하며 무시됩니다.
tags
dict

작업 영역과 연결할 태그입니다.

Default value: None
_cloud
필수
str

내부 전용입니다.

설명

다음 샘플은 작업 영역을 만드는 방법을 보여 줍니다.


   from azureml.core import Workspace
   ws = Workspace.create(name='myworkspace',
               subscription_id='<azure-subscription-id>',
               resource_group='myresourcegroup',
               create_resource_group=True,
               location='eastus2'
               )

작업 영역에 사용하려는 기존 Azure 리소스 그룹이 있는 경우 create_resource_group을 False로 설정합니다.

여러 환경에서 동일한 작업 영역을 사용하려면 JSON 구성 파일을 만듭니다. 구성 파일은 쉽게 로드할 수 있도록 구독, 리소스 및 작업 영역 이름을 저장합니다. 구성을 저장하려면 write_config 메서드를 사용합니다.


   ws.write_config(path="./file-path", file_name="ws_config.json")

구성 파일의 예는 작업 영역 구성 파일 만들기를 참조하세요.

구성 파일에서 작업 영역을 로드하려면 from_config 메서드를 사용합니다.


   ws = Workspace.from_config()
   ws.get_details()

또는 get 메서드를 사용하여 구성 파일을 사용하지 않고 기존 작업 영역을 로드합니다.


   ws = Workspace.get(name="myworkspace",
               subscription_id='<azure-subscription-id>',
               resource_group='myresourcegroup')

위의 샘플은 대화형 로그인 대화 상자를 사용하여 Azure 인증 자격 증명을 묻는 메시지를 표시할 수 있습니다. Azure CLI를 사용하여 자동화된 워크플로의 인증 및 인증을 비롯한 다른 사용 사례는 Azure Machine Learning의 인증을 참조하세요.

메서드

add_private_endpoint

작업 영역에 프라이빗 엔드포인트를 추가합니다.
create

새 Azure Machine Learning 작업 영역을 만듭니다.

작업 영역이 이미 존재하거나 작업 영역 요구 사항이 충족되지 않으면 예외가 throw됩니다.
delete

Azure Machine Learning 작업 영역 관련 리소스를 삭제합니다.
delete_connection

작업 영역의 연결을 삭제합니다.
delete_private_endpoint_connection

작업 영역에 대한 프라이빗 엔드포인트 연결을 삭제합니다.
diagnose_workspace

작업 영역 설정 문제를 진단합니다.
from_config

기존 Azure Machine Learning 작업 영역에서 작업 영역 개체를 반환합니다.

파일에서 작업 영역 구성을 읽습니다. 구성 파일을 찾을 수 없으면 예외가 throw됩니다.

이 메서드는 여러 Python Notebooks 또는 프로젝트에서 동일한 작업 영역을 재사용하는 간단한 방법을 제공합니다. 사용자는 write_config 메서드를 사용하여 작업 영역 ARM(Azure Resource Manager) 속성을 저장하고 이 메서드를 사용하여 작업 영역 ARM 속성을 다시 입력하지 않고도 다른 Python Notebooks 또는 프로젝트에서 동일한 작업 영역을 로드할 수 있습니다.
get

기존 Azure Machine Learning 작업 영역에 대한 작업 영역 개체를 반환합니다.

작업 영역이 없거나 필수 필드가 작업 영역을 고유하게 식별하지 않는 경우 예외가 throw됩니다.
get_connection

작업 영역의 연결을 가져옵니다.
get_default_compute_target

작업 영역의 기본 컴퓨팅 대상을 가져옵니다.
get_default_datastore

작업 영역의 기본 데이터 저장소를 가져옵니다.
get_default_keyvault

작업 영역에 대한 기본 키 자격 증명 모음 개체를 가져옵니다.
get_details

작업 영역의 세부 정보를 반환합니다.
get_mlflow_tracking_uri

작업 영역에 대한 MLflow 추적 URI를 가져옵니다.

MLflow(https://mlflow.org/)는 기계 학습 실험을 추적하고 모델을 관리하기 위한 오픈 소스 플랫폼입니다. 메트릭, 모델 및 아티팩트가 Azure Machine Learning 작업 영역에 기록되도록 Azure Machine Learning과 함께 MLflow 로깅 API를 사용할 수 있습니다.
get_run

작업 영역에서 지정된 run_id로 실행을 반환합니다.
list

사용자가 구독 내에서 액세스할 수 있는 모든 작업 영역을 나열합니다.

작업 영역 목록은 리소스 그룹을 기준으로 필터링할 수 있습니다.
list_connections

이 작업 영역 아래의 연결을 나열합니다.
list_keys

현재 작업 영역의 키를 나열합니다.
set_connection

작업 영역에서 연결을 추가하거나 업데이트합니다.
set_default_datastore

작업 영역의 기본 데이터 저장소를 설정합니다.
setup

새 작업 영역을 만들거나 기존 작업 영역을 검색합니다.
sync_keys

작업 영역을 트리거하여 키를 즉시 동기화합니다.

작업 영역의 리소스에 대한 키가 변경된 경우 자동으로 업데이트되는 데 약 1시간이 소요될 수 있습니다. 이 함수를 사용하면 요청 시 키를 업데이트할 수 있습니다. 예제 시나리오에서는 스토리지 키를 재생성한 후 스토리지에 즉시 액세스해야 합니다.
update

작업 영역과 관련된 식별 이름, 설명, 태그, 이미지 빌드 컴퓨팅 및 기타 설정을 업데이트합니다.
update_dependencies

다음과 같은 경우 작업 영역에 대해 연결된 기존 리소스를 업데이트합니다.

a) 사용자가 기존 관련 리소스를 실수로 삭제하고 전체 작업 영역을 다시 만들 필요 없이 새 리소스로 업데이트하려는 경우. b) 사용자에게 기존의 연결된 리소스가 있고 작업 영역과 연결된 현재 리소스를 교체하려는 경우. c) 연결된 리소스가 아직 만들어지지 않았고 이미 가지고 있는 기존 리소스를 사용하려는 경우(컨테이너 레지스트리에만 적용됨).
write_config

작업 영역 ARM(Azure Resource Manager) 속성을 구성 파일에 씁니다.

Workspace ARM 속성은 나중에 from_config 메서드를 사용하여 로드할 수 있습니다. path의 기본값은 현재 작업 디렉터리의 '.azureml/'이고 file_name의 기본값은 'config.json'입니다.

이 메서드는 여러 Python Notebooks 또는 프로젝트에서 동일한 작업 영역을 재사용하는 간단한 방법을 제공합니다. 사용자는 이 함수를 사용하여 작업 영역 ARM 속성을 저장하고 from_config를 사용하여 작업 영역 ARM 속성을 다시 입력하지 않고도 다른 Python Notebooks 또는 프로젝트에서 동일한 작업 영역을 로드할 수 있습니다.

add_private_endpoint

작업 영역에 프라이빗 엔드포인트를 추가합니다.

add_private_endpoint(private_endpoint_config, private_endpoint_auto_approval=True, location=None, show_output=True, tags=None)

매개 변수

Name Description
private_endpoint_config
필수
PrivateEndPointConfig

작업 영역에 대한 프라이빗 엔드포인트를 만들기 위한 프라이빗 엔드포인트 구성입니다.
private_endpoint_auto_approval
bool

Azure Private Link Center에서 프라이빗 엔드포인트 만들기를 자동 승인해야 하는지 아니면 수동으로 승인해야 하는지 여부를 나타내는 부울 플래그입니다. 수동 승인의 경우 사용자는 Private Link 포털에서 보류 중인 요청을 확인하여 요청을 승인/거부할 수 있습니다.

Default value: True
location
string

프라이빗 엔드포인트의 위치, 기본값은 작업 영역 위치입니다.

Default value: None
show_output
bool

작업 영역 만들기 진행 상황을 표시하기 위한 플래그

Default value: True
tags
dict

작업 영역과 연결할 태그입니다.

Default value: None

반환

형식 Description
PrivateEndPoint

PrivateEndPoint 개체가 만들어졌습니다.

create

새 Azure Machine Learning 작업 영역을 만듭니다.

작업 영역이 이미 존재하거나 작업 영역 요구 사항이 충족되지 않으면 예외가 throw됩니다.

static create(name, auth=None, subscription_id=None, resource_group=None, location=None, create_resource_group=True, sku='basic', tags=None, friendly_name=None, storage_account=None, key_vault=None, app_insights=None, container_registry=None, adb_workspace=None, primary_user_assigned_identity=None, cmk_keyvault=None, resource_cmk_uri=None, hbi_workspace=False, default_cpu_compute_target=None, default_gpu_compute_target=None, private_endpoint_config=None, private_endpoint_auto_approval=True, exist_ok=False, show_output=True, user_assigned_identity_for_cmk_encryption=None, system_datastores_auth_mode='accessKey', v1_legacy_mode=None)

매개 변수

Name Description
name
필수
str

새 작업 영역 이름입니다. 이름은 2자에서 32자 사이여야 합니다. 이름의 첫 번째 문자는 영숫자(문자 또는 숫자)여야 하지만 이름의 나머지 부분에는 영숫자, 하이픈 및 밑줄이 포함될 수 있습니다. 공백은 허용되지 않습니다.
auth
ServicePrincipalAuthentication 또는 InteractiveLoginAuthentication

인증 개체입니다. 자세한 내용은 https://aka.ms/aml-notebook-auth를 참조하세요. None인 경우 기본 Azure CLI 자격 증명이 사용되거나 API에서 자격 증명을 묻는 메시지가 표시됩니다.

Default value: None
subscription_id
str

새 작업 영역에 대한 포함하는 구독의 구독 ID입니다. 사용자에게 둘 이상의 구독에 대한 액세스 권한이 있는 경우 매개 변수가 필요합니다.

Default value: None
resource_group
str

작업 영역이 포함된 Azure 리소스 그룹입니다. 매개 변수의 기본값은 작업 영역 이름의 변형입니다.

Default value: None
location
str

작업 영역의 위치입니다. 매개 변수의 기본값은 리소스 그룹 위치입니다. 위치는 Azure Machine Learning에 대해 지원되는 지역이어야 합니다.

Default value: None
create_resource_group
bool

리소스 그룹이 없는 경우 만들지 여부를 나타냅니다.

Default value: True
sku
str

매개 변수는 이전 버전과의 호환성을 위해 존재하며 무시됩니다.

Default value: basic
tags
dict

작업 영역과 연결할 태그입니다.

Default value: None
friendly_name
str

UI에 표시할 수 있는 작업 영역의 선택적 식별 이름입니다.

Default value: None
storage_account
str

Azure 리소스 ID 형식의 기존 스토리지 계정입니다. 스토리지는 작업 영역에서 실행 출력, 코드, 로그 등을 저장하는 데 사용됩니다. None인 경우 새 스토리지 계정이 만들어집니다.

Default value: None
key_vault
str

Azure 리소스 ID 형식의 기존 키 자격 증명 모음입니다. Azure 리소스 ID 형식에 대한 자세한 내용은 아래 예제 코드를 참조하세요. 작업 영역에서 키 자격 증명 모음을 사용하여 사용자가 작업 영역에 추가한 자격 증명을 저장합니다. None인 경우 새 키 자격 증명 모음이 만들어집니다.

Default value: None
app_insights
str

Azure 리소스 ID 형식의 기존 Application Insights입니다. Azure 리소스 ID 형식에 대한 자세한 내용은 아래 예제 코드를 참조하세요. Application Insights는 작업 영역에서 Webservice 이벤트를 기록하는 데 사용됩니다. None인 경우 새 Application Insights가 만들어집니다.

Default value: None
container_registry
str

Azure 리소스 ID 형식의 기존 컨테이너 레지스트리입니다(Azure 리소스 ID 형식에 대한 자세한 내용은 아래 예제 코드 참조). 컨테이너 레지스트리는 작업 영역에서 실험 이미지와 Webservice 이미지를 모두 가져오고 푸시하는 데 사용됩니다. None이면 작업 영역 만들기와 함께가 아니라 필요할 때만 새 컨테이너 레지스트리가 만들어집니다.

Default value: None
adb_workspace
str

Azure 리소스 ID 형식의 기존 Adb 작업 영역입니다(Azure 리소스 ID 형식에 대한 자세한 내용은 아래 예제 코드 참조). Adb Workspace는 작업 영역과 연결하는 데 사용됩니다. None이면 작업 영역 링크가 발생하지 않습니다.

Default value: None
primary_user_assigned_identity
str

작업 영역을 나타내는 데 사용된 사용자 할당 ID의 리소스 ID

Default value: None
cmk_keyvault
str

Azure 리소스 ID 형식의 고객 관리형 키가 포함된 키 자격 증명 모음: /subscriptions/<azure-subscription-id>/resourcegroups/<azure-resource-group>/providers/microsoft.keyvault/vaults/<azure-keyvault-name> 예: '/subscriptions/d139f240-94e6-4175-87a7-954b9d27db16/resourcegroups/myresourcegroup/providers/microsoft.keyvault/vaults/mykeyvault' Azure 리소스 ID 형식에 대한 자세한 내용은 아래 설명의 예제 코드를 참조하세요.

Default value: None
resource_cmk_uri
str

미사용 데이터를 암호화하기 위한 고객 관리형 키의 키 URI입니다. URI 형식은 https://<keyvault-dns-name>/keys/<key-name>/<key-version>입니다. 예제: ‘https://mykeyvault.vault.azure.net/keys/mykey/bc5dce6d01df49w2na7ffb11a2ee008b’. 키를 만들고 URI를 가져오는 방법에 대한 단계는 https://docs.microsoft.com/azure-stack/user/azure-stack-key-vault-manage-portal을 참조하세요.

Default value: None
hbi_workspace
bool

작업 영역에 HBI(High Business Impact) 데이터, 즉 중요한 비즈니스 정보가 포함되어 있는지 여부를 지정합니다. 이 플래그는 작업 영역 만들기 중에만 설정할 수 있습니다. 작업 영역이 만들어진 후에는 해당 값을 변경할 수 없습니다. 기본값은 False입니다.

True로 설정하면 추가 암호화 단계가 수행되고 SDK 구성 요소에 따라 내부 수집 원격 분석에서 정보가 수정됩니다. 자세한 내용은 데이터 암호화를 참조하세요.

이 플래그가 True로 설정되면 문제를 해결하는 데 한 가지 어려움이 있을 수 있습니다. 이러한 문제는 이 플래그가 True인 경우 일부 원격 분석이 Microsoft로 전송되지 않고, 성공률이나 문제 유형에 대한 가시성이 줄어들기 때문에 사전에 대응하지 못할 수 있기 때문입니다. 엄격하게 True로 요구되지 않는 한 이 플래그에 대해 기본값 False를 사용하는 것이 좋습니다.

Default value: False
default_cpu_compute_target
AmlComputeProvisioningConfiguration

(사용되지 않음) CPU 컴퓨팅을 만드는 데 사용되는 구성입니다. 매개 변수의 기본값은 {min_nodes=0, max_nodes=2, vm_size="STANDARD_DS2_V2", vm_priority="dedicated"}입니다. None이면 컴퓨팅이 만들어지지 않습니다.

Default value: None
default_gpu_compute_target
AmlComputeProvisioningConfiguration

(사용되지 않음) GPU 컴퓨팅을 만드는 데 사용되는 구성입니다. 매개 변수의 기본값은 {min_nodes=0, max_nodes=2, vm_size="STANDARD_NC6", vm_priority="dedicated"}입니다. None이면 컴퓨팅이 만들어지지 않습니다.

Default value: None
private_endpoint_config
PrivateEndPointConfig

Azure ML 작업 영역에 대한 프라이빗 엔드포인트를 만들기 위한 프라이빗 엔드포인트 구성입니다.

Default value: None
private_endpoint_auto_approval
bool

Azure Private Link Center에서 프라이빗 엔드포인트 만들기를 자동 승인해야 하는지 아니면 수동으로 승인해야 하는지 여부를 나타내는 부울 플래그입니다. 수동 승인의 경우 사용자는 Private Link 포털에서 보류 중인 요청을 확인하여 요청을 승인/거부할 수 있습니다.

Default value: True
exist_ok
bool

작업 영역이 이미 있는 경우 이 메서드가 성공할지 여부를 나타냅니다. False인 경우 작업 영역이 있는 경우 이 메서드는 실패합니다. True인 경우 이 메서드는 기존 작업 영역이 있는 경우 이를 반환합니다.

Default value: False
show_output
bool

이 메서드가 증분 진행률을 인쇄할지 여부를 나타냅니다.

Default value: True
user_assigned_identity_for_cmk_encryption
str

고객 관리 키에 액세스하는 데 사용해야 하는 사용자 지정 ID의 리소스 ID

Default value: None
system_datastores_auth_mode
str

작업 영역 'workspaceblobstore' 및 'workspacefilestore'의 시스템 데이터 저장소에 대한 자격 증명을 사용할지 여부를 결정합니다. 기본값은 'accessKey'이며, 이 경우 작업 영역은 자격 증명을 사용하여 시스템 데이터 저장소를 만듭니다. 'ID'로 설정하면 작업 영역이 자격 증명 없이 시스템 데이터 저장소를 만듭니다.

Default value: accessKey
v1_legacy_mode
bool

공용 Azure Resource Manager v2 API 서비스 사용 방지

Default value: None

반환

형식 Description
Workspace

작업 영역 개체입니다.

예외

형식 Description
WorkspaceException

작업 영역 만드는 동안 문제가 발생했습니다.

설명

이 첫 번째 예에서는 최소한의 사양만 필요하며 모든 종속 리소스와 리소스 그룹이 자동으로 만들어집니다.


   from azureml.core import Workspace
   ws = Workspace.create(name='myworkspace',
                         subscription_id='<azure-subscription-id>',
                         resource_group='myresourcegroup',
                         create_resource_group=True,
                         location='eastus2')

다음 예에서는 Azure 리소스 ID 형식을 활용하여 기존 Azure 리소스를 재사용하는 방법을 보여 줍니다. 특정 Azure 리소스 ID는 Azure Portal 또는 SDK를 통해 검색할 수 있습니다. 리소스 그룹, 스토리지 계정, 키 자격 증명 모음, App Insights 및 컨테이너 레지스트리가 이미 있다고 가정합니다.


   import os
   from azureml.core import Workspace
   from azureml.core.authentication import ServicePrincipalAuthentication

   service_principal_password = os.environ.get("AZUREML_PASSWORD")

   service_principal_auth = ServicePrincipalAuthentication(
       tenant_id="<tenant-id>",
       username="<application-id>",
       password=service_principal_password)

   ws = Workspace.create(name='myworkspace',
                         auth=service_principal_auth,
                         subscription_id='<azure-subscription-id>',
                         resource_group='myresourcegroup',
                         create_resource_group=False,
                         location='eastus2',
                         friendly_name='My workspace',
                         storage_account='subscriptions/<azure-subscription-id>/resourcegroups/myresourcegroup/providers/microsoft.storage/storageaccounts/mystorageaccount',
                         key_vault='subscriptions/<azure-subscription-id>/resourcegroups/myresourcegroup/providers/microsoft.keyvault/vaults/mykeyvault',
                         app_insights='subscriptions/<azure-subscription-id>/resourcegroups/myresourcegroup/providers/microsoft.insights/components/myappinsights',
                         container_registry='subscriptions/<azure-subscription-id>/resourcegroups/myresourcegroup/providers/microsoft.containerregistry/registries/mycontainerregistry',
                         exist_ok=False)

delete

Azure Machine Learning 작업 영역 관련 리소스를 삭제합니다.

delete(delete_dependent_resources=False, no_wait=False)

매개 변수

Name Description
delete_dependent_resources
bool

작업 영역과 연결된 리소스(예: 컨테이너 레지스트리, 스토리지 계정, 키 자격 증명 모음 및 애플리케이션 인사이트)를 삭제할지 여부를 나타냅니다. 기본값은 False입니다. 이러한 리소스를 삭제하려면 True로 설정합니다.

Default value: False
no_wait
bool

작업 영역 삭제가 완료될 때까지 기다릴지 여부를 나타냅니다.

Default value: False

반환

형식 Description
None

성공하면 None이며, 그렇지 않으면 오류가 throw됩니다.

delete_connection

작업 영역의 연결을 삭제합니다.

delete_connection(name)

매개 변수

Name Description
name
필수
str

작업 영역 아래의 고유한 연결 이름

delete_private_endpoint_connection

작업 영역에 대한 프라이빗 엔드포인트 연결을 삭제합니다.

delete_private_endpoint_connection(private_endpoint_connection_name)

매개 변수

Name Description
private_endpoint_connection_name
필수
str

작업 영역 아래의 프라이빗 엔드포인트 연결의 고유 이름

diagnose_workspace

작업 영역 설정 문제를 진단합니다.

diagnose_workspace(diagnose_parameters)

매개 변수

Name Description
diagnose_parameters
필수
<xref:_restclient.models.DiagnoseWorkspaceParameters>

작업 영역 상태 진단 매개 변수

반환

형식 Description
<xref:msrestazure.azure_operation.AzureOperationPoller>[<xref:_restclient.models.DiagnoseResponseResult>]

DiagnoseResponseResult를 반환하는 AzureOperationPoller의 인스턴스

from_config

기존 Azure Machine Learning 작업 영역에서 작업 영역 개체를 반환합니다.

파일에서 작업 영역 구성을 읽습니다. 구성 파일을 찾을 수 없으면 예외가 throw됩니다.

이 메서드는 여러 Python Notebooks 또는 프로젝트에서 동일한 작업 영역을 재사용하는 간단한 방법을 제공합니다. 사용자는 write_config 메서드를 사용하여 작업 영역 ARM(Azure Resource Manager) 속성을 저장하고 이 메서드를 사용하여 작업 영역 ARM 속성을 다시 입력하지 않고도 다른 Python Notebooks 또는 프로젝트에서 동일한 작업 영역을 로드할 수 있습니다.

static from_config(path=None, auth=None, _logger=None, _file_name=None)

매개 변수

Name Description
path
str

검색할 구성 파일 또는 시작 디렉터리의 경로입니다. 매개 변수는 기본적으로 현재 디렉터리에서 검색을 시작합니다.

Default value: None
auth
ServicePrincipalAuthentication 또는 InteractiveLoginAuthentication

인증 개체입니다. 자세한 내용은 https://aka.ms/aml-notebook-auth를 참조하세요. None인 경우 기본 Azure CLI 자격 증명이 사용되거나 API에서 자격 증명을 묻는 메시지가 표시됩니다.

Default value: None
_logger
Logger

기본 로거를 재정의할 수 있습니다.

Default value: None
_file_name
str

경로가 디렉터리 경로일 때 검색할 구성 파일 이름을 재정의할 수 있습니다.

Default value: None

반환

형식 Description
Workspace

기존 Azure ML 작업 영역에 대한 작업 영역 개체입니다.

get

기존 Azure Machine Learning 작업 영역에 대한 작업 영역 개체를 반환합니다.

작업 영역이 없거나 필수 필드가 작업 영역을 고유하게 식별하지 않는 경우 예외가 throw됩니다.

static get(name, auth=None, subscription_id=None, resource_group=None, location=None, cloud='AzureCloud', id=None)

매개 변수

Name Description
name
필수
str

가져올 작업 영역의 이름입니다.
auth
ServicePrincipalAuthentication 또는 InteractiveLoginAuthentication

인증 개체입니다. 자세한 내용은 https://aka.ms/aml-notebook-auth를 참조하세요. None인 경우 기본 Azure CLI 자격 증명이 사용되거나 API에서 자격 증명을 묻는 메시지가 표시됩니다.

Default value: None
subscription_id
str

사용할 구독 ID입니다. 사용자에게 둘 이상의 구독에 대한 액세스 권한이 있는 경우 매개 변수가 필요합니다.

Default value: None
resource_group
str

사용할 리소스 그룹입니다. None인 경우 메서드는 구독의 모든 리소스 그룹을 검색합니다.

Default value: None
location
str

작업 영역 위치입니다.

Default value: None
cloud
str

대상 클라우드의 이름입니다. "AzureCloud", "AzureChinaCloud" 또는 "AzureUSGovernment" 중 하나일 수 있습니다. 클라우드를 지정하지 않으면 “AzureCloud”가 사용됩니다.

Default value: AzureCloud
id
str

작업 영역의 ID입니다.

Default value: None

반환

형식 Description
Workspace

작업 영역 개체입니다.

get_connection

작업 영역의 연결을 가져옵니다.

get_connection(name)

매개 변수

Name Description
name
필수
str

작업 영역 아래의 고유한 연결 이름

get_default_compute_target

작업 영역의 기본 컴퓨팅 대상을 가져옵니다.

get_default_compute_target(type)

매개 변수

Name Description
type
필수
str

컴퓨팅 유형입니다. 가능한 값은 'CPU' 또는 'GPU'입니다.

반환

형식 Description
ComputeTarget

지정된 컴퓨팅 형식에 대한 기본 컴퓨팅 대상입니다.

get_default_datastore

작업 영역의 기본 데이터 저장소를 가져옵니다.

get_default_datastore()

반환

형식 Description
Datastore

기본 데이터 저장소입니다.

get_default_keyvault

작업 영역에 대한 기본 키 자격 증명 모음 개체를 가져옵니다.

get_default_keyvault()

반환

형식 Description
Keyvault

작업 영역과 연결된 KeyVault 개체입니다.

get_details

작업 영역의 세부 정보를 반환합니다.

get_details()

반환

형식 Description
dict[str, str]

사전 형식의 작업 영역 세부 정보입니다.

설명

반환된 사전에는 다음과 같은 키-값 쌍이 포함됩니다.

  • id: 구독 ID, 리소스 그룹 및 작업 영역 이름을 포함하는 이 작업 영역 리소스를 가리키는 URI입니다.

  • name: 이 작업 영역의 이름입니다.

  • location: 작업 영역 지역입니다.

  • type: "{providerName}/workspaces" 형식의 URI입니다.

  • tags: 현재 사용되지 않습니다.

  • workspaceid: 이 작업 영역의 ID입니다.

  • description: 현재 사용되지 않습니다.

  • friendName: UI에 표시되는 작업 영역의 식별 이름입니다.

  • creationTime: 이 작업 영역이 만들어진 시간(ISO8601 형식)입니다.

  • containerRegistry: 실험 이미지와 Webservice 이미지를 모두 가져오고 푸시하는 데 사용되는 작업 영역 컨테이너 레지스트리입니다.

  • keyVault: 사용자가 작업 영역에 추가한 자격 증명을 저장하는 데 사용되는 작업 영역 키 자격 증명 모음입니다.

  • applicationInsights: Application Insights는 작업 영역에서 Webservice 이벤트를 기록하는 데 사용됩니다.

  • identityPrincipalId:

  • identityTenantId

  • identityType

  • storageAccount: 스토리지는 실행 출력, 코드, 로그 등을 저장하기 위해 작업 영역에서 사용됩니다.

  • sku: 작업 영역 SKU입니다(버전이라고도 함). 매개 변수는 이전 버전과의 호환성을 위해 존재하며 무시됩니다.

  • resourceCmkUri: 미사용 데이터를 암호화하기 위한 고객 관리형 키의 키 URI입니다. 키를 만들고 URI를 가져오는 방법에 대한 단계는 https://docs.microsoft.com/en-us/azure-stack/user/azure-stack-key-vault-manage-portal?view=azs-1910을 참조하세요.

  • hbiWorkspace: 고객 데이터가 비즈니스에 큰 영향을 미치는지 여부를 지정합니다.

  • imageBuildCompute: 이미지 빌드를 위한 컴퓨팅 대상입니다.

  • systemDatastoresAuthMode: 작업 영역 'workspaceblobstore' 및 'workspacefilestore'의 시스템 데이터 저장소에 대한 자격 증명을 사용할지 여부를 결정합니다. 기본값은 'accessKey'이며, 이 경우 작업 영역은 자격 증명을 사용하여 시스템 데이터 저장소를 만듭니다. 'ID'로 설정하면 작업 영역이 자격 증명 없이 시스템 데이터 저장소를 만듭니다.

이러한 키-값 쌍에 대한 자세한 내용은 create를 참조하세요.

get_mlflow_tracking_uri

작업 영역에 대한 MLflow 추적 URI를 가져옵니다.

MLflow(https://mlflow.org/)는 기계 학습 실험을 추적하고 모델을 관리하기 위한 오픈 소스 플랫폼입니다. 메트릭, 모델 및 아티팩트가 Azure Machine Learning 작업 영역에 기록되도록 Azure Machine Learning과 함께 MLflow 로깅 API를 사용할 수 있습니다.

get_mlflow_tracking_uri(_with_auth=False)

매개 변수

Name Description
_with_auth
bool

(사용되지 않음) 추적 URI에 인증 정보를 추가합니다.

Default value: False

반환

형식 Description
str

MLflow 호환 추적 URI입니다.

설명

다음 샘플을 사용하여 Azure ML 작업 영역으로 데이터를 보내도록 MLflow 추적을 구성합니다.


   import mlflow
   from azureml.core import Workspace
   workspace = Workspace.from_config()
   mlflow.set_tracking_uri(workspace.get_mlflow_tracking_uri())

get_run

작업 영역에서 지정된 run_id로 실행을 반환합니다.

get_run(run_id)

매개 변수

Name Description
run_id
필수
string

실행 ID입니다.

반환

형식 Description
Run

제출된 실행입니다.

list

사용자가 구독 내에서 액세스할 수 있는 모든 작업 영역을 나열합니다.

작업 영역 목록은 리소스 그룹을 기준으로 필터링할 수 있습니다.

static list(subscription_id, auth=None, resource_group=None)

매개 변수

Name Description
subscription_id
필수
str

작업 영역을 나열할 구독 ID입니다.
auth
ServicePrincipalAuthentication 또는 InteractiveLoginAuthentication

인증 개체입니다. 자세한 내용은 https://aka.ms/aml-notebook-auth를 참조하세요. None인 경우 기본 Azure CLI 자격 증명이 사용되거나 API에서 자격 증명을 묻는 메시지가 표시됩니다.

Default value: None
resource_group
str

반환된 작업 영역을 필터링하는 리소스 그룹입니다. None인 경우 메서드는 지정된 구독 내의 모든 작업 영역을 나열합니다.

Default value: None

반환

형식 Description
dict

키가 작업 영역 이름이고 값이 작업 영역 개체 목록인 사전입니다.

list_connections

이 작업 영역 아래의 연결을 나열합니다.

list_connections(category=None, target=None)

매개 변수

Name Description
type
필수
str

필터링될 이 연결의 형식
target
str

필터링될 이 연결의 대상

Default value: None
category
Default value: None

list_keys

현재 작업 영역의 키를 나열합니다.

list_keys()

반환

형식 Description
object

set_connection

작업 영역에서 연결을 추가하거나 업데이트합니다.

set_connection(name, category, target, authType, value)

매개 변수

Name Description
name
필수
str

작업 영역 아래의 고유한 연결 이름
category
필수
str

이 연결의 범주
target
필수
str

이 연결이 연결되는 대상
authType
필수
str

이 연결의 권한 부여 형식
value
필수
str

연결 세부 정보의 json 형식 직렬화 문자열

set_default_datastore

작업 영역의 기본 데이터 저장소를 설정합니다.

set_default_datastore(name)

매개 변수

Name Description
name
필수
str

기본값으로 설정할 Datastore의 이름입니다.

setup

새 작업 영역을 만들거나 기존 작업 영역을 검색합니다.

static setup()

반환

형식 Description
Workspace

작업 영역 개체입니다.

sync_keys

작업 영역을 트리거하여 키를 즉시 동기화합니다.

작업 영역의 리소스에 대한 키가 변경된 경우 자동으로 업데이트되는 데 약 1시간이 소요될 수 있습니다. 이 함수를 사용하면 요청 시 키를 업데이트할 수 있습니다. 예제 시나리오에서는 스토리지 키를 재생성한 후 스토리지에 즉시 액세스해야 합니다.

sync_keys(no_wait=False)

매개 변수

Name Description
no_wait
bool

작업 영역 동기화 키가 완료될 때까지 기다릴지 여부를 나타냅니다.

Default value: False

반환

형식 Description
None

성공하면 None이며, 그렇지 않으면 오류가 throw됩니다.

update

작업 영역과 관련된 식별 이름, 설명, 태그, 이미지 빌드 컴퓨팅 및 기타 설정을 업데이트합니다.

update(friendly_name=None, description=None, tags=None, image_build_compute=None, service_managed_resources_settings=None, primary_user_assigned_identity=None, allow_public_access_when_behind_vnet=None, v1_legacy_mode=None)

매개 변수

Name Description
friendly_name
str

UI에 표시할 수 있는 작업 영역의 식별 이름입니다.

Default value: None
description
str

작업 영역의 설명입니다.

Default value: None
tags
dict

작업 영역과 연결할 태그입니다.

Default value: None
image_build_compute
str

이미지 빌드의 컴퓨팅 이름입니다.

Default value: None
service_managed_resources_settings
<xref:azureml._base_sdk_common.workspace.models.ServiceManagedResourcesSettings>

서비스 관리되는 리소스 설정입니다.

Default value: None
primary_user_assigned_identity
str

작업 영역 ID를 나타내는 사용자 할당 ID 리소스 ID입니다.

Default value: None
allow_public_access_when_behind_vnet
bool

프라이빗 링크 작업 영역에 대한 공용 액세스를 허용합니다.

Default value: None
v1_legacy_mode
bool

공용 Azure Resource Manager v2 API 서비스 사용 방지

Default value: None

반환

형식 Description
dict[str, str]

업데이트된 정보의 사전입니다.

update_dependencies

다음과 같은 경우 작업 영역에 대해 연결된 기존 리소스를 업데이트합니다.

a) 사용자가 기존 관련 리소스를 실수로 삭제하고 전체 작업 영역을 다시 만들 필요 없이 새 리소스로 업데이트하려는 경우. b) 사용자에게 기존의 연결된 리소스가 있고 작업 영역과 연결된 현재 리소스를 교체하려는 경우. c) 연결된 리소스가 아직 만들어지지 않았고 이미 가지고 있는 기존 리소스를 사용하려는 경우(컨테이너 레지스트리에만 적용됨).

update_dependencies(container_registry=None, force=False)

매개 변수

Name Description
container_registry
str

컨테이너 레지스트리의 ARM ID입니다.

Default value: None
force
bool

확인 메시지가 표시되지 않고 종속 리소스를 강제로 업데이트하는 경우.

Default value: False

반환

형식 Description
Workspace

write_config

작업 영역 ARM(Azure Resource Manager) 속성을 구성 파일에 씁니다.

Workspace ARM 속성은 나중에 from_config 메서드를 사용하여 로드할 수 있습니다. path의 기본값은 현재 작업 디렉터리의 '.azureml/'이고 file_name의 기본값은 'config.json'입니다.

이 메서드는 여러 Python Notebooks 또는 프로젝트에서 동일한 작업 영역을 재사용하는 간단한 방법을 제공합니다. 사용자는 이 함수를 사용하여 작업 영역 ARM 속성을 저장하고 from_config를 사용하여 작업 영역 ARM 속성을 다시 입력하지 않고도 다른 Python Notebooks 또는 프로젝트에서 동일한 작업 영역을 로드할 수 있습니다.

write_config(path=None, file_name=None)

매개 변수

Name Description
path
str

config.json 파일을 작성하기 위해 사용자가 제공한 위치입니다. 매개 변수의 기본값은 현재 작업 디렉터리에서 '.azureml/'입니다.

Default value: None
file_name
str

구성 파일에 사용할 이름입니다. 매개 변수의 기본값은 config.json입니다.

Default value: None

특성

compute_targets

작업 영역의 모든 컴퓨팅 대상을 나열합니다.

반환

형식 Description
dict[str, ComputeTarget]

키를 컴퓨팅 대상 이름으로, 값을 ComputeTarget 개체로 사용하는 사전입니다.

datasets

작업 영역의 모든 데이터 세트를 나열합니다.

반환

형식 Description
dict[str, Dataset]

키를 데이터 세트 이름으로, 값을 Dataset 개체로 사용하는 사전입니다.

datastores

작업 영역의 모든 데이터 저장소를 나열합니다. 이 작업은 데이터 저장소의 자격 증명을 반환하지 않습니다.

반환

형식 Description
dict[str, Datastore]

키가 데이터 저장소 이름이고 값이 Datastore 개체인 사전입니다.

discovery_url

이 작업 영역의 검색 URL을 반환합니다.

반환

형식 Description
str

이 작업 영역의 검색 URL입니다.

environments

작업 영역의 모든 환경을 나열합니다.

반환

형식 Description
dict[str, Environment]

키를 환경 이름으로, 값을 Environment 개체로 사용하는 사전입니다.

experiments

작업 영역의 모든 실험을 나열합니다.

반환

형식 Description
dict[str, Experiment]

키를 실험 이름으로, 값을 Experiment 개체로 사용하는 사전입니다.

images

작업 영역의 이미지 목록을 반환합니다.

모델 관리 서비스와 상호 작용하는 데 문제가 있으면 WebserviceException을 발생시킵니다.

반환

형식 Description
dict[str, Image]

키가 이미지 이름이고 값이 Image 개체인 사전입니다.

예외

형식 Description
WebserviceException

모델 관리 서비스와 상호 작용하는 중에 문제가 발생했습니다.

linked_services

작업 영역에 연결된 모든 서비스를 나열합니다.

반환

형식 Description
dict[str, LinkedService]

키가 연결된 서비스 이름이고 값이 LinkedService 개체인 사전입니다.

location

이 작업 영역의 위치를 반환합니다.

반환

형식 Description
str

이 작업 영역의 위치입니다.

models

작업 영역의 모델 목록을 반환합니다.

모델 관리 서비스와 상호 작용하는 데 문제가 있으면 WebserviceException을 발생시킵니다.

반환

형식 Description
dict[str, Model]

키가 모델 이름이고 값이 Model 개체인 모델 사전입니다.

예외

형식 Description
WebserviceException

모델 관리 서비스와 상호 작용하는 중에 문제가 발생했습니다.

name

작업 영역 이름을 반환합니다.

반환

형식 Description
str

작업 영역 이름입니다.

private_endpoints

작업 영역의 모든 프라이빗 엔드포인트를 나열합니다.

반환

형식 Description
dict[str, PrivateEndPoint]

작업 영역과 연결된 PrivateEndPoint 개체의 사전입니다. 키는 프라이빗 엔드포인트 이름입니다.

resource_group

이 작업 영역에 대한 리소스 그룹 이름을 반환합니다.

반환

형식 Description
str

리소스 그룹 이름입니다.

service_context

이 작업 영역에 대한 서비스 컨텍스트를 반환합니다.

반환

형식 Description
<xref:azureml._restclient.service_context.ServiceContext>

ServiceContext 개체를 반환합니다.

sku

이 작업 영역의 SKU를 반환합니다.

반환

형식 Description
str

이 작업 영역의 SKU입니다.

subscription_id

이 작업 영역에 대한 구독 ID를 반환합니다.

반환

형식 Description
str

구독 ID입니다.

tags

이 작업 영역의 태그를 반환합니다.

반환

형식 Description
dict

이 작업 영역의 태그입니다.

webservices

작업 영역의 Webservice 목록을 반환합니다.

목록을 반환하는 데 문제가 있으면 WebserviceException이 발생합니다.

반환

형식 Description
dict[str, Webservice]

작업 영역의 Webservice 목록입니다.

예외

형식 Description
WebserviceException

목록을 반환하는 중에 문제가 발생했습니다.

DEFAULT_CPU_CLUSTER_CONFIGURATION 

DEFAULT_CPU_CLUSTER_CONFIGURATION = <azureml.core.compute.amlcompute.AmlComputeProvisioningConfiguration object>

DEFAULT_CPU_CLUSTER_NAME 

DEFAULT_CPU_CLUSTER_NAME = 'cpu-cluster'

DEFAULT_GPU_CLUSTER_CONFIGURATION 

DEFAULT_GPU_CLUSTER_CONFIGURATION = <azureml.core.compute.amlcompute.AmlComputeProvisioningConfiguration object>

DEFAULT_GPU_CLUSTER_NAME 

DEFAULT_GPU_CLUSTER_NAME = 'gpu-cluster'