Module Osztály

Referencia

Egy Azure Machine Learning-folyamatban használt számítási egységet jelöl.

A modul olyan fájlok gyűjteménye, amelyek egy számítási célon futnak, és egy interfész leírása. A fájlok gyűjteménye lehet szkript, bináris fájl vagy bármely más fájl, amely a számítási célon való végrehajtáshoz szükséges. A modul felülete a bemeneteket, kimeneteket és paraméterdefiníciókat ismerteti. Nem köti őket adott értékekhez vagy adatokhoz. A modulhoz tartozik egy pillanatkép, amely rögzíti a modulhoz definiált fájlok gyűjteményét.

Modul inicializálása.

Öröklődés: builtins.object

Module

Konstruktor

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

Paraméterek

Name	Description
workspace Kötelező	Workspace A modul munkaterület-objektuma.
module_id Kötelező	str A modul azonosítója.
name Kötelező	str A modul neve.
description Kötelező	str A modul leírása.
status Kötelező	str A modul új állapota: "Aktív", "Elavult" vagy "Letiltva".
default_version Kötelező	str A modul alapértelmezett verziója.
module_version_list Kötelező	list Objektumok listája ModuleVersionDescriptor .
_module_provider	<xref:azureml.pipeline.core._aeva_provider._AzureMLModuleProvider> (Csak belső használatra.) A modulszolgáltató. alapértelmezett érték: None
_module_version_provider	<xref:azureml.pipeline.core._aeva_provider._AevaMlModuleVersionProvider> (Csak belső használatra.) A ModuleVersion szolgáltató. alapértelmezett érték: None
workspace Kötelező	Workspace A modul munkaterület-objektuma.
module_id Kötelező	str A modul azonosítója.
name Kötelező	str A modul neve.
description Kötelező	str A modul leírása.
status Kötelező	str A modul új állapota: "Aktív", "Elavult" vagy "Letiltva".
default_version Kötelező	str A modul alapértelmezett verziója.
module_version_list Kötelező	list Objektumok listája ModuleVersionDescriptor .
_module_provider Kötelező	<xref:<xref:_AevaMlModuleProvider object>> A modulszolgáltató.
_module_version_provider Kötelező	<xref:azureml.pipeline.core._aeva_provider._AevaMlModuleVersionProvider> A ModuleVersion szolgáltató.

Megjegyzések

A modulok a verzióinak tárolójaként szolgálnak. Az alábbi példában egy ModuleVersion jön létre a publish_python_script metódusból, és két bemenettel és két kimenettel rendelkezik. A ModuleVersion létrehozása az alapértelmezett verzió (is_default igaz értékre van állítva).


   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")

A teljes minta a következő forrásból érhető el: https://github.com/Azure/MachineLearningNotebooks/blob/master/how-to-use-azureml/machine-learning-pipelines/intro-to-pipelines/aml-pipelines-how-to-use-modulestep.ipynb

Ez a modul egy folyamat különböző lépésekben történő definiálásához használható egy ModuleStepparanccsal.

Az alábbi minta bemutatja, hogyan lehet a folyamatban használt adatokat egy ModuleVersion bemeneteihez és kimeneteihez a következő használatával PipelineDatabeszedni:


   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}

A leképezés ezután használható a ModuleStep létrehozásakor:


   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])

A modul használni kívánt verziójának feloldása a beküldéskor történik, és a következő folyamatot követi:

Az összes letiltott verzió eltávolítása
Ha egy adott verziót állítottak be, használja ezt a
Ha a modulhoz alapértelmezett verzió lett definiálva, használja azt, máskülönben
Ha az összes verzió betű nélkül követi a szemantikai verziószámozást, vegye a legmagasabb értéket, máskülönben
A modul legutóbb frissített verziójának használata

Vegye figyelembe, hogy mivel a csomópont bemenetei és kimenetei egy modul bemenetéhez és kimenetéhez vannak megfeleltetve a folyamat létrehozásakor, ha a beküldéskor feloldott verzió más illesztőfelülettel rendelkezik, mint amelyet a folyamat létrehozásakor feloldanak, akkor a folyamat beküldése sikertelen lesz.

A mögöttes modul frissíthető új verziókkal, miközben az alapértelmezett verzió változatlan marad.

