Share via


Module Sınıf

Azure Machine Learning işlem hattında kullanılan bir hesaplama birimini temsil eder.

Modül, işlem hedefi üzerinde çalıştırılacak dosyalardan oluşan bir koleksiyon ve bir arabirimin açıklamasıdır. Dosya koleksiyonu betik, ikili dosyalar veya işlem hedefinde yürütmek için gereken diğer dosyalar olabilir. Modül arabirimi girişler, çıkışlar ve parametre tanımlarını açıklar. Bunları belirli değerlere veya verilere bağlamaz. Bir modülün kendisiyle ilişkilendirilmiş bir anlık görüntüsü vardır ve bu anlık görüntü modül için tanımlanan dosya koleksiyonunu yakalar.

Modülü Başlat'ı seçin.

Devralma
builtins.object
Module

Oluşturucu

Module(workspace, module_id, name, description, status, default_version, module_version_list, _module_provider=None, _module_version_provider=None)

Parametreler

Name Description
workspace
Gerekli

Bu Modülün ait olduğu çalışma alanı nesnesi.

module_id
Gerekli
str

Modülün Kimliği.

name
Gerekli
str

Modülün adı.

description
Gerekli
str

Modülün Açıklaması.

status
Gerekli
str

Modülün yeni durumu: 'Etkin', 'Kullanım Dışı' veya 'Devre Dışı'.

default_version
Gerekli
str

Modülün varsayılan sürümü.

module_version_list
Gerekli

Nesnelerin listesi ModuleVersionDescriptor .

_module_provider
<xref:azureml.pipeline.core._aeva_provider._AzureMLModuleProvider>

(Yalnızca iç kullanım.) Modül sağlayıcısı.

varsayılan değer: None
_module_version_provider
<xref:azureml.pipeline.core._aeva_provider._AevaMlModuleVersionProvider>

(Yalnızca iç kullanım.) ModuleVersion sağlayıcısı.

varsayılan değer: None
workspace
Gerekli

Bu Modülün ait olduğu çalışma alanı nesnesi.

module_id
Gerekli
str

Modülün Kimliği.

name
Gerekli
str

Modülün adı.

description
Gerekli
str

Modülün Açıklaması.

status
Gerekli
str

Modülün yeni durumu: 'Etkin', 'Kullanım Dışı' veya 'Devre Dışı'.

default_version
Gerekli
str

Modülün varsayılan sürümü.

module_version_list
Gerekli

Nesnelerin listesi ModuleVersionDescriptor .

_module_provider
Gerekli
<xref:<xref:_AevaMlModuleProvider object>>

Modül sağlayıcısı.

_module_version_provider
Gerekli
<xref:azureml.pipeline.core._aeva_provider._AevaMlModuleVersionProvider>

ModuleVersion sağlayıcısı.

Açıklamalar

Modül, sürümlerinin kapsayıcısı olarak görev yapar. Aşağıdaki örnekte, yönteminden publish_python_script bir ModuleVersion oluşturulur ve iki girişi ve iki çıkışı vardır. Create ModuleVersion varsayılan sürümdür (is_default True olarak ayarlanır).


   out_sum = OutputPortDef(name="out_sum", default_datastore_name=datastore.name, default_datastore_mode="mount",
                           label="Sum of two numbers")
   out_prod = OutputPortDef(name="out_prod", default_datastore_name=datastore.name, default_datastore_mode="mount",
                            label="Product of two numbers")
   entry_version = module.publish_python_script("calculate.py", "initial",
                                                inputs=[], outputs=[out_sum, out_prod], params = {"initialNum":12},
                                                version="1", source_directory="./calc")

Tam örnek şu kaynaktan edinilebilir: https://github.com/Azure/MachineLearningNotebooks/blob/master/how-to-use-azureml/machine-learning-pipelines/intro-to-pipelines/aml-pipelines-how-to-use-modulestep.ipynb

Bu modül, farklı adımlarda bir işlem hattı tanımlarken bir ModuleStepkullanılarak kullanılabilir.

