Workspace Kelas

Menentukan sumber daya Azure Machine Learning untuk mengelola artefak pelatihan dan penyebaran.

Ruang kerja adalah sumber daya dasar untuk pembelajaran mesin di Azure Machine Learning. Anda menggunakan ruang kerja untuk bereksperimen, melatih, dan menyebarkan model pembelajaran mesin. Setiap ruang kerja terkait dengan langganan Azure dan grup sumber daya, dan memiliki SKU terkait.

Untuk informasi selengkapnya tentang ruang kerja, lihat:

Konstruktor Ruang Kerja Kelas untuk memuat Ruang Kerja Azure Machine Learning yang ada.

Warisan
builtins.object
Workspace

Konstruktor

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

Parameter

subscription_id
str
Diperlukan

ID langganan Azure yang berisi ruang kerja.

resource_group
str
Diperlukan

Grup sumber daya yang berisi ruang kerja.

workspace_name
str
Diperlukan

Nama ruang kerja yang sudah ada.

auth
ServicePrincipalAuthentication atau InteractiveLoginAuthentication atau MsiAuthentication
nilai default: None

Objek autentikasi. Untuk detail selengkapnya, lihat https://aka.ms/aml-notebook-auth. Jika Tidak Ada, informasi masuk Azure CLI default akan digunakan atau API akan meminta informasi masuk.

_location
str
nilai default: None

Penggunaan internal saja.

_disable_service_check
bool
nilai default: False

Penggunaan internal saja.

_workspace_id
str
nilai default: None

Penggunaan internal saja.

sku
str
nilai default: basic

Parameter hadir untuk kompatibilitas mundur dan diabaikan.

_cloud
str
nilai default: AzureCloud

Penggunaan internal saja.

subscription_id
str
Diperlukan

ID langganan Azure yang berisi ruang kerja.

resource_group
str
Diperlukan

Grup sumber daya yang berisi ruang kerja.

workspace_name
str
Diperlukan

Nama ruang kerja. Panjang nama harus antara 2 dan 32 karakter. Karakter pertama dari nama tersebut harus alfanumerik (huruf atau angka), tetapi sisanya boleh berisi alfanumerik, tanda hubung, dan garis bawah. Spasi kosong tidak diperbolehkan.

auth
ServicePrincipalAuthentication atau InteractiveLoginAuthentication atau MsiAuthentication
Diperlukan

Objek autentikasi. Untuk detail selengkapnya, lihat https://aka.ms/aml-notebook-auth. Jika Tidak Ada, informasi masuk Azure CLI default akan digunakan atau API akan meminta informasi masuk.

_location
str
Diperlukan

Penggunaan internal saja.

_disable_service_check
bool
Diperlukan

Penggunaan internal saja.

_workspace_id
str
Diperlukan

Penggunaan internal saja.

sku
str
Diperlukan

Parameter hadir untuk kompatibilitas mundur dan diabaikan.

tags
dict
nilai default: None

Tag yang akan dikaitkan dengan ruang kerja.

_cloud
str
Diperlukan

Penggunaan internal saja.

Keterangan

Contoh berikut menunjukkan cara pembuatan ruang kerja.


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

Setel create_resource_group ke False jika Anda memiliki grup sumber daya Azure yang ingin Anda gunakan untuk ruang kerja.

Untuk menggunakan ruang kerja yang sama di beberapa lingkungan, buat file konfigurasi JSON. File konfigurasi menyimpan langganan, sumber daya, dan nama ruang kerja Anda sehingga dapat dimuat dengan mudah. Untuk menyimpan konfigurasi, gunakan metode write_config.


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

Lihat Membuat file konfigurasi ruang kerja untuk contoh file konfigurasi.

Untuk memuat ruang kerja dari file konfigurasi, gunakan metode from_config.


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

Atau, gunakan metode get untuk memuat ruang kerja yang sudah ada tanpa menggunakan file konfigurasi.


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

Sampel di atas dapat meminta informasi masuk autentikasi Azure kepada Anda menggunakan dialog masuk interaktif. Untuk kasus penggunaan lainnya, termasuk menggunakan autentikasi Azure CLI dan autentikasi dalam alur kerja otomatis, lihat Autentikasi pada Azure Machine Learning.

Metode

add_private_endpoint

Tambahkan titik akhir privat ke ruang kerja.

create

Buat Ruang Kerja Azure Machine Learning baru.

Mengeluarkan pengecualian jika ruang kerja sudah ada atau salah satu persyaratan ruang kerja tidak terpenuhi.

delete

Hapus Ruang Kerja Azure Machine Learning yang terkait dengan sumber daya.

delete_connection

Hapus koneksi ruang kerja.

delete_private_endpoint_connection

Menghapus koneksi titik akhir privat ke ruang kerja.

diagnose_workspace

Diagnosis masalah penyiapan ruang kerja.

from_config