A modulok egyedi névvel vannak elnevezve egy munkaterületen belül.

Metódusok

create	Hozza létre a modult.
deprecate	Állítsa a modult elavultra.
disable	Állítsa a modult "Letiltva" értékre.
enable	Állítsa a modult "Aktív" értékre.
get	A modul lekérése név vagy azonosító alapján; kivételt jelez, ha egyik sincs megadva.
get_default	Szerezze be az alapértelmezett modulverziót.
get_default_version	Szerezze be a Modul alapértelmezett verzióját.
get_versions	Szerezze be a modul összes verzióját.
module_def_builder	Hozza létre a lépést leíró moduldefiníciós objektumot.
module_version_list	A Modul verziólistájának lekérése.
process_source_directory	Dolgozza fel a lépés forráskönyvtárát, és ellenőrizze, hogy létezik-e a szkript.
publish	Hozzon létre egy ModuleVersion-t, és adja hozzá az aktuális modulhoz.
publish_adla_script	Hozzon létre egy ModulVerziót az Azure Data Lake Analytics (ADLA) alapján, és adja hozzá az aktuális modulhoz.
publish_azure_batch	Hozzon létre egy ModuleVersion-t, amely az Azure-köteget használja, és adja hozzá az aktuális modulhoz.
publish_python_script	Hozzon létre egy Python-szkripten alapuló ModuleVersion-t, és adja hozzá az aktuális modulhoz.
resolve	Oldja fel és adja vissza a megfelelő ModuleVersion modult.
set_default_version	Állítsa be a modul alapértelmezett ModuleVersion elemét.
set_description	Adja meg a modul leírását.
set_name	Adja meg a modul nevét.

create

Hozza létre a modult.

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

Paraméterek

Name	Description
workspace Kötelező	Workspace A munkaterület, amelyben létre kívánja hozni a modult.
name Kötelező	str A modul neve.
description Kötelező	str A modul leírása.
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Csak belső használatra.) A munkafolyamat-szolgáltató. alapértelmezett érték: None

Válaszok

Típus	Description
Module	Modulobjektum

deprecate

Állítsa a modult elavultra.

deprecate()

disable

Állítsa a modult "Letiltva" értékre.

disable()

enable

Állítsa a modult "Aktív" értékre.

enable()

get

A modul lekérése név vagy azonosító alapján; kivételt jelez, ha egyik sincs megadva.

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

Paraméterek

Name	Description
workspace Kötelező	Workspace A munkaterület, amelyben létre kívánja hozni a modult.
module_id	str A modul azonosítója. alapértelmezett érték: None
name	str A modul neve. alapértelmezett érték: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Csak belső használatra.) A munkafolyamat-szolgáltató. alapértelmezett érték: None

Válaszok

Típus	Description
Module	Modulobjektum

get_default

Szerezze be az alapértelmezett modulverziót.

get_default()

Válaszok

Típus	Description
ModuleVersion	A modul alapértelmezett verziója.

get_default_version

Szerezze be a Modul alapértelmezett verzióját.

get_default_version()

Válaszok

Típus	Description
str	A modul alapértelmezett verziója.

get_versions

Szerezze be a modul összes verzióját.

static get_versions(workspace, name, _workflow_provider=None)

Paraméterek

Name	Description
workspace Kötelező	Workspace A munkaterület, amelyen a modul létre lett hozva.
name Kötelező	str A modul neve.
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Csak belső használatra.) A munkafolyamat-szolgáltató. alapértelmezett érték: None

Válaszok

Típus	Description
list	A lista ModuleVersionDescriptor

module_def_builder

Hozza létre a lépést leíró moduldefiníciós objektumot.

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)

Paraméterek

Name	Description
name Kötelező	str A modul neve.
description Kötelező	str A modul leírása.
execution_type Kötelező	str A modul végrehajtási típusa.
input_bindings Kötelező	list A modul bemeneti kötései.
output_bindings Kötelező	list A modul kimeneti kötései.
param_defs	list A modul paramdefiníciói. alapértelmezett érték: None
create_sequencing_ports	bool Azt jelzi, hogy létrejönnek-e szekvenálási portok a modulhoz. alapértelmezett érték: True
allow_reuse	bool Azt jelzi, hogy a modul használható lesz-e újra felhasználhatóként. alapértelmezett érték: True
version	str A modul verziója. alapértelmezett érték: None
module_type	str A modul típusa. alapértelmezett érték: None
step_type	str A modulhoz társított lépés típusa, például "PythonScriptStep", "HyperDriveStep" stb. alapértelmezett érték: None
arguments	list A modul meghívásakor használandó jegyzetekkel ellátott argumentumok listája alapértelmezett érték: None
runconfig	str A python_script_step alapértelmezett érték: None
cloud_settings	str Felhőkhöz használt beállítások alapértelmezett érték: None