Aşağıdaki örnek, kullanarak PipelineDataişlem hattında kullanılan verilerin ModuleVersion girişlerine ve çıkışlarına nasıl aktarılabileceğini gösterir:


   middle_step_input_wiring = {"in1":first_sum, "in2":first_prod}
   middle_sum = PipelineData("middle_sum", datastore=datastore, output_mode="mount",is_directory=False)
   middle_prod = PipelineData("middle_prod", datastore=datastore, output_mode="mount",is_directory=False)
   middle_step_output_wiring = {"out_sum":middle_sum, "out_prod":middle_prod}

Tam örnek şu kaynaktan edinilebilir: https://github.com/Azure/MachineLearningNotebooks/blob/master/how-to-use-azureml/machine-learning-pipelines/intro-to-pipelines/aml-pipelines-how-to-use-modulestep.ipynb

Daha sonra ModuleStep oluşturulurken eşleme kullanılabilir:


   middle_step = ModuleStep(module=module,
                            inputs_map= middle_step_input_wiring,
                            outputs_map= middle_step_output_wiring,
                            runconfig=RunConfiguration(), compute_target=aml_compute,
                            arguments = ["--file_num1", first_sum, "--file_num2", first_prod,
                                         "--output_sum", middle_sum, "--output_product", middle_prod])

Tam örnek şu kaynaktan edinilebilir: https://github.com/Azure/MachineLearningNotebooks/blob/master/how-to-use-azureml/machine-learning-pipelines/intro-to-pipelines/aml-pipelines-how-to-use-modulestep.ipynb

Modülün hangi sürümünün kullanılacağı, gönderim sonrasında gerçekleşir ve aşağıdaki işlemi izler:

  • Devre dışı bırakılan tüm sürümleri kaldırma
  • Belirli bir sürüm belirtildiyse, bunu kullanın, aksi takdirde
  • Modül için varsayılan bir sürüm tanımlanmışsa bunu kullanın, aksi takdirde
  • Tüm sürümler harfsiz anlamsal sürüm oluşturma işlemini izlerse, en yüksek değeri alın, aksi takdirde
  • Modülün en son güncelleştirilen sürümünü alın

Düğümün giriş ve çıkışlarının modülün giriş ve çıkışına eşlenmesi İşlem hattı oluşturma sırasında tanımlandığından, gönderim sonrasında çözümlenen sürüm işlem hattı oluşturma işleminde çözümlenenden farklı bir arabirime sahipse işlem hattı gönderiminin başarısız olacağını unutmayın.

Temel alınan modül, varsayılan sürüm aynı tutularak yeni sürümlerle güncelleştirilebilir.

Modüller çalışma alanında benzersiz olarak adlandırılır.

Yöntemler

create

Modülü oluşturun.

deprecate

Modülü 'Kullanım Dışı' olarak ayarlayın.

disable

Modülü 'Devre Dışı' olarak ayarlayın.

enable

Modülü 'Etkin' olarak ayarlayın.

get

Modülü ada veya kimlikle alın; sağlanmazsa bir özel durum oluşturur.

get_default

Varsayılan modül sürümünü alın.

get_default_version

Modülün varsayılan sürümünü alın.

get_versions

Modülün tüm sürümlerini alın.

module_def_builder

Adımı açıklayan modül tanımı nesnesini oluşturun.

module_version_list

Modül sürümü listesini alın.

process_source_directory

Adım için kaynak dizini işleyin ve betiğin mevcut olup olmadığını denetleyin.

publish

Bir ModuleVersion oluşturun ve bunu geçerli Modüle ekleyin.

publish_adla_script

Azure Data Lake Analytics (ADLA) tabanlı bir ModuleVersion oluşturun ve bunu geçerli Modüle ekleyin.

publish_azure_batch

Azure toplu işlemini kullanan bir ModuleVersion oluşturun ve bunu geçerli Modüle ekleyin.

publish_python_script

Python betiğini temel alan bir ModuleVersion oluşturun ve bunu geçerli Modüle ekleyin.

resolve

Doğru ModuleVersion'ı çözümleyip döndürebilirsiniz.