Mengembalikan objek ruang kerja dari Ruang Kerja Azure Machine Learning yang ada.

Membaca konfigurasi ruang kerja dari sebuah file. Mengeluarkan pengecualian jika file konfigurasi tidak dapat ditemukan.

Metode ini menyediakan cara sederhana untuk menggunakan ulang ruang kerja yang sama di beberapa buku catatan atau proyek Python. Pengguna dapat menyimpan properti Azure Resource Manager (ARM) ruang kerja menggunakan metode write_config, dan menggunakan metode ini untuk memuat ruang kerja yang sama di buku catatan atau proyek Python yang berbeda tanpa mengetik ulang properti ARM ruang kerja.

get

Mengembalikan objek ruang kerja untuk Ruang Kerja Azure Machine Learning yang ada.

Mengeluarkan pengecualian jika ruang kerja tidak ada atau bidang yang diperlukan tidak mengidentifikasi ruang kerja secara unik.

get_connection

Mendapatkan koneksi ruang kerja.

get_default_compute_target

Mendapatkan target komputasi default untuk ruang kerja.

get_default_datastore

Mendapatkan penyimpanan data default untuk ruang kerja.

get_default_keyvault

Mendapatkan objek brankas kunci default untuk ruang kerja.

get_details

Mengembalikan detail ruang kerja.

get_mlflow_tracking_uri

Dapatkan URI pelacakan MLflow untuk ruang kerja.

MLflow (https://mlflow.org/) adalah platform sumber terbuka untuk melacak eksperimen pembelajaran mesin dan mengelola model. Anda dapat menggunakan API pengelogan MLflow dengan Azure Machine Learning sehingga metrik, model, dan artefak dicatat ke ruang kerja Azure Machine Learning Anda.

get_run

Mengembalikan eksekusi dengan run_id yang ditentukan dalam ruang kerja.

list

Mencantumkan semua ruang kerja yang dapat diakses pengguna dalam langganan.

Daftar ruang kerja dapat difilter berdasarkan grup sumber daya.

list_connections

Mencantumkan koneksi pada ruang kerja ini.

list_keys

Mencantumkan kunci untuk ruang kerja saat ini.

set_connection

Menambahkan atau memperbarui koneksi pada ruang kerja.

set_default_datastore

Mengatur penyimpanan data default untuk ruang kerja.

setup

Membuat ruang kerja baru atau mengambil ruang kerja yang sudah ada.

sync_keys

Memicu ruang kerja untuk segera menyinkronkan kunci.

Jika kunci untuk sumber daya apa pun di ruang kerja diubah, diperlukan waktu sekitar satu jam agar dapat diperbarui secara otomatis. Fungsi ini memungkinkan kunci diperbarui berdasarkan permintaan. Contoh skenarionya adalah membutuhkan akses langsung ke penyimpanan setelah meregenerasi kunci penyimpanan.

update

Memperbarui nama, deskripsi, tag, komputasi build citra, dan pengaturan lainnya yang terkait dengan ruang kerja.

update_dependencies

Perbarui sumber daya terkait untuk ruang kerja dalam kasus berikut.

a) Ketika pengguna secara tidak sengaja menghapus sumber daya terkait yang ada dan ingin memperbaruinya dengan yang baru tanpa harus membuat ulang seluruh ruang kerja. b) Ketika pengguna memiliki sumber daya terkait yang ada dan ingin mengganti sumber daya terkait saat ini dengan ruang kerja. c) Ketika sumber daya terkait belum dibuat dan ingin menggunakan sumber daya yang sudah ada yang sudah dimiliki (hanya berlaku untuk registri kontainer).

write_config

Menulis properti Azure Resource Manager (ARM) ruang kerja ke file konfigurasi.

Properti ARM ruang kerja dapat dimuat kemudian menggunakan metode from_config. Default path ke'.azureml/' di direktori yang bekerja saat ini dan default file_name ke 'config.json'.

Metode ini memberikan cara sederhana untuk menggunakan ulang ruang kerja yang sama di beberapa buku catatan atau proyek Python. Pengguna dapat menyimpan properti ARM ruang kerja menggunakan fungsi ini, dan menggunakan from_config untuk memuat ruang kerja yang sama di buku catatan atau proyek Python yang berbeda tanpa mengetik ulang properti ARM ruang kerja.

add_private_endpoint

Tambahkan titik akhir privat ke ruang kerja.

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

Parameter

private_endpoint_config
PrivateEndPointConfig
Diperlukan

Konfigurasi titik akhir privat untuk membuat titik akhir privat ke ruang kerja.

private_endpoint_auto_approval
bool
nilai default: True

Bendera boolean yang menunjukkan apakah pembuatan titik akhir privat harus disetujui secara otomatis atau disetujui secara manual dari Pusat Azure Private Link. Dalam kasus persetujuan manual, pengguna dapat melihat permintaan yang tertunda di portal Private Link untuk menyetujui/menolak permintaan.

location
string
nilai default: None

Lokasi titik akhir privat, default adalah lokasi ruang kerja

show_output
bool
nilai default: True

Bendera untuk menunjukkan progres pembuatan ruang kerja

tags
dict
nilai default: None

Tag yang dikaitkan dengan ruang kerja.

Mengembalikan

Objek PrivateEndPoint dibuat.

Tipe hasil

create

Buat Ruang Kerja Azure Machine Learning baru.

Mengeluarkan pengecualian jika ruang kerja sudah ada atau salah satu persyaratan ruang kerja tidak terpenuhi.

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)

Parameter

name
str
Diperlukan

Nama ruang kerja baru. Panjang nama harus antara 2 dan 32 karakter. Karakter pertama dari nama tersebut harus alfanumerik (huruf atau angka), tetapi sisanya boleh berisi alfanumerik, tanda hubung, dan garis bawah. Spasi kosong tidak diperbolehkan.

auth
ServicePrincipalAuthentication atau InteractiveLoginAuthentication
nilai default: None

Objek autentikasi. Untuk detail selengkapnya, lihat https://aka.ms/aml-notebook-auth. Jika Tidak Ada, informasi masuk Azure CLI default akan digunakan atau API akan meminta informasi masuk.

subscription_id
str
nilai default: None

ID langganan dari langganan yang berisi untuk ruang kerja baru. Parameter diperlukan jika pengguna memiliki akses ke lebih dari satu langganan.

resource_group
str
nilai default: None

Grup sumber daya Azure yang memuat ruang kerja. Default parameter ke mutasi nama ruang kerja.

location
str
nilai default: None

Lokasi ruang kerja. Default parameter ke lokasi grup sumber daya. Lokasi harus berupa wilayah yang didukung untuk Azure Machine Learning.

create_resource_group
bool
nilai default: True

Menunjukkan apakah akan membuat grup sumber daya jika grup sumber daya belum ada.

sku
str
nilai default: basic

Parameter hadir untuk kompatibilitas mundur dan diabaikan.

tags
dict
nilai default: None

Tag yang akan dikaitkan dengan ruang kerja.

friendly_name
str
nilai default: None

Nama opsional yang mudah diingat untuk ruang kerja yang dapat ditampilkan di antarmuka pengguna.

storage_account
str
nilai default: None

Akun penyimpanan yang sudah ada dalam format ID sumber daya Azure. Penyimpanan akan digunakan oleh ruang kerja untuk menyimpan output run, kode, log, dll. Jika Tidak Ada, akun penyimpanan baru akan dibuat.

key_vault
str
nilai default: None

Brankas kunci yang sudah ada dalam format ID sumber daya Azure. Lihat contoh kode di bawah ini untuk detail format ID sumber daya Azure. Brankas kunci akan digunakan oleh ruang kerja untuk menyimpan informasi masuk yang ditambahkan ke ruang kerja oleh pengguna. Jika Tidak Ada, brankas kunci baru akan dibuat.

app_insights
str
nilai default: None

Application Insights yang sudah ada dalam format ID sumber daya Azure. Lihat contoh kode di bawah ini untuk detail format ID sumber daya Azure. Application Insights akan digunakan oleh ruang kerja untuk mencatat peristiwa layanan web. Jika Tidak Ada, Application Insights baru akan dibuat.

container_registry
str
nilai default: None

Registri kontainer yang sudah ada dalam format ID sumber daya Azure (lihat contoh kode di bawah ini untuk detail format ID sumber daya Azure). Registri kontainer akan digunakan oleh ruang kerja untuk menarik dan mendorong eksperimen dan citra layanan web. Jika Tidak Ada, registri kontainer baru hanya akan dibuat bila diperlukan dan bukan bawaan pembuatan ruang kerja.

adb_workspace
str
nilai default: None

Ruang Kerja Adb yang sudah ada dalam format ID sumber daya Azure (lihat contoh kode di bawah ini untuk detail format ID sumber daya Azure). Ruang Kerja Adb akan digunakan agar tertaut dengan ruang kerja. Jika None, tautan ruang kerja tidak akan berhasil.

primary_user_assigned_identity
str
nilai default: None

Id sumber daya identitas yang ditetapkan pengguna yang digunakan untuk mewakili ruang kerja

cmk_keyvault
str
nilai default: None

Brankas kunci yang berisi kunci yang dikelola pelanggan dalam format ID sumber daya Azure: /subscriptions/<azure-subscription-id>/resourcegroups/<azure-resource-group>/providers/microsoft.keyvault/vaults/<azure-keyvault-name> Misalnya: '/subscriptions/d139f240-94e6-4175-87a7-954b9d27db16/resourcegroups/myresourcegroup/providers/microsoft.keyvault/vaults/mykeyvault' Lihat contoh kode dalam Pernyataan di bawah ini untuk detail selengkapnya mengenai format ID sumber daya Azure.