Válaszok

Típus	Description
ModuleDef	A Modul def objektum.

Kivételek

Típus	Description
ValueError

module_version_list

A Modul verziólistájának lekérése.

module_version_list()

Válaszok

Típus	Description
list	A lista ModuleVersionDescriptor

process_source_directory

Dolgozza fel a lépés forráskönyvtárát, és ellenőrizze, hogy létezik-e a szkript.

static process_source_directory(name, source_directory, script_name)

Paraméterek

Name	Description
name Kötelező	str A lépés neve.
source_directory Kötelező	str A lépés forráskönyvtára.
script_name Kötelező	str A lépés szkriptneve.

Válaszok

Típus	Description
str, list	A forráskönyvtár és a kivonat elérési útjai.

Kivételek

Típus	Description
ValueError

publish

Hozzon létre egy ModuleVersion-t, és adja hozzá az aktuális modulhoz.

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)

Paraméterek

Name	Description
description Kötelező	str A modul leírása.
execution_type Kötelező	str A modul végrehajtási típusa. Elfogadható értékek: `esCloud`és `adlcloudAzureBatchCloud`
inputs Kötelező	list A modul bemenetei.
outputs Kötelező	list A modul kimenetei.
param_defs	list A Modul paraméterdefiníciói. alapértelmezett érték: None
create_sequencing_ports	bool Azt jelzi, hogy létrejönnek-e szekvenáló portok a modulhoz. alapértelmezett érték: True
version	str A modul verziója. alapértelmezett érték: None
is_default	bool Azt jelzi, hogy a közzétett verzió legyen-e az alapértelmezett verzió. alapértelmezett érték: False
content_path	str címtár alapértelmezett érték: None
hash_paths	list A kivonat elérési útjainak listája a lépés tartalmának módosításakor. Ha nem észlelhető változás, a folyamat újra felhasználja az előző futtatásból származó lépés tartalmát. Alapértelmezés szerint a fájlok tartalma `source_directory` kivonatolt (kivéve az .amlignore vagy .gitignore fájlokat). ELAVULT: már nincs rá szükség. alapértelmezett érték: None
category	str A modulverzió kategóriája alapértelmezett érték: None
arguments	list A modul meghívásakor használandó argumentumok. Az argumentumok lehetnek sztringek, bemeneti hivatkozások (InputPortDef), kimeneti hivatkozások (OutputPortDef) és folyamatparaméterek (PipelineParameter). alapértelmezett érték: None
runconfig	RunConfiguration Választható RunConfiguration. A RunConfiguration használatával további követelményeket adhat meg a futtatáshoz, például conda-függőségeket és Docker-rendszerképeket. alapértelmezett érték: None

Válaszok

Típus	Description
ModuleVersion

Kivételek

Típus	Description
Exception

publish_adla_script

Hozzon létre egy ModulVerziót az Azure Data Lake Analytics (ADLA) alapján, és adja hozzá az aktuális modulhoz.

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)

Paraméterek

Name	Description
script_name Kötelező	str Egy ADLA-szkript neve a következőhöz `source_directory`viszonyítva: .
description Kötelező	str A modulverzió leírása.
inputs Kötelező	list A modul bemeneti kötései.
outputs Kötelező	list A modul kimeneti kötései.
params	dict A ModuleVersion params név-default_value párként. alapértelmezett érték: None
create_sequencing_ports	bool Azt jelzi, hogy létrejönnek-e szekvenáló portok a modulhoz. alapértelmezett érték: True
degree_of_parallelism	int A feladathoz használandó párhuzamosság mértéke. alapértelmezett érték: None
priority	int Az aktuális feladathoz használandó prioritási érték. alapértelmezett érték: None
runtime_version	str Az Azure Data Lake Analytics (ADLA) motor futtatókörnyezeti verziója. alapértelmezett érték: None
compute_target	AdlaCompute, str A feladathoz használni kívánt ADLA-számítás. alapértelmezett érték: None
version	str A modul verziója. alapértelmezett érték: None
is_default	bool Azt jelzi, hogy a közzétett verzió legyen-e az alapértelmezett verzió. alapértelmezett érték: False
source_directory	str címtár alapértelmezett érték: None
hash_paths	list hash_paths alapértelmezett érték: None
category	str A modulverzió kategóriája alapértelmezett érték: None
arguments	list A modul meghívásakor használandó argumentumok. Az argumentumok lehetnek sztringek, bemeneti hivatkozások (InputPortDef), kimeneti hivatkozások (OutputPortDef) és folyamatparaméterek (PipelineParameter). alapértelmezett érték: None

Válaszok

Típus	Description
ModuleVersion

publish_azure_batch

Hozzon létre egy ModuleVersion-t, amely az Azure-köteget használja, és adja hozzá az aktuális modulhoz.

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)

Paraméterek

Name	Description
description Kötelező	str A modulverzió leírása.
compute_target Kötelező	BatchCompute vagy str A BatchCompute számítási cél.
inputs Kötelező	list A modul bemeneti kötései.
outputs Kötelező	list A modul kimeneti kötései.
params	dict A ModuleVersion params név-default_value párként. alapértelmezett érték: None
create_sequencing_ports	bool Azt jelzi, hogy létrejönnek-e szekvenáló portok a modulhoz. alapértelmezett érték: True
version	str A modul verziója. alapértelmezett érték: None
is_default	bool Azt jelzi, hogy a közzétett verzió legyen-e az alapértelmezett verzió. alapértelmezett érték: False
create_pool	bool Azt jelzi, hogy létre kell-e hozni a készletet a feladatok futtatása előtt. alapértelmezett érték: False
pool_id	str (Kötelező) Annak a készletnek az azonosítója, ahol a feladat futni fog. alapértelmezett érték: None
delete_batch_job_after_finish	bool Azt jelzi, hogy törli-e a feladatot a Batch-fiókból a befejezés után. alapértelmezett érték: False
delete_batch_pool_after_finish	bool Azt jelzi, hogy törli-e a készletet a feladat befejezése után. alapértelmezett érték: False
is_positive_exit_code_failure	bool Azt jelzi, hogy a feladat meghiúsul-e, ha a tevékenység pozitív kóddal rendelkezik. alapértelmezett érték: True
vm_image_urn	str Ha `create_pool` igaz, és a virtuális gép VirtualMachineConfigurationt használ, akkor ez a paraméter a használni kívánt virtuálisgép-lemezképet jelzi. Értékformátum: `urn:publisher:offer:sku`. Példa: `urn:MicrosoftWindowsServer:WindowsServer:2012-R2-Datacenter`. alapértelmezett érték: urn:MicrosoftWindowsServer:WindowsServer:2012-R2-Datacenter
run_task_as_admin	bool Azt jelzi, hogy a feladatnak Rendszergazda jogosultságokkal kell-e futnia. alapértelmezett érték: False
target_compute_nodes	int Ha `create_pool` igaz, azt jelzi, hogy hány számítási csomópont lesz hozzáadva a készlethez. alapértelmezett érték: 1
vm_size	str Ha `create_pool` igaz, a számítási csomópontok virtuálisgép-méretét jelzi. alapértelmezett érték: standard_d1_v2
executable	str A feladat részeként végrehajtandó parancs/végrehajtható parancs neve. alapértelmezett érték: None
source_directory	str A forráskönyvtár. alapértelmezett érték: None
category	str A modulverzió kategóriája alapértelmezett érték: None
arguments	list A modul meghívásakor használandó argumentumok. Az argumentumok lehetnek sztringek, bemeneti hivatkozások (InputPortDef), kimeneti hivatkozások (OutputPortDef) és folyamatparaméterek (PipelineParameter). alapértelmezett érték: None

Válaszok

Típus	Description
ModuleVersion

Kivételek

Típus	Description
ValueError

publish_python_script

Hozzon létre egy Python-szkripten alapuló ModuleVersion-t, és adja hozzá az aktuális modulhoz.

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)

Paraméterek

Name	Description
script_name Kötelező	str Egy Python-szkript neve a következőhöz `source_directory`viszonyítva: .
description Kötelező	str A modulverzió leírása.
inputs Kötelező	list A modul bemeneti kötései.
outputs Kötelező	list A modul kimeneti kötései.
params	dict A ModuleVersion params név-default_value párként. alapértelmezett érték: None
create_sequencing_ports	bool Azt jelzi, hogy létrejönnek-e szekvenáló portok a modulhoz. alapértelmezett érték: True
version	str A modul verziója. alapértelmezett érték: None
is_default	bool Azt jelzi, hogy a közzétett verzió legyen-e az alapértelmezett verzió. alapértelmezett érték: False
source_directory	str címtár alapértelmezett érték: None
hash_paths	list A kivonat elérési útjainak listája a lépés tartalmának módosításakor. Ha nem észlelhető változás, a folyamat újra felhasználja az előző futtatásból származó lépés tartalmát. Alapértelmezés szerint a fájlok tartalma `source_directory` kivonatolt (kivéve az .amlignore vagy .gitignore fájlokat). ELAVULT: már nincs rá szükség. alapértelmezett érték: None
category	str A modulverzió kategóriája alapértelmezett érték: None
arguments	list A modul meghívásakor használandó argumentumok. Az argumentumok lehetnek sztringek, bemeneti hivatkozások (InputPortDef), kimeneti hivatkozások (OutputPortDef) és folyamatparaméterek (PipelineParameter). alapértelmezett érték: None
runconfig	RunConfiguration Választható RunConfiguration. A RunConfiguration használatával további követelményeket adhat meg a futtatáshoz, például conda-függőségeket és Docker-rendszerképeket. alapértelmezett érték: None

Válaszok

Típus	Description
ModuleVersion

resolve

Oldja fel és adja vissza a megfelelő ModuleVersion modult.

resolve(version=None)

Paraméterek

Name	Description
version	alapértelmezett érték: None

Válaszok

Típus	Description
ModuleVersion	A használni kívánt modulverzió.

set_default_version

Állítsa be a modul alapértelmezett ModuleVersion elemét.

set_default_version(version_id)

Paraméterek

Name	Description
version_id Kötelező

Válaszok

Típus	Description
str	Az alapértelmezett verzió.

Kivételek

Típus	Description
Exception

set_description

Adja meg a modul leírását.

set_description(description)

Paraméterek

Name	Description
description Kötelező	str A beállítandó leírás.

Kivételek

Típus	Description
Exception

set_name

Adja meg a modul nevét.

set_name(name)

Paraméterek

Name	Description
name Kötelező	str A beállítandó név.

Kivételek

Típus	Description
Exception

Attribútumok

default_version

Szerezze be a modul alapértelmezett verzióját.

Válaszok

Típus	Description
str	Az alapértelmezett verziósztring.

description

A modul leírásának lekérése.

Válaszok

Típus	Description
str	A leírási sztring.

id

Szerezze be a modul azonosítóját.

Válaszok

Típus	Description
str	Az azonosító.

name

Kérje le a modul nevét.

Válaszok

Típus	Description
str	A név.

status

A modul állapotának lekérése.

Válaszok

Típus	Description
str	Az állapot.

Module Osztály

Konstruktor

Paraméterek

Megjegyzések

Metódusok

create

Paraméterek

Válaszok

deprecate

disable

enable

get

Paraméterek

Válaszok

get_default

Válaszok

get_default_version

Válaszok

get_versions

Paraméterek

Válaszok

module_def_builder

Paraméterek

Válaszok

Kivételek

module_version_list

Válaszok

process_source_directory

Paraméterek

Válaszok

Kivételek

publish

Paraméterek

Válaszok

Kivételek

publish_adla_script

Paraméterek

Válaszok

publish_azure_batch

Paraméterek

Válaszok

Kivételek

publish_python_script

Paraméterek

Válaszok

resolve

Paraméterek

Válaszok

set_default_version

Paraméterek

Válaszok

Kivételek

set_description

Paraméterek

Kivételek

set_name

Paraméterek

Kivételek

Attribútumok

default_version

Válaszok

description

Válaszok

id

Válaszok

name

Válaszok

status

Válaszok

Visszajelzés

Visszajelzés

További források