set_default_version

Modülün varsayılan ModuleVersion değerini ayarlayın.

set_description

Modülün açıklamasını ayarlayın.

set_name

Modül adını ayarlayın.

create

Modülü oluşturun.

static create(workspace, name, description, _workflow_provider=None)

Parametreler

Name Description
workspace
Gerekli

Modülün oluşturulacağı çalışma alanı.

name
Gerekli
str

Modülün adı.

description
Gerekli
str

Modülün Açıklaması.

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

(Yalnızca iç kullanım.) İş akışı sağlayıcısı.

varsayılan değer: None

Döndürülenler

Tür Description

Modül nesnesi

deprecate

Modülü 'Kullanım Dışı' olarak ayarlayın.

deprecate()

disable

Modülü 'Devre Dışı' olarak ayarlayın.

disable()

enable

Modülü 'Etkin' olarak ayarlayın.

enable()

get

Modülü ada veya kimlikle alın; sağlanmazsa bir özel durum oluşturur.

static get(workspace, module_id=None, name=None, _workflow_provider=None)

Parametreler

Name Description
workspace
Gerekli

Modülün oluşturulacağı çalışma alanı.

module_id
str

Modülün Kimliği.

varsayılan değer: None
name
str

Modülün adı.

varsayılan değer: None
_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

(Yalnızca iç kullanım.) İş akışı sağlayıcısı.

varsayılan değer: None

Döndürülenler

Tür Description

Modül nesnesi

get_default

Varsayılan modül sürümünü alın.

get_default()

Döndürülenler

Tür Description

Varsayılan modül sürümü.

get_default_version

Modülün varsayılan sürümünü alın.

get_default_version()

Döndürülenler

Tür Description
str

Modülün varsayılan sürümü.

get_versions

Modülün tüm sürümlerini alın.

static get_versions(workspace, name, _workflow_provider=None)

Parametreler

Name Description
workspace
Gerekli

Modülün oluşturulduğu çalışma alanı.

name
Gerekli
str

Modülün adı.

_workflow_provider
<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider>

(Yalnızca iç kullanım.) İş akışı sağlayıcısı.

varsayılan değer: None

Döndürülenler

Tür Description

Listesi: ModuleVersionDescriptor

module_def_builder

Adımı açıklayan modül tanımı nesnesini oluşturun.

static module_def_builder(name, description, execution_type, input_bindings, output_bindings, param_defs=None, create_sequencing_ports=True, allow_reuse=True, version=None, module_type=None, step_type=None, arguments=None, runconfig=None, cloud_settings=None)

Parametreler

Name Description
name
Gerekli
str

Modülün adı.

description
Gerekli
str

Modülün Açıklaması.

execution_type
Gerekli
str

Modülün yürütme türü.

input_bindings
Gerekli

Modül giriş bağlamaları.

output_bindings
Gerekli

Modül çıkış bağlamaları.

param_defs

Module param tanımları.

varsayılan değer: None
create_sequencing_ports

Modül için sıralama bağlantı noktalarının oluşturulup oluşturulmayacağını gösterir.

varsayılan değer: True
allow_reuse

Modülün yeniden kullanılabilir olup olmayacağını gösterir.

varsayılan değer: True
version
str

Modülün sürümü.

varsayılan değer: None
module_type
str

Modül türü.

varsayılan değer: None
step_type
str

Bu modülle ilişkilendirilmiş adımın türü, örneğin "PythonScriptStep", "HyperDriveStep" vb.

varsayılan değer: None
arguments

Bu modül çağrılırken kullanılacak ek açıklamalı bağımsız değişkenler listesi

varsayılan değer: None
runconfig
str

python_script_step için kullanılacak runconfig

varsayılan değer: None
cloud_settings
str

Bulutlar için kullanılacak ayarlar

varsayılan değer: None

Döndürülenler

Tür Description

Module def nesnesi.

Özel durumlar

Tür Description

module_version_list

Modül sürümü listesini alın.

module_version_list()

Döndürülenler

Tür Description

Listesi: ModuleVersionDescriptor