resource_cmk_uri
str
nilai default: None

URI kunci dari kunci yang dikelola pelanggan untuk mengenkripsi data tidak aktif. Format URI adalah: https://<keyvault-dns-name>/keys/<key-name>/<key-version>. Misalnya, 'https://mykeyvault.vault.azure.net/keys/mykey/bc5dce6d01df49w2na7ffb11a2ee008b '. Lihat https://docs.microsoft.com/azure-stack/user/azure-stack-key-vault-manage-portal untuk mengetahui langkah-langkah tentang cara membuat kunci dan mendapatkan URI-nya.

hbi_workspace
bool
nilai default: False

Menentukan apakah ruang kerja berisi data High Business Impact (HBI), misalnya, berisi informasi bisnis yang sensitif. Bendera ini dapat diatur hanya saat pembuatan ruang kerja. Nilainya tidak dapat diubah setelah ruang kerja dibuat. Nilai defaultnya adalah False.

Saat diatur ke True, langkah enkripsi lebih lanjut akan dilakukan, dan tergantung pada komponen SDK, akan menghasilkan informasi yang disunting dalam telemetri yang dikumpulkan secara internal. Untuk informasi selengkapnya, lihat Enkripsi data.

Ketika bendera ini diatur ke True, salah satu dampak yang mungkin adalah peningkatan kesulitan memecahkan masalah. Ini bisa terjadi karena beberapa telemetri tidak dikirim ke Microsoft dan ada sedikit visibilitas ke tingkat keberhasilan atau jenis masalah, dan karena itu mungkin tidak dapat bereaksi secara proaktif ketika bendera ini Benar. Rekomendasi untuk mengatasinya adalah menggunakan default False untuk bendera ini, kecuali jika benar-benar perlu untuk menggunakan default True.

default_cpu_compute_target
AmlComputeProvisioningConfiguration
nilai default: None

(TIDAK DIGUNAKAN LAGI) Konfigurasi yang akan digunakan untuk membuat komputasi CPU. Default parameter ke {min_nodes=0, max_nodes=2, vm_size="STANDARD_DS2_V2", vm_priority="dedicated"} Jika Tidak Ada, komputasi tidak akan dibuat.

default_gpu_compute_target
AmlComputeProvisioningConfiguration
nilai default: None

(TIDAK DIGUNAKAN LAGI) Konfigurasi yang akan digunakan untuk membuat komputasi GPU. Parameter default ke {min_nodes=0, max_nodes=2, vm_size="STANDARD_NC6", vm_priority="dedicated"} Jika Tidak Ada, komputasi tidak akan dibuat.

private_endpoint_config
PrivateEndPointConfig
nilai default: None

Konfigurasi titik akhir privat untuk membuat titik akhir privat ke ruang kerja Azure ML.

private_endpoint_auto_approval
bool
nilai default: True

Bendera boolean yang menunjukkan apakah pembuatan titik akhir privat harus disetujui secara otomatis atau disetujui secara manual dari Pusat Azure Private Link. Dalam kasus persetujuan manual, pengguna dapat melihat permintaan yang tertunda di portal Private Link untuk menyetujui/menolak permintaan.

exist_ok
bool
nilai default: False

Menunjukkan apakah metode ini berhasil atau tidak jika ruang kerja sudah ada. Jika False, metode ini gagal bila ruang kerja sudah ada. Jika True, metode ini mengembalikan ruang kerja yang sudah ada.

show_output
bool
nilai default: True

Menunjukkan apakah metode ini akan mencetak progres tahapan.

user_assigned_identity_for_cmk_encryption
str
nilai default: None

Id sumber daya identitas yang ditetapkan pengguna yang perlu digunakan untuk mengakses kunci kelola pelanggan

system_datastores_auth_mode
str
nilai default: accessKey

Menentukan apakah akan menggunakan informasi masuk untuk penyimpanan data sistem ruang kerja 'workspaceblobstore' dan 'workspacefilestore'. Nilai default adalah 'accessKey', dalam hal ini, ruang kerja akan membuat penyimpanan data sistem dengan informasi masuk. Jika diatur ke 'identity', ruang kerja akan membuat penyimpanan data sistem tanpa informasi masuk.

v1_legacy_mode
bool
nilai default: None

Mencegah penggunaan layanan API v2 di Azure Resource Manager publik

Mengembalikan

Objek ruang kerja.

Tipe hasil

Pengecualian

Diajukan karena terjadi masalah saat pembuatan ruang kerja.

Keterangan

Contoh pertama ini hanya memerlukan spesifikasi minimal, dan semua sumber daya dependen beserta grup sumber daya akan dibuat secara otomatis.


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

Contoh berikut menunjukkan cara menggunakan ulang sumber daya Azure yang sudah ada dengan menggunakan format ID sumber daya Azure. ID sumber daya Azure tertentu dapat diambil melalui Portal Azure atau SDK. Hal ini mengasumsikan bahwa grup sumber daya, akun penyimpanan, brankas kunci, App Insights, dan registri kontainer sudah ada.


   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

Hapus Ruang Kerja Azure Machine Learning yang terkait dengan sumber daya.

delete(delete_dependent_resources=False, no_wait=False)

Parameter

delete_dependent_resources
bool
nilai default: False

Apakah akan menghapus sumber daya yang terkait dengan ruang kerja, yaitu, registri kontainer, akun penyimpanan, brankas kunci, dan application insights. Defaultnya adalah False. Atur ke True untuk menghapus sumber daya ini.

no_wait
bool
nilai default: False

Apakah akan menunggu hingga penghapusan ruang kerja selesai.

Mengembalikan

None jika berhasil; jika gagal, menampilkan kesalahan.

Tipe hasil

delete_connection

Hapus koneksi ruang kerja.

delete_connection(name)

Parameter

name
str
Diperlukan

Nama unik koneksi pada ruang kerja

delete_private_endpoint_connection

Menghapus koneksi titik akhir privat ke ruang kerja.

delete_private_endpoint_connection(private_endpoint_connection_name)

Parameter

private_endpoint_connection_name
str
Diperlukan

Nama unik koneksi titik akhir privat pada ruang kerja

diagnose_workspace

Diagnosis masalah penyiapan ruang kerja.

diagnose_workspace(diagnose_parameters)

Parameter

diagnose_parameters
<xref:_restclient.models.DiagnoseWorkspaceParameters>
Diperlukan

Parameter mendiagnosis kesehatan ruang kerja

Mengembalikan

Instans AzureOperationPoller yang mengembalikan DiagnoseResponseResult

Tipe hasil

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

from_config

Mengembalikan objek ruang kerja dari Ruang Kerja Azure Machine Learning yang ada.

Membaca konfigurasi ruang kerja dari sebuah file. Mengeluarkan pengecualian jika file konfigurasi tidak dapat ditemukan.

Metode ini menyediakan cara sederhana untuk menggunakan ulang ruang kerja yang sama di beberapa buku catatan atau proyek Python. Pengguna dapat menyimpan properti Azure Resource Manager (ARM) ruang kerja menggunakan metode write_config, dan menggunakan metode ini untuk memuat ruang kerja yang sama di buku catatan atau proyek Python yang berbeda tanpa mengetik ulang properti ARM ruang kerja.

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

Parameter

path
str
nilai default: None

Jalur ke file konfigurasi atau direktori awal yang akan dicari. Default parameter untuk memulai pencarian di direktori saat ini.

auth
ServicePrincipalAuthentication atau InteractiveLoginAuthentication
nilai default: None

Objek autentikasi. Untuk detail selengkapnya, lihat https://aka.ms/aml-notebook-auth. Jika Tidak Ada, informasi masuk Azure CLI default akan digunakan atau API akan meminta informasi masuk.

_logger
Logger
nilai default: None

Memungkinkan pengambilalihan pencatat default.

_file_name
str
nilai default: None

Memungkinkan pengambilalihan nama file konfigurasi yang akan dicari saat jalur merupakan jalur direktori.

Mengembalikan

Objek ruang kerja untuk Ruang Kerja Azure ML yang sudah ada.

Tipe hasil

get

Mengembalikan objek ruang kerja untuk Ruang Kerja Azure Machine Learning yang ada.

Mengeluarkan pengecualian jika ruang kerja tidak ada atau bidang yang diperlukan tidak mengidentifikasi ruang kerja secara unik.

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

Parameter

name
str
Diperlukan

Nama ruang kerja yang akan didapatkan.

auth
ServicePrincipalAuthentication atau InteractiveLoginAuthentication
nilai default: None

Objek autentikasi. Untuk detail selengkapnya, lihat https://aka.ms/aml-notebook-auth. Jika None, informasi masuk Azure CLI default akan digunakan atau API akan meminta informasi masuk.

subscription_id
str
nilai default: None

ID langganan yang akan digunakan. Parameter diperlukan jika pengguna memiliki akses ke lebih dari satu langganan.

resource_group
str
nilai default: None

Grup sumber daya yang akan digunakan. Jika None, metode akan mencari semua grup sumber daya di langganan.

location
str
nilai default: None

Lokasi ruang kerja.

cloud
str
nilai default: AzureCloud

Nama cloud target. Dapat berupa salah satu dari "AzureCloud", "AzureChinaCloud", atau "AzureUSGovernment". Jika tidak ada cloud yang ditentukan, "AzureCloud" akan digunakan.

id
str
nilai default: None

Id ruang kerja.

Mengembalikan

Objek ruang kerja.

Tipe hasil

get_connection

Mendapatkan koneksi ruang kerja.

get_connection(name)

Parameter

name
str
Diperlukan

Nama unik koneksi pada ruang kerja

get_default_compute_target

Mendapatkan target komputasi default untuk ruang kerja.

get_default_compute_target(type)

Parameter

type
str
Diperlukan

Jenis komputasi. Nilai yang memungkinkan adalah 'CPU' atau 'GPU'.

Mengembalikan

Target komputasi default untuk jenis komputasi yang diberikan.

Tipe hasil

get_default_datastore

Mendapatkan penyimpanan data default untuk ruang kerja.

get_default_datastore()

Mengembalikan

Penyimpanan data default.

Tipe hasil

get_default_keyvault

Mendapatkan objek brankas kunci default untuk ruang kerja.

get_default_keyvault()

Mengembalikan

Objek KeyVault yang terkait dengan ruang kerja.

Tipe hasil

get_details

Mengembalikan detail ruang kerja.

get_details()

Mengembalikan

Detail ruang kerja dalam format kamus.

Tipe hasil

Keterangan

Kamus yang dikembalikan berisi pasangan kunci-nilai berikut.

  • id: URI yang mengarah ke sumber daya ruang kerja ini, berisi ID langganan, grup sumber daya, dan nama ruang kerja.

  • name: Nama ruang kerja ini.

  • location: Wilayah ruang kerja.

  • type: URI format "{providerName}/workspaces".

  • tags: Saat ini tidak digunakan.

  • workspaceid: ID ruang kerja ini.

  • description: Saat ini tidak digunakan.

  • friendlyName: Nama yang mudah diingat untuk ruang kerja yang ditampilkan di antarmuka pengguna.

  • creationTime: Waktu yang ditetapkan ruang kerja ini, dalam format ISO8601.

  • containerRegistry: Registri kontainer ruang kerja yang digunakan untuk menarik dan mendorong citra eksperimentasi sekaligus layanan web.

  • keyVault: Brankas kunci ruang kerja yang digunakan untuk menyimpan informasi masuk yang ditambahkan ke ruang kerja oleh pengguna.

  • applicationInsights: Application Insights akan digunakan oleh ruang kerja untuk mencatat peristiwa layanan web.

  • identityPrincipalId:

  • identityTenantId

  • identityType

  • storageAccount: Penyimpanan akan digunakan oleh ruang kerja untuk menyimpan output run, kode, log, dll.

  • sku: SKU ruang kerja (juga disebut sebagai edisi). Parameter hadir untuk kompatibilitas mundur dan diabaikan.

  • resourceCmkUri: URI kunci dari kunci yang dikelola pelanggan untuk mengenkripsi data saat tidak aktif. Lihat https://docs.microsoft.com/en-us/azure-stack/user/azure-stack-key-vault-manage-portal?view=azs-1910 untuk langkah-langkah tentang cara membuat kunci dan mendapatkan URI-nya.

  • hbiWorkspace: Menentukan apakah data pelanggan merupakan data dampak bisnis tinggi.

  • imageBuildCompute: Target komputasi untuk build citra.

  • systemDatastoresAuthMode: Menentukan apakah akan menggunakan informasi masuk untuk penyimpanan data sistem ruang kerja 'workspaceblobstore' dan 'workspacefilestore'. Nilai default adalah 'accessKey', dalam hal ini, ruang kerja akan membuat penyimpanan data sistem dengan informasi masuk. Jika diatur ke 'identity', ruang kerja akan membuat penyimpanan data sistem tanpa informasi masuk.

Untuk informasi selengkapnya tentang pasangan nilai-kunci ini, lihat create.

get_mlflow_tracking_uri

Dapatkan URI pelacakan MLflow untuk ruang kerja.

MLflow (https://mlflow.org/) adalah platform sumber terbuka untuk melacak eksperimen pembelajaran mesin dan mengelola model. Anda dapat menggunakan API pengelogan MLflow dengan Azure Machine Learning sehingga metrik, model, dan artefak dicatat ke ruang kerja Azure Machine Learning Anda.

get_mlflow_tracking_uri(_with_auth=False)

Parameter

_with_auth
bool
nilai default: False

(TIDAK DIGUNAKAN LAGI) Menambahkan info autentikasi ke URI pelacakan.

Mengembalikan

URI pelacakan yang kompatibel dengan MLflow.

Tipe hasil

str

Keterangan

Gunakan sampel berikut untuk mengonfigurasi pelacakan MLflow guna mengirim data ke Ruang Kerja Azure ML:


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

get_run

Mengembalikan eksekusi dengan run_id yang ditentukan dalam ruang kerja.

get_run(run_id)

Parameter

run_id
string
Diperlukan

ID eksekusi.

Mengembalikan

Eksekusi yang dikirim.

Tipe hasil

Run

list

Mencantumkan semua ruang kerja yang dapat diakses pengguna dalam langganan.

Daftar ruang kerja dapat difilter berdasarkan grup sumber daya.

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

Parameter

subscription_id
str
Diperlukan

ID langganan untuk membuat daftar ruang kerja.

auth
ServicePrincipalAuthentication atau InteractiveLoginAuthentication
nilai default: None

Objek autentikasi. Untuk detail selengkapnya, lihat https://aka.ms/aml-notebook-auth. Jika None, informasi masuk Azure CLI default akan digunakan atau API akan meminta informasi masuk.

resource_group
str
nilai default: None

Grup sumber daya untuk memfilter ruang kerja yang dikembalikan. Jika Tidak Ada, metode ini akan membuat daftar semua ruang kerja di dalam langganan yang ditentukan.

Mengembalikan

Kamus yang kuncinya adalah nama ruang kerja dan nilainya adalah daftar objek Ruang Kerja.

Tipe hasil

list_connections

Mencantumkan koneksi pada ruang kerja ini.

list_connections(category=None, target=None)

Parameter

type
str
Diperlukan

Jenis koneksi yang akan difilter

target
str
nilai default: None

target koneksi yang akan difilter

category
nilai default: None

list_keys

Mencantumkan kunci untuk ruang kerja saat ini.

list_keys()

Tipe hasil

set_connection

Menambahkan atau memperbarui koneksi pada ruang kerja.

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

Parameter

name
str
Diperlukan

Nama unik koneksi di ruang kerja

category
str
Diperlukan

Kategori koneksi ini

target
str
Diperlukan

target yang terhubung dengan koneksi ini

authType
str
Diperlukan

jenis otorisasi koneksi ini

value
str
Diperlukan

string serialisasi format json dari detail koneksi

set_default_datastore

Mengatur penyimpanan data default untuk ruang kerja.

set_default_datastore(name)

Parameter

name
str
Diperlukan

Nama Datastore yang akan ditetapkan sebagai default.

setup

Membuat ruang kerja baru atau mengambil ruang kerja yang sudah ada.

static setup()

Mengembalikan

Objek Ruang Kerja.

Tipe hasil

sync_keys

Memicu ruang kerja untuk segera menyinkronkan kunci.

Jika kunci untuk sumber daya apa pun di ruang kerja diubah, diperlukan waktu sekitar satu jam agar dapat diperbarui secara otomatis. Fungsi ini memungkinkan kunci diperbarui berdasarkan permintaan. Contoh skenarionya adalah membutuhkan akses langsung ke penyimpanan setelah meregenerasi kunci penyimpanan.

sync_keys(no_wait=False)

Parameter

no_wait
bool
nilai default: False

Apakah akan menunggu kunci sinkronisasi ruang kerja selesai.

Mengembalikan

None jika berhasil; jika gagal, menampilkan kesalahan.

Tipe hasil

update

Memperbarui nama, deskripsi, tag, komputasi build citra, dan pengaturan lainnya yang terkait dengan ruang kerja.

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)

Parameter

friendly_name
str
nilai default: None

Nama yang mudah diingat untuk ruang kerja yang dapat ditampilkan di antarmuka pengguna.

description
str
nilai default: None

Deskripsi ruang kerja.

tags
dict
nilai default: None

Tag yang dikaitkan dengan ruang kerja.

image_build_compute
str
nilai default: None

Nama komputasi untuk build citra.

service_managed_resources_settings
<xref:azureml._base_sdk_common.workspace.models.ServiceManagedResourcesSettings>
nilai default: None

Pengaturan sumber daya yang dikelola layanan.

primary_user_assigned_identity
str
nilai default: None

Id sumber daya identitas ditetapkan pengguna yang mewakili identitas ruang kerja.

allow_public_access_when_behind_vnet
bool
nilai default: None

Izinkan akses publik ke ruang kerja link pribadi.

v1_legacy_mode
bool
nilai default: None

Mencegah penggunaan layanan API v2 di Azure Resource Manager publik

Mengembalikan

Kamus informasi yang diperbarui.

Tipe hasil

update_dependencies

Perbarui sumber daya terkait untuk ruang kerja dalam kasus berikut.

a) Ketika pengguna secara tidak sengaja menghapus sumber daya terkait yang ada dan ingin memperbaruinya dengan yang baru tanpa harus membuat ulang seluruh ruang kerja. b) Ketika pengguna memiliki sumber daya terkait yang ada dan ingin mengganti sumber daya terkait saat ini dengan ruang kerja. c) Ketika sumber daya terkait belum dibuat dan ingin menggunakan sumber daya yang sudah ada yang sudah dimiliki (hanya berlaku untuk registri kontainer).

update_dependencies(container_registry=None, force=False)

Parameter

container_registry
str
nilai default: None

Id ARM untuk registri kontainer.

force
bool
nilai default: False

Jika dipaksa memperbarui sumber daya dependen tanpa konfirmasi yang diminta.

Tipe hasil

write_config

Menulis properti Azure Resource Manager (ARM) ruang kerja ke file konfigurasi.

Properti ARM ruang kerja dapat dimuat kemudian menggunakan metode from_config. Default path ke'.azureml/' di direktori yang bekerja saat ini dan default file_name ke 'config.json'.

Metode ini memberikan cara sederhana untuk menggunakan ulang ruang kerja yang sama di beberapa buku catatan atau proyek Python. Pengguna dapat menyimpan properti ARM ruang kerja menggunakan fungsi ini, dan menggunakan from_config untuk memuat ruang kerja yang sama di buku catatan atau proyek Python yang berbeda tanpa mengetik ulang properti ARM ruang kerja.

write_config(path=None, file_name=None)

Parameter

path
str
nilai default: None

Pengguna menyediakan lokasi untuk menulis file config.json. Default parameter ke '.azureml/' di direktori yang bekerja saat ini.

file_name
str
nilai default: None

Nama yang akan digunakan untuk file konfigurasi. Default parameter ke config.json.

Atribut

compute_targets

Mencantumkan semua target komputasi dalam ruang kerja.

Mengembalikan

Kamus dengan kunci sebagai nama target komputasi dan nilai sebagai objek ComputeTarget.

Tipe hasil

datasets

Mencantumkan semua himpunan data dalam ruang kerja.

Mengembalikan

Kamus dengan kunci sebagai nama himpunan data dan nilai sebagai objek Dataset.

Tipe hasil

datastores

Mencantumkan semua penyimpanan data dalam ruang kerja. Operasi ini tidak mengembalikan info masuk penyimpanan data.

Mengembalikan

Kamus dengan kunci sebagai nama penyimpanan data dan nilai sebagai objek Datastore.

Tipe hasil

discovery_url

Kembalikan URL penemuan ruang kerja ini.

Mengembalikan

URL penemuan ruang kerja ini.

Tipe hasil

str

environments

Mencantumkan semua lingkungan dalam ruang kerja.

Mengembalikan

Kamus dengan kunci sebagai nama lingkungan dan nilai sebagai objek Environment.

Tipe hasil

experiments

Mencantumkan semua eksperimen dalam ruang kerja.

Mengembalikan

Kamus dengan kunci sebagai nama eksperimen dan nilai sebagai objek Experiment.

Tipe hasil

images

Mengembalikan daftar citra dalam ruang kerja.

Mengajukan WebserviceException jika ada masalah dalam berinteraksi dengan layanan manajemen model.

Mengembalikan

Kamus dengan kunci sebagai nama citra dan nilai sebagai objek Image.

Tipe hasil

Pengecualian

Terdapat masalah dalam berinteraksi dengan layanan manajemen model.

linked_services

Cantumkan semua layanan tertaut dalam ruang kerja.

Mengembalikan

Kamus di mana kunci adalah nama layanan tertaut dan nilai adalah objek LinkedService.

Tipe hasil

location

Mengembalikan lokasi ruang kerja ini.

Mengembalikan

Lokasi ruang kerja ini.

Tipe hasil

str

models

Mengembalikan daftar model dalam ruang kerja.

Mengajukan WebserviceException jika terjadi masalah saat berinteraksi dengan layanan manajemen model.

Mengembalikan

Kamus model dengan kunci sebagai nama model dan nilai sebagai objek Model.

Tipe hasil

Pengecualian

Terdapat masalah dalam berinteraksi dengan layanan manajemen model.

name

Mengembalikan nama ruang kerja.

Mengembalikan

Nama ruang kerja.

Tipe hasil

str

private_endpoints

Mencantumkan semua titik akhir privat ruang kerja.

Mengembalikan

Kamus objek PrivateEndPoint yang berkaitan dengan ruang kerja. Kuncinya adalah nama titik akhir privat.

Tipe hasil

resource_group

Mengembalikan nama grup sumber daya untuk ruang kerja ini.

Mengembalikan

Nama grup sumber daya.

Tipe hasil

str

service_context

Mengembalikan konteks layanan untuk ruang kerja ini.

Mengembalikan

Mengembalikan objek ServiceContext.

Tipe hasil

<xref:azureml._restclient.service_context.ServiceContext>

sku

Mengembalikan SKU ruang kerja ini.

Mengembalikan

SKU ruang kerja ini.

Tipe hasil

str

subscription_id

Mengembalikan ID langganan untuk ruang kerja ini.

Mengembalikan

ID langganan.

Tipe hasil

str

tags

Mengembalikan Tag ruang kerja ini.

Mengembalikan

Tag ruang kerja ini.

Tipe hasil

webservices

Mengembalikan daftar layanan web dalam ruang kerja.

Mengajukan WebserviceException jika ada masalah saat mengembalikan daftar.

Mengembalikan

Daftar layanan web dalam ruang kerja.

Tipe hasil

Pengecualian

Terdapat masalah dalam mengembalikan daftar.

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'