Bagikan melalui


Workspace Kelas

Menentukan sumber daya Azure Machine Learning untuk mengelola pelatihan dan artefak 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.

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

Nama Deskripsi
subscription_id
Diperlukan
str

ID langganan Azure yang berisi ruang kerja.

resource_group
Diperlukan
str

Grup sumber daya yang berisi ruang kerja.

workspace_name
Diperlukan
str

Nama ruang kerja yang ada.

auth

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

Nilai default: None
_location
str

Untuk penggunaan internal saja.

Nilai default: None
_disable_service_check

Untuk penggunaan internal saja.

Nilai default: False
_workspace_id
str

Untuk penggunaan internal saja.

Nilai default: None
sku
str

Parameter hadir untuk kompatibilitas mundur dan diabaikan.

Nilai default: basic
_cloud
str

Untuk penggunaan internal saja.

Nilai default: AzureCloud
subscription_id
Diperlukan
str

ID langganan Azure yang berisi ruang kerja.

resource_group
Diperlukan
str

Grup sumber daya yang berisi ruang kerja.

workspace_name
Diperlukan
str

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

auth
Diperlukan

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

_location
Diperlukan
str

Untuk penggunaan internal saja.

_disable_service_check
Diperlukan

Untuk penggunaan internal saja.

_workspace_id
Diperlukan
str

Untuk penggunaan internal saja.

sku
Diperlukan
str

Parameter hadir untuk kompatibilitas mundur dan diabaikan.

tags

Tag yang akan dikaitkan dengan ruang kerja.

Nilai default: None
_cloud
Diperlukan
str

Untuk penggunaan internal saja.

Keterangan

Contoh berikut menunjukkan cara membuat 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 dengan mudah dimuat. Untuk menyimpan konfigurasi, gunakan write_config metode .


   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 get metode untuk memuat ruang kerja yang ada tanpa menggunakan file konfigurasi.


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

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

Metode

add_private_endpoint

Tambahkan titik akhir privat ke ruang kerja.

create

Buat Ruang Kerja Azure Machine Learning baru.

Memberikan pengecualian jika ruang kerja sudah ada atau persyaratan ruang kerja apa pun tidak terpenuhi.

delete

Hapus sumber daya terkait Ruang Kerja Azure Machine Learning.

delete_connection

Menghapus koneksi ruang kerja.

delete_private_endpoint_connection

Hapus koneksi titik akhir privat ke ruang kerja.

diagnose_workspace

Mendiagnosis masalah penyiapan ruang kerja.

from_config

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

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

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

get

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

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

get_connection

Dapatkan koneksi ruang kerja.

get_default_compute_target

Dapatkan target komputasi default untuk ruang kerja.

get_default_datastore

Dapatkan datastore default untuk ruang kerja.

get_default_keyvault

Dapatkan 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 di ruang kerja.

list

Cantumkan semua ruang kerja yang dapat diakses pengguna dalam langganan.

Daftar ruang kerja dapat difilter berdasarkan grup sumber daya.

list_connections

Cantumkan koneksi di bawah ruang kerja ini.

list_keys

Mencantumkan kunci untuk ruang kerja saat ini.

set_connection

Tambahkan atau perbarui koneksi di bawah ruang kerja.

set_default_datastore

Atur datastore default untuk ruang kerja.

setup

Buat ruang kerja baru atau ambil 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 sumber daya diperbarui secara otomatis. Fungsi ini memungkinkan kunci diperbarui berdasarkan permintaan. Contoh skenario membutuhkan akses langsung ke penyimpanan setelah meregenerasi kunci penyimpanan.

update

Perbarui nama, deskripsi, tag, komputasi build gambar, dan pengaturan lain yang terkait dengan ruang kerja.

update_dependencies

Perbarui sumber daya terkait yang ada 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 saat ini yang terkait dengan ruang kerja. c) Ketika sumber daya terkait belum dibuat dan mereka ingin menggunakan sumber daya yang sudah mereka miliki (hanya berlaku untuk registri kontainer).

write_config

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

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

Metode ini menyediakan cara sederhana untuk menggunakan kembali 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 notebook 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

Nama Deskripsi
private_endpoint_config
Diperlukan

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

private_endpoint_auto_approval

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

Nilai default: True
location

Lokasi titik akhir privat, defaultnya adalah lokasi ruang kerja

Nilai default: None
show_output

Bendera untuk memperlihatkan kemajuan pembuatan ruang kerja

Nilai default: True
tags

Tag yang akan dikaitkan dengan ruang kerja.

Nilai default: None

Mengembalikan

Jenis Deskripsi

Objek PrivateEndPoint dibuat.

create

Buat Ruang Kerja Azure Machine Learning baru.

Memberikan pengecualian jika ruang kerja sudah ada atau persyaratan ruang kerja apa pun 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

Nama Deskripsi
name
Diperlukan
str

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

auth

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

Nilai default: None
subscription_id
str

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

Nilai default: None
resource_group
str

Grup sumber daya Azure yang berisi ruang kerja. Parameter default ke mutasi nama ruang kerja.

Nilai default: None
location
str

Lokasi ruang kerja. Parameter default ke lokasi grup sumber daya. Lokasi harus menjadi wilayah yang didukung untuk Azure Machine Learning.

Nilai default: None
create_resource_group

Menunjukkan apakah akan membuat grup sumber daya jika tidak ada.

Nilai default: True
sku
str

Parameter hadir untuk kompatibilitas mundur dan diabaikan.

Nilai default: basic
tags

Tag yang akan dikaitkan dengan ruang kerja.

Nilai default: None
friendly_name
str

Nama ramah opsional untuk ruang kerja yang dapat ditampilkan di UI.

Nilai default: None
storage_account
str

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

Nilai default: None
key_vault
str

Brankas kunci yang 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 kredensial yang ditambahkan ke ruang kerja oleh pengguna. Jika Tidak Ada, brankas kunci baru akan dibuat.

Nilai default: None
app_insights
str

Application Insights yang 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.

Nilai default: None
container_registry
str

Registri kontainer yang 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 gambar layanan web. Jika Tidak Ada, registri kontainer baru hanya akan dibuat jika diperlukan dan tidak bersama dengan pembuatan ruang kerja.

Nilai default: None
adb_workspace
str

Ruang Kerja Adb yang 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 untuk menautkan dengan ruang kerja. Jika Tidak Ada, tautan ruang kerja tidak akan terjadi.

Nilai default: None
primary_user_assigned_identity
str

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

Nilai default: None
cmk_keyvault
str

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 di Keterangan di bawah ini untuk detail selengkapnya tentang format ID sumber daya Azure.

Nilai default: None
resource_cmk_uri
str

URI kunci 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'. https://docs.microsoft.com/azure-stack/user/azure-stack-key-vault-manage-portal Lihat langkah-langkah tentang cara membuat kunci dan mendapatkan URI-nya.

Nilai default: None
hbi_workspace

Menentukan apakah ruang kerja berisi data Dampak Bisnis Tinggi (HBI), yaitu, berisi informasi bisnis sensitif. Bendera ini hanya dapat diatur selama pembuatan ruang kerja. Nilainya tidak dapat diubah setelah ruang kerja dibuat. Nilai defaultnya adalah False.

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

Ketika bendera ini diatur ke True, satu kemungkinan dampaknya adalah peningkatan masalah pemecahan masalah kesulitan. Ini bisa terjadi karena beberapa telemetri tidak dikirim ke Microsoft dan ada lebih sedikit visibilitas ke tingkat keberhasilan atau jenis masalah, dan oleh karena itu mungkin tidak dapat bereaksi secara proaktif ketika bendera ini Benar. Rekomendasi ini menggunakan default False untuk bendera ini kecuali diharuskan benar-benar True.

Nilai default: False
default_cpu_compute_target

(Tidak digunakan lagi) Konfigurasi yang akan digunakan untuk membuat komputasi CPU. Parameter default ke {min_nodes=0, max_nodes=2, vm_size="STANDARD_DS2_V2", vm_priority="dedicated"} Jika Tidak Ada, tidak ada komputasi yang akan dibuat.

Nilai default: None
default_gpu_compute_target

(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, tidak ada komputasi yang akan dibuat.

Nilai default: None
private_endpoint_config

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

Nilai default: None
private_endpoint_auto_approval

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

Nilai default: True
exist_ok

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

Nilai default: False
show_output

Menunjukkan apakah metode ini akan mencetak kemajuan inkremental.

Nilai default: True
user_assigned_identity_for_cmk_encryption
str

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

Nilai default: None
system_datastores_auth_mode
str

Menentukan apakah akan menggunakan kredensial untuk datastore sistem ruang kerja 'workspaceblobstore' dan 'workspacefilestore'. Nilai defaultnya adalah 'accessKey', dalam hal ini, ruang kerja akan membuat penyimpanan data sistem dengan kredensial. Jika diatur ke 'identitas', ruang kerja akan membuat penyimpanan data sistem tanpa kredensial.

Nilai default: accessKey
v1_legacy_mode

Mencegah penggunaan layanan API v2 di Azure Resource Manager publik

Nilai default: None

Mengembalikan

Jenis Deskripsi

Objek ruang kerja.

Pengecualian

Jenis Deskripsi

Dimunculkan untuk masalah saat membuat ruang kerja.

Keterangan

Contoh pertama ini hanya memerlukan spesifikasi minimal, dan semua sumber daya dependen serta 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 kembali sumber daya Azure yang ada menggunakan format ID sumber daya Azure. ID sumber daya Azure tertentu dapat diambil melalui Portal Microsoft Azure atau SDK. 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 sumber daya terkait Ruang Kerja Azure Machine Learning.

delete(delete_dependent_resources=False, no_wait=False)

Parameter

Nama Deskripsi
delete_dependent_resources

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

Nilai default: False
no_wait

Apakah akan menunggu penghapusan ruang kerja selesai.

Nilai default: False

Mengembalikan

Jenis Deskripsi

Tidak ada jika berhasil; jika tidak, melemparkan kesalahan.

delete_connection

Menghapus koneksi ruang kerja.

delete_connection(name)

Parameter

Nama Deskripsi
name
Diperlukan
str

Nama unik koneksi di bawah ruang kerja

delete_private_endpoint_connection

Hapus koneksi titik akhir privat ke ruang kerja.

delete_private_endpoint_connection(private_endpoint_connection_name)

Parameter

Nama Deskripsi
private_endpoint_connection_name
Diperlukan
str

Nama unik koneksi titik akhir privat di bawah ruang kerja

diagnose_workspace

Mendiagnosis masalah penyiapan ruang kerja.

diagnose_workspace(diagnose_parameters)

Parameter

Nama Deskripsi
diagnose_parameters
Diperlukan
<xref:_restclient.models.DiagnoseWorkspaceParameters>

Parameter mendiagnosis kesehatan ruang kerja

Mengembalikan

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

Instans AzureOperationPoller yang mengembalikan DiagnoseResponseResult

from_config

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

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

Metode ini menyediakan cara sederhana untuk menggunakan kembali ruang kerja yang sama di beberapa buku catatan atau proyek Python. Pengguna dapat menyimpan properti Azure Resource Manager (ARM) ruang kerja menggunakan write_config metode , dan menggunakan metode ini untuk memuat ruang kerja yang sama di notebook 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

Nama Deskripsi
path
str

Jalur ke file konfigurasi atau memulai direktori untuk dicari. Parameter default untuk memulai pencarian di direktori saat ini.

Nilai default: None
auth

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

Nilai default: None
_logger

Memungkinkan pengesampingan pencatat default.

Nilai default: None
_file_name
str

Memungkinkan pengesampingan nama file konfigurasi untuk mencari kapan jalur adalah jalur direktori.

Nilai default: None

Mengembalikan

Jenis Deskripsi

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

get

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

Melemparkan 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

Nama Deskripsi
name
Diperlukan
str

Nama ruang kerja yang akan didapatkan.

auth

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

Nilai default: None
subscription_id
str

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

Nilai default: None
resource_group
str

Grup sumber daya yang akan digunakan. Jika Tidak Ada, metode akan mencari semua grup sumber daya dalam langganan.

Nilai default: None
location
str

Lokasi ruang kerja.

Nilai default: None
cloud
str

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

Nilai default: AzureCloud
id
str

Id ruang kerja.

Nilai default: None

Mengembalikan

Jenis Deskripsi

Objek ruang kerja.

get_connection

Dapatkan koneksi ruang kerja.

get_connection(name)

Parameter

Nama Deskripsi
name
Diperlukan
str

Nama unik koneksi di bawah ruang kerja

get_default_compute_target

Dapatkan target komputasi default untuk ruang kerja.

get_default_compute_target(type)

Parameter

Nama Deskripsi
type
Diperlukan
str

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

Mengembalikan

Jenis Deskripsi

Target komputasi default untuk jenis komputasi tertentu.

get_default_datastore

Dapatkan datastore default untuk ruang kerja.

get_default_datastore()

Mengembalikan

Jenis Deskripsi

Datastore default.

get_default_keyvault

Dapatkan objek brankas kunci default untuk ruang kerja.

get_default_keyvault()

Mengembalikan

Jenis Deskripsi

Objek KeyVault yang terkait dengan ruang kerja.

get_details

Mengembalikan detail ruang kerja.

get_details()

Mengembalikan

Jenis Deskripsi

Detail ruang kerja dalam format kamus.

Keterangan

Kamus yang dikembalikan berisi pasangan kunci-nilai berikut.

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

  • nama: Nama ruang kerja ini.

  • lokasi: Wilayah ruang kerja.

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

  • tag: Saat ini tidak digunakan.

  • workspaceid: ID ruang kerja ini.

  • deskripsi: Saat ini tidak digunakan.

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

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

  • containerRegistry: Registri kontainer ruang kerja yang digunakan untuk menarik dan mendorong eksperimen dan gambar layanan web.

  • keyVault: Brankas kunci ruang kerja yang digunakan untuk menyimpan kredensial 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 eksekusi, kode, log, dll.

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

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

  • hbiWorkspace: Menentukan apakah data pelanggan memiliki dampak bisnis yang tinggi.

  • imageBuildCompute: Target komputasi untuk build gambar.

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

Untuk informasi selengkapnya tentang pasangan kunci-nilai 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

Nama Deskripsi
_with_auth

(Tidak digunakan lagi) Tambahkan info autentikasi ke URI pelacakan.

Nilai default: False

Mengembalikan

Jenis Deskripsi
str

URI pelacakan yang kompatibel dengan MLflow.

Keterangan

Gunakan sampel berikut untuk mengonfigurasi pelacakan MLflow untuk 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 di ruang kerja.

get_run(run_id)

Parameter

Nama Deskripsi
run_id
Diperlukan

ID eksekusi.

Mengembalikan

Jenis Deskripsi
Run

Eksekusi yang dikirimkan.

list

Cantumkan 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

Nama Deskripsi
subscription_id
Diperlukan
str

ID langganan untuk mencantumkan ruang kerja.

auth

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

Nilai default: None
resource_group
str

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

Nilai default: None

Mengembalikan

Jenis Deskripsi

Kamus tempat kunci adalah nama ruang kerja dan nilainya adalah daftar objek Ruang Kerja.

list_connections

Cantumkan koneksi di bawah ruang kerja ini.

list_connections(category=None, target=None)

Parameter

Nama Deskripsi
type
Diperlukan
str

Tipe koneksi ini yang akan difilter

target
str

target koneksi ini yang akan difilter

Nilai default: None
category
Nilai default: None

list_keys

Mencantumkan kunci untuk ruang kerja saat ini.

list_keys()

Mengembalikan

Jenis Deskripsi

set_connection

Tambahkan atau perbarui koneksi di bawah ruang kerja.

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

Parameter

Nama Deskripsi
name
Diperlukan
str

Nama unik koneksi di bawah ruang kerja

category
Diperlukan
str

Kategori koneksi ini

target
Diperlukan
str

target koneksi ini tersambung ke

authType
Diperlukan
str

jenis otorisasi koneksi ini

value
Diperlukan
str

string serialisasi format json dari detail koneksi

set_default_datastore

Atur datastore default untuk ruang kerja.

set_default_datastore(name)

Parameter

Nama Deskripsi
name
Diperlukan
str

Nama yang akan Datastore diatur sebagai default.

setup

Buat ruang kerja baru atau ambil ruang kerja yang sudah ada.

static setup()

Mengembalikan

Jenis Deskripsi

Objek Ruang Kerja.

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 sumber daya diperbarui secara otomatis. Fungsi ini memungkinkan kunci diperbarui berdasarkan permintaan. Contoh skenario membutuhkan akses langsung ke penyimpanan setelah meregenerasi kunci penyimpanan.

sync_keys(no_wait=False)

Parameter

Nama Deskripsi
no_wait

Apakah akan menunggu kunci sinkronisasi ruang kerja selesai.

Nilai default: False

Mengembalikan

Jenis Deskripsi

Tidak ada jika berhasil; jika tidak, melemparkan kesalahan.

update

Perbarui nama, deskripsi, tag, komputasi build gambar, dan pengaturan lain 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

Nama Deskripsi
friendly_name
str

Nama yang mudah diingat untuk ruang kerja yang dapat ditampilkan di UI.

Nilai default: None
description
str

Deskripsi ruang kerja.

Nilai default: None
tags

Tag yang akan dikaitkan dengan ruang kerja.

Nilai default: None
image_build_compute
str

Nama komputasi untuk build gambar.

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

Pengaturan sumber daya terkelola layanan.

Nilai default: None
primary_user_assigned_identity
str

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

Nilai default: None
allow_public_access_when_behind_vnet

Izinkan akses publik ke ruang kerja tautan privat.

Nilai default: None
v1_legacy_mode

Mencegah penggunaan layanan API v2 di Azure Resource Manager publik

Nilai default: None

Mengembalikan

Jenis Deskripsi

Kamus informasi yang diperbarui.

update_dependencies

Perbarui sumber daya terkait yang ada 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 saat ini yang terkait dengan ruang kerja. c) Ketika sumber daya terkait belum dibuat dan mereka ingin menggunakan sumber daya yang sudah mereka miliki (hanya berlaku untuk registri kontainer).

update_dependencies(container_registry=None, force=False)

Parameter

Nama Deskripsi
container_registry
str

ID ARM untuk registri kontainer.

Nilai default: None
force

Jika memaksa memperbarui sumber daya dependen tanpa konfirmasi yang diminta.

Nilai default: False

Mengembalikan

Jenis Deskripsi

write_config

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

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

Metode ini menyediakan cara sederhana untuk menggunakan kembali 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 notebook atau proyek Python yang berbeda tanpa mengetik ulang properti ARM ruang kerja.

write_config(path=None, file_name=None)

Parameter

Nama Deskripsi
path
str

Lokasi yang disediakan pengguna untuk menulis file config.json. Parameter default ke '.azureml/' di direktori kerja saat ini.

Nilai default: None
file_name
str

Nama yang akan digunakan untuk file konfigurasi. Parameter default ke config.json.

Nilai default: None

Atribut

compute_targets

Cantumkan semua target komputasi di ruang kerja.

Mengembalikan

Jenis Deskripsi

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

datasets

Mencantumkan semua himpunan data di ruang kerja.

Mengembalikan

Jenis Deskripsi

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

datastores

Mencantumkan semua datastore di ruang kerja. Operasi ini tidak mengembalikan kredensial datastore.

Mengembalikan

Jenis Deskripsi

Kamus dengan kunci sebagai nama dan nilai datastore sebagai Datastore objek.

discovery_url

Mengembalikan URL penemuan ruang kerja ini.

Mengembalikan

Jenis Deskripsi
str

URL penemuan ruang kerja ini.

environments

Mencantumkan semua lingkungan di ruang kerja.

Mengembalikan

Jenis Deskripsi

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

experiments

Mencantumkan semua eksperimen di ruang kerja.

Mengembalikan

Jenis Deskripsi

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

images

Mengembalikan daftar gambar di ruang kerja.

WebserviceException Menimbulkan jika ada masalah saat berinteraksi dengan layanan manajemen model.

Mengembalikan

Jenis Deskripsi

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

Pengecualian

Jenis Deskripsi

Ada masalah saat berinteraksi dengan layanan manajemen model.

linked_services

Cantumkan semua layanan tertaut di ruang kerja.

Mengembalikan

Jenis Deskripsi

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

location

Mengembalikan lokasi ruang kerja ini.

Mengembalikan

Jenis Deskripsi
str

Lokasi ruang kerja ini.

models

Mengembalikan daftar model di ruang kerja.

WebserviceException Menimbulkan jika ada masalah saat berinteraksi dengan layanan manajemen model.

Mengembalikan

Jenis Deskripsi

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

Pengecualian

Jenis Deskripsi

Ada masalah saat berinteraksi dengan layanan manajemen model.

name

Mengembalikan nama ruang kerja.

Mengembalikan

Jenis Deskripsi
str

Nama ruang kerja.

private_endpoints

Mencantumkan semua titik akhir privat ruang kerja.

Mengembalikan

Jenis Deskripsi

Dict objek PrivateEndPoint yang terkait dengan ruang kerja. Kuncinya adalah nama titik akhir privat.

resource_group

Mengembalikan nama grup sumber daya untuk ruang kerja ini.

Mengembalikan

Jenis Deskripsi
str

Nama grup sumber daya.

service_context

Mengembalikan konteks layanan untuk ruang kerja ini.

Mengembalikan

Jenis Deskripsi
<xref:azureml._restclient.service_context.ServiceContext>

Mengembalikan objek ServiceContext.

sku

Mengembalikan SKU ruang kerja ini.

Mengembalikan

Jenis Deskripsi
str

SKU ruang kerja ini.

subscription_id

Mengembalikan ID langganan untuk ruang kerja ini.

Mengembalikan

Jenis Deskripsi
str

ID langganan.

tags

Mengembalikan Tag ruang kerja ini.

Mengembalikan

Jenis Deskripsi

Tag ruang kerja ini.

webservices

Mengembalikan daftar layanan web di ruang kerja.

WebserviceException Memunculkan jika ada masalah saat mengembalikan daftar.

Mengembalikan

Jenis Deskripsi

Daftar layanan web di ruang kerja.

Pengecualian

Jenis Deskripsi

Ada masalah saat 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'