process_source_directory

Adım için kaynak dizini işleyin ve betiğin mevcut olup olmadığını denetleyin.

static process_source_directory(name, source_directory, script_name)

Parametreler

Name Description
name
Gerekli
str

Adımın adı.

source_directory
Gerekli
str

Adımın kaynak dizini.

script_name
Gerekli
str

Adımın betik adı.

Döndürülenler

Tür Description

Kaynak dizin ve karma yolları.

Özel durumlar

Tür Description

publish

Bir ModuleVersion oluşturun ve bunu geçerli Modüle ekleyin.

publish(description, execution_type, inputs, outputs, param_defs=None, create_sequencing_ports=True, version=None, is_default=False, content_path=None, hash_paths=None, category=None, arguments=None, runconfig=None)

Parametreler

Name Description
description
Gerekli
str

Modülün Açıklaması.

execution_type
Gerekli
str

Modülün yürütme türü. Kabul edilebilir değerler , adlcloud ve değerleridir esCloudAzureBatchCloud

inputs
Gerekli

Modül girişleri.

outputs
Gerekli

Modül çıkışları.

param_defs

Modül parametresi tanımları.

varsayılan değer: None
create_sequencing_ports

Modül için sıralama bağlantı noktalarının oluşturulup oluşturulmayacağını gösterir.

varsayılan değer: True
version
str

Modülün sürümü.

varsayılan değer: None
is_default

Yayımlanan sürümün varsayılan sürüm olup olmadığını gösterir.

varsayılan değer: False
content_path
str

dizin

varsayılan değer: None
hash_paths

Adım içeriğinde yapılan değişiklikler denetlenirken karma olarak kullanılacak yolların listesi. Hiçbir değişiklik algılanmazsa işlem hattı önceki çalıştırmadaki adım içeriğini yeniden kullanır. Varsayılan olarak, içeriğinin source_directory karma değeri verilmiştir (.amlignore veya .gitignore içinde listelenen dosyalar hariç). KULLANIMDAN KALKTI: Artık gerekli değil.

varsayılan değer: None
category
str

Modül sürümünün kategorisi

varsayılan değer: None
arguments

Modülü çağırırken kullanılacak bağımsız değişkenler. Bağımsız değişkenler dizeler, giriş başvuruları (InputPortDef), çıkış başvuruları (OutputPortDef) ve işlem hattı parametreleri (PipelineParameter) olabilir.

varsayılan değer: None
runconfig

İsteğe bağlı bir RunConfiguration. RunConfiguration, conda bağımlılıkları ve Docker görüntüsü gibi ek çalıştırma gereksinimlerini belirtmek için kullanılabilir.

varsayılan değer: None

Döndürülenler

Tür Description

Özel durumlar

Tür Description

publish_adla_script

Azure Data Lake Analytics (ADLA) tabanlı bir ModuleVersion oluşturun ve bunu geçerli Modüle ekleyin.

publish_adla_script(script_name, description, inputs, outputs, params=None, create_sequencing_ports=True, degree_of_parallelism=None, priority=None, runtime_version=None, compute_target=None, version=None, is_default=False, source_directory=None, hash_paths=None, category=None, arguments=None)

Parametreler

Name Description
script_name
Gerekli
str

ADLA betiğinin adı, ile ilgili olarak source_directory.

description
Gerekli
str

Modül sürümünün açıklaması.

inputs
Gerekli

Modül giriş bağlamaları.

outputs
Gerekli

Modül çıkış bağlamaları.

params

ModuleVersion parametreleri, ad default_value çiftleri olarak.

varsayılan değer: None
create_sequencing_ports

Modül için sıralama bağlantı noktalarının oluşturulup oluşturulmayacağını gösterir.

varsayılan değer: True
degree_of_parallelism
int

Bu iş için kullanılacak paralellik derecesi.

varsayılan değer: None
priority
int

Geçerli iş için kullanılacak öncelik değeri.

varsayılan değer: None
runtime_version
str

Azure Data Lake Analytics (ADLA) altyapısının çalışma zamanı sürümü.

varsayılan değer: None
compute_target

Bu iş için kullanılacak ADLA işlemi.

varsayılan değer: None
version
str

Modülün sürümü.

varsayılan değer: None
is_default

Yayımlanan sürümün varsayılan sürüm olup olmadığını gösterir.

varsayılan değer: False
source_directory
str

dizin

varsayılan değer: None
hash_paths

hash_paths

varsayılan değer: None
category
str

Modül sürümünün kategorisi

varsayılan değer: None
arguments

Modülü çağırırken kullanılacak bağımsız değişkenler. Bağımsız değişkenler dizeler, giriş başvuruları (InputPortDef), çıkış başvuruları (OutputPortDef) ve işlem hattı parametreleri (PipelineParameter) olabilir.

varsayılan değer: None

Döndürülenler

Tür Description

publish_azure_batch

Azure toplu işlemini kullanan bir ModuleVersion oluşturun ve bunu geçerli Modüle ekleyin.

publish_azure_batch(description, compute_target, inputs, outputs, params=None, create_sequencing_ports=True, version=None, is_default=False, create_pool=False, pool_id=None, delete_batch_job_after_finish=False, delete_batch_pool_after_finish=False, is_positive_exit_code_failure=True, vm_image_urn='urn:MicrosoftWindowsServer:WindowsServer:2012-R2-Datacenter', run_task_as_admin=False, target_compute_nodes=1, vm_size='standard_d1_v2', executable=None, source_directory=None, category=None, arguments=None)

Parametreler

Name Description
description
Gerekli
str

Modül sürümünün açıklaması.

compute_target
Gerekli

BatchCompute işlem hedefi.

inputs
Gerekli

Modül giriş bağlamaları.

outputs
Gerekli

Modül çıkış bağlamaları.

params

ModuleVersion parametreleri, ad default_value çiftleri olarak.

varsayılan değer: None
create_sequencing_ports

Modül için sıralama bağlantı noktalarının oluşturulup oluşturulmayacağını gösterir.

varsayılan değer: True
version
str

Modülün sürümü.

varsayılan değer: None
is_default

Yayımlanan sürümün varsayılan sürüm olup olmadığını gösterir.

varsayılan değer: False
create_pool

İşleri çalıştırmadan önce havuzun oluşturulup oluşturulmayacağını gösterir.

varsayılan değer: False
pool_id
str

(Zorunlu) İşin çalıştırılacağı Havuzun kimliği.

varsayılan değer: None
delete_batch_job_after_finish

İşlem tamamlandıktan sonra işin Batch hesabından silinip silinmeyeceğini gösterir.

varsayılan değer: False
delete_batch_pool_after_finish

İş bittikten sonra havuzun silinip silinmeyeceğini gösterir.

varsayılan değer: False
is_positive_exit_code_failure

Görevin pozitif bir kodla mevcut olması durumunda işinin başarısız olup olmadığını gösterir.

varsayılan değer: True
vm_image_urn
str

True ise ve VM VirtualMachineConfiguration kullanıyorsa create_pool , bu parametre kullanılacak VM görüntüsünü gösterir. Değer biçimi: urn:publisher:offer:sku. Örnek: urn:MicrosoftWindowsServer:WindowsServer:2012-R2-Datacenter.

varsayılan değer: urn:MicrosoftWindowsServer:WindowsServer:2012-R2-Datacenter
run_task_as_admin

Görevin Yönetici ayrıcalıklarla çalışıp çalışmayacağını gösterir.

varsayılan değer: False
target_compute_nodes
int

create_pool True ise havuza kaç işlem düğümü ekleneceğini gösterir.

varsayılan değer: 1
vm_size
str

create_pool True ise, işlem düğümlerinin sanal makine boyutunu gösterir.

varsayılan değer: standard_d1_v2
executable
str

İşin bir parçası olarak yürütülecek komutun/yürütülebilir dosyanın adı.

varsayılan değer: None
source_directory
str

Kaynak dizin.

varsayılan değer: None
category
str

Modül sürümünün kategorisi

varsayılan değer: None
arguments

Modülü çağırırken kullanılacak bağımsız değişkenler. Bağımsız değişkenler dizeler, giriş başvuruları (InputPortDef), çıkış başvuruları (OutputPortDef) ve işlem hattı parametreleri (PipelineParameter) olabilir.

varsayılan değer: None

Döndürülenler

Tür Description

Özel durumlar

Tür Description

publish_python_script

Python betiğini temel alan bir ModuleVersion oluşturun ve bunu geçerli Modüle ekleyin.

publish_python_script(script_name, description, inputs, outputs, params=None, create_sequencing_ports=True, version=None, is_default=False, source_directory=None, hash_paths=None, category=None, arguments=None, runconfig=None)

Parametreler

Name Description
script_name
Gerekli
str

Python betiğinin adı, ile ilgili olarak source_directory.

description
Gerekli
str

Modül sürümünün açıklaması.

inputs
Gerekli

Modül giriş bağlamaları.

outputs
Gerekli

Modül çıkış bağlamaları.

params

ModuleVersion parametreleri, ad default_value çiftleri olarak.

varsayılan değer: None
create_sequencing_ports

Modül için sıralama bağlantı noktalarının oluşturulup oluşturulmayacağını gösterir.

varsayılan değer: True
version
str

Modülün sürümü.

varsayılan değer: None
is_default

Yayımlanan sürümün varsayılan sürüm olup olmadığını gösterir.

varsayılan değer: False
source_directory
str

dizin

varsayılan değer: None
hash_paths

Adım içeriğinde yapılan değişiklikler denetlenirken karma olarak kullanılacak yolların listesi. Hiçbir değişiklik algılanmazsa işlem hattı önceki çalıştırmadaki adım içeriğini yeniden kullanır. Varsayılan olarak içeriğinin source_directory karma değeri kullanılır (.amlignore veya .gitignore içinde listelenen dosyalar hariç). KULLANIMDAN KALKTI: Artık gerekli değil.

varsayılan değer: None
category
str

Modül sürümünün kategorisi

varsayılan değer: None
arguments

Modülü çağırırken kullanılacak bağımsız değişkenler. Bağımsız değişkenler dizeler, giriş başvuruları (InputPortDef), çıkış başvuruları (OutputPortDef) ve işlem hattı parametreleri (PipelineParameter) olabilir.

varsayılan değer: None
runconfig

İsteğe bağlı bir RunConfiguration. RunConfiguration, conda bağımlılıkları ve Docker görüntüsü gibi ek çalıştırma gereksinimlerini belirtmek için kullanılabilir.

varsayılan değer: None

Döndürülenler

Tür Description

resolve

Doğru ModuleVersion'ı çözümleyip döndürebilirsiniz.

resolve(version=None)

Parametreler

Name Description
version
varsayılan değer: None

Döndürülenler

Tür Description

Kullanılacak Modül sürümü.

set_default_version

Modülün varsayılan ModuleVersion değerini ayarlayın.

set_default_version(version_id)

Parametreler

Name Description
version_id
Gerekli

Döndürülenler

Tür Description
str

Varsayılan sürüm.

Özel durumlar

Tür Description

set_description

Modülün açıklamasını ayarlayın.

set_description(description)

Parametreler

Name Description
description
Gerekli
str

Ayarlanacağı açıklama.

Özel durumlar

Tür Description

set_name

Modül adını ayarlayın.

set_name(name)

Parametreler

Name Description
name
Gerekli
str

Ayarlanacağı ad.

Özel durumlar

Tür Description

Öznitelikler

default_version

Modülün varsayılan sürümünü alın.

Döndürülenler

Tür Description
str

Varsayılan sürüm dizesi.

description

Modülün açıklamasını alın.

Döndürülenler

Tür Description
str

Açıklama dizesi.

id

Modülün kimliğini alın.

Döndürülenler

Tür Description
str

Kimlik.

name

Modülün adını alın.

Döndürülenler

Tür Description
str

Ad.

status

Modülün durumunu alın.

Döndürülenler

Tür Description
str

Durum.