Module Klas

Referentie

Vertegenwoordigt een rekeneenheid die wordt gebruikt in een Azure Machine Learning-pijplijn.

Een module is een verzameling bestanden die worden uitgevoerd op een rekendoel en een beschrijving van een interface. De verzameling bestanden kan script, binaire bestanden of andere bestanden zijn die nodig zijn om uit te voeren op het rekendoel. De module-interface beschrijft invoer, uitvoer en parameterdefinities. Ze worden niet gebonden aan specifieke waarden of gegevens. Aan een module is een momentopname gekoppeld, die de verzameling bestanden vastlegt die voor de module zijn gedefinieerd.

Module initialiseren.

Overname: builtins.object

Module

Constructor

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

Parameters

Name	Description
workspace Vereist	Workspace Het werkruimteobject waartoe deze module behoort.
module_id Vereist	str De id van de module.
name Vereist	str De naam van de module.
description Vereist	str De beschrijving van de module.
status Vereist	str De nieuwe status van de module: 'Actief', 'Afgeschaft' of 'Uitgeschakeld'.
default_version Vereist	str De standaardversie van de module.
module_version_list Vereist	list Een lijst met ModuleVersionDescriptor objecten.
_module_provider	<xref:azureml.pipeline.core._aeva_provider._AzureMLModuleProvider> (Alleen intern gebruik.) De moduleprovider. Default value: None
_module_version_provider	<xref:azureml.pipeline.core._aeva_provider._AevaMlModuleVersionProvider> (Alleen intern gebruik.) De ModuleVersion-provider. Default value: None
workspace Vereist	Workspace Het werkruimteobject waartoe deze module behoort.
module_id Vereist	str De id van de module.
name Vereist	str De naam van de module.
description Vereist	str De beschrijving van de module.
status Vereist	str De nieuwe status van de module: 'Actief', 'Afgeschaft' of 'Uitgeschakeld'.
default_version Vereist	str De standaardversie van de module.
module_version_list Vereist	list Een lijst met ModuleVersionDescriptor objecten.
_module_provider Vereist	<xref:<xref:_AevaMlModuleProvider object>> De moduleprovider.
_module_version_provider Vereist	<xref:azureml.pipeline.core._aeva_provider._AevaMlModuleVersionProvider> De ModuleVersion-provider.

Opmerkingen

Een module fungeert als een container van de bijbehorende versies. In het volgende voorbeeld wordt een ModuleVersion gemaakt op basis van de publish_python_script methode en heeft deze twee invoer- en twee uitvoerwaarden. De create ModuleVersion is de standaardversie (is_default is ingesteld op True).


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

Volledig voorbeeld is beschikbaar via https://github.com/Azure/MachineLearningNotebooks/blob/master/how-to-use-azureml/machine-learning-pipelines/intro-to-pipelines/aml-pipelines-how-to-use-modulestep.ipynb

Deze module kan worden gebruikt bij het definiëren van een pijplijn, in verschillende stappen, met behulp van een ModuleStep.

In het volgende voorbeeld ziet u hoe u de gegevens die in de pijplijn worden gebruikt, kunt koppelen aan de invoer en uitvoer van een ModuleVersion met behulp van PipelineData:


   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}

De toewijzing kan vervolgens worden gebruikt bij het maken van de moduleStap:


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

De oplossing van welke versie van de module moet worden gebruikt, vindt plaats bij het indienen en volgt de volgende procedure:

Alle uitgeschakelde versies verwijderen
Als er een specifieke versie is vermeld, gebruikt u die, anders
Als er een standaardversie is gedefinieerd voor de module, gebruikt u die, anders
Als alle versies semantisch versiebeheer zonder letters volgen, neemt u de hoogste waarde, anders
Neem de versie van de module die het laatst is bijgewerkt

Houd er rekening mee dat, omdat de toewijzing van de invoer en uitvoer van een knooppunt aan de invoer en uitvoer van een module wordt gedefinieerd bij het maken van de pijplijn, als de opgeloste versie bij het indienen een andere interface heeft dan de interface die wordt opgelost bij het maken van de pijplijn, mislukt het verzenden van de pijplijn.

De onderliggende module kan worden bijgewerkt met nieuwe versies terwijl de standaardversie hetzelfde blijft.

Modules hebben een unieke naam binnen een werkruimte.

Methoden

create	Maak de module.
deprecate	Stel de module in op 'Afgeschaft'.
disable	Stel de module in op Uitgeschakeld.
enable	Stel de module in op 'Actief'.
get	Haal de module op naam of id op; genereert een uitzondering als een van beide niet is opgegeven.
get_default	Haal de standaardmoduleversie op.
get_default_version	Haal de standaardversie van Module op.
get_versions	Haal alle versies van de module op.
module_def_builder	Maak het moduledefinitieobject dat de stap beschrijft.
module_version_list	Haal de lijst met moduleversies op.
process_source_directory	Verwerk de bronmap voor de stap en controleer of het script bestaat.
publish	Maak een ModuleVersion en voeg deze toe aan de huidige module.
publish_adla_script	Maak een ModuleVersion op basis van Azure Data Lake Analytics (ADLA) en voeg deze toe aan de huidige module.
publish_azure_batch	Maak een ModuleVersion die gebruikmaakt van Azure Batch en voeg deze toe aan de huidige module.
publish_python_script	Maak een ModuleVersion die is gebaseerd op een Python-script en voeg deze toe aan de huidige module.
resolve	Los het probleem op en retourneer de juiste ModuleVersion.
set_default_version	Stel de standaardModuleVersie van de module in.
set_description	Stel de beschrijving van module in.
set_name	Stel de naam van de module in.

create

Maak de module.

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

Parameters

Name	Description
workspace Vereist	Workspace De werkruimte waarin de module moet worden gemaakt.
name Vereist	str De naam van de module.
description Vereist	str De beschrijving van de module.
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Alleen intern gebruik.) De werkstroomprovider. Default value: None

Retouren

Type	Description
Module	Moduleobject

deprecate

Stel de module in op 'Afgeschaft'.

deprecate()

disable

Stel de module in op Uitgeschakeld.

disable()

enable

Stel de module in op 'Actief'.

enable()

get

Haal de module op naam of id op; genereert een uitzondering als een van beide niet is opgegeven.

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

Parameters

Name	Description
workspace Vereist	Workspace De werkruimte waarin de module moet worden gemaakt.
module_id	str De id van de module. Default value: None
name	str De naam van de module. Default value: None
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Alleen intern gebruik.) De werkstroomprovider. Default value: None

Retouren

Type	Description
Module	Moduleobject

get_default

Haal de standaardmoduleversie op.

get_default()

Retouren

Type	Description
ModuleVersion	De standaardmoduleversie.

get_default_version

Haal de standaardversie van Module op.

get_default_version()

Retouren

Type	Description
str	De standaardversie van de module.

get_versions

Haal alle versies van de module op.

static get_versions(workspace, name, _workflow_provider=None)

Parameters

Name	Description
workspace Vereist	Workspace De werkruimte waarop de module is gemaakt.
name Vereist	str De naam van de module.
_workflow_provider	<xref:azureml.pipeline.core._aeva_provider._AevaWorkflowProvider> (Alleen intern gebruik.) De werkstroomprovider. Default value: None

Retouren

Type	Description
list	De lijst met ModuleVersionDescriptor

module_def_builder

Maak het moduledefinitieobject dat de stap beschrijft.

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)

Parameters

Name	Description
name Vereist	str De naam van de module.
description Vereist	str De beschrijving van de module.
execution_type Vereist	str Het uitvoeringstype van de module.
input_bindings Vereist	list De module-invoerbindingen.
output_bindings Vereist	list De uitvoerbindingen van de module.
param_defs	list De moduleparameterdefinities. Default value: None
create_sequencing_ports	bool Geeft aan of er sequentiërende poorten worden gemaakt voor de module. Default value: True
allow_reuse	bool Hiermee wordt aangegeven of de module beschikbaar is voor hergebruik. Default value: True
version	str De versie van de module. Default value: None
module_type	str Het moduletype. Default value: None
step_type	str Het type stap dat aan deze module is gekoppeld, bijvoorbeeld 'PythonScriptStep', 'HyperDriveStep', enzovoort. Default value: None
arguments	list Lijst met argumenten met aantekeningen die moeten worden gebruikt bij het aanroepen van deze module Default value: None
runconfig	str Runconfig die wordt gebruikt voor python_script_step Default value: None
cloud_settings	str Instellingen die worden gebruikt voor clouds Default value: None

Retouren

Type	Description
ModuleDef	Het object Module def.

Uitzonderingen

Type	Description
ValueError

module_version_list

Haal de lijst met moduleversies op.

module_version_list()

Retouren

Type	Description
list	De lijst met ModuleVersionDescriptor

process_source_directory

Verwerk de bronmap voor de stap en controleer of het script bestaat.

static process_source_directory(name, source_directory, script_name)

Parameters

Name	Description
name Vereist	str De naam van de stap.
source_directory Vereist	str De bronmap voor de stap.
script_name Vereist	str De scriptnaam voor de stap.

Retouren

Type	Description
str, list	De bronmap en hashpaden.

Uitzonderingen

Type	Description
ValueError

publish

Maak een ModuleVersion en voeg deze toe aan de huidige module.

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)

Parameters

Name	Description
description Vereist	str De beschrijving van de module.
execution_type Vereist	str Het uitvoeringstype van de module. Acceptabele waarden zijn `esCloud`, `adlcloud` en `AzureBatchCloud`
inputs Vereist	list De module-invoer.
outputs Vereist	list De module-uitvoer.
param_defs	list De parameterdefinities van de module. Default value: None
create_sequencing_ports	bool Geeft aan of er sequentiërende poorten worden gemaakt voor de module. Default value: True
version	str De versie van de module. Default value: None
is_default	bool Hiermee wordt aangegeven of de gepubliceerde versie de standaardversie moet zijn. Default value: False
content_path	str map Default value: None
hash_paths	list Een lijst met paden naar hash bij het controleren op wijzigingen in de inhoud van de stap. Als er geen wijzigingen zijn gedetecteerd, gebruikt de pijplijn de stapinhoud van een vorige uitvoering opnieuw. Standaard wordt de inhoud van de `source_directory` gehasht (met uitzondering van bestanden die worden vermeld in .amlignore of .gitignore). AFGESCHAFT: niet meer nodig. Default value: None
category	str De categorie van de moduleversie Default value: None
arguments	list Argumenten die moeten worden gebruikt bij het aanroepen van de module. Argumenten kunnen tekenreeksen, invoerverwijzingen (InputPortDef), uitvoerverwijzingen (OutputPortDef) en pijplijnparameters (PipelineParameter) zijn. Default value: None
runconfig	RunConfiguration Een optionele RunConfiguration. Een RunConfiguration kan worden gebruikt om aanvullende vereisten voor de uitvoering op te geven, zoals conda-afhankelijkheden en een Docker-installatiekopieën. Default value: None

Retouren

Type	Description
ModuleVersion

Uitzonderingen

Type	Description
Exception

publish_adla_script

Maak een ModuleVersion op basis van Azure Data Lake Analytics (ADLA) en voeg deze toe aan de huidige module.

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)

Parameters

Name	Description
script_name Vereist	str De naam van een ADLA-script, ten opzichte `source_directory`van .
description Vereist	str De beschrijving van de moduleversie.
inputs Vereist	list De module-invoerbindingen.
outputs Vereist	list De uitvoerbindingen van de module.
params	dict De ModuleVersion-parameters, als naam-default_value paren. Default value: None
create_sequencing_ports	bool Geeft aan of er sequentiërende poorten worden gemaakt voor de module. Default value: True
degree_of_parallelism	int De mate van parallelle uitvoering die voor deze taak moet worden gebruikt. Default value: None
priority	int De prioriteitswaarde die moet worden gebruikt voor de huidige taak. Default value: None
runtime_version	str De runtimeversie van de ADLA-engine (Azure Data Lake Analytics). Default value: None
compute_target	AdlaCompute, str De ADLA-berekening die voor deze taak moet worden gebruikt. Default value: None
version	str De versie van de module. Default value: None
is_default	bool Hiermee wordt aangegeven of de gepubliceerde versie de standaardversie moet zijn. Default value: False
source_directory	str map Default value: None
hash_paths	list hash_paths Default value: None
category	str De categorie van de moduleversie Default value: None
arguments	list Argumenten die moeten worden gebruikt bij het aanroepen van de module. Argumenten kunnen tekenreeksen, invoerverwijzingen (InputPortDef), uitvoerverwijzingen (OutputPortDef) en pijplijnparameters (PipelineParameter) zijn. Default value: None

Retouren

Type	Description
ModuleVersion

publish_azure_batch

Maak een ModuleVersion die gebruikmaakt van Azure Batch en voeg deze toe aan de huidige module.

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)

Parameters

Name	Description
description Vereist	str De beschrijving van de moduleversie.
compute_target Vereist	BatchCompute of str Het batchcompute-rekendoel.
inputs Vereist	list De module-invoerbindingen.
outputs Vereist	list De uitvoerbindingen van de module.
params	dict De ModuleVersion-parameters, als naam-default_value paren. Default value: None
create_sequencing_ports	bool Geeft aan of er sequentiërende poorten worden gemaakt voor de module. Default value: True
version	str De versie van de module. Default value: None
is_default	bool Hiermee wordt aangegeven of de gepubliceerde versie de standaardversie moet zijn. Default value: False
create_pool	bool Geeft aan of de pool moet worden gemaakt voordat de taken worden uitgevoerd. Default value: False
pool_id	str (Verplicht) De id van de pool waar de taak wordt uitgevoerd. Default value: None
delete_batch_job_after_finish	bool Geeft aan of de taak uit het Batch-account moet worden verwijderd nadat deze is voltooid. Default value: False
delete_batch_pool_after_finish	bool Geeft aan of de pool moet worden verwijderd nadat de taak is voltooid. Default value: False
is_positive_exit_code_failure	bool Geeft aan of de taak mislukt als de taak bestaat met een positieve code. Default value: True
vm_image_urn	str Als `create_pool` True is en de VM VirtualMachineConfiguration gebruikt, geeft deze parameter aan welke VM-installatiekopieën moeten worden gebruikt. Waarde-indeling: `urn:publisher:offer:sku`. Bijvoorbeeld: `urn:MicrosoftWindowsServer:WindowsServer:2012-R2-Datacenter`. Default value: urn:MicrosoftWindowsServer:WindowsServer:2012-R2-Datacenter
run_task_as_admin	bool Geeft aan of de taak moet worden uitgevoerd met Beheer bevoegdheden. Default value: False
target_compute_nodes	int Als `create_pool` Waar is, wordt aangegeven hoeveel rekenknooppunten aan de pool worden toegevoegd. Default value: 1
vm_size	str Als `create_pool` true is, geeft de grootte van de virtuele machine van de rekenknooppunten aan. Default value: standard_d1_v2
executable	str De naam van de opdracht/het uitvoerbare bestand dat wordt uitgevoerd als onderdeel van de taak. Default value: None
source_directory	str De bronmap. Default value: None
category	str De categorie van de moduleversie Default value: None
arguments	list Argumenten die moeten worden gebruikt bij het aanroepen van de module. Argumenten kunnen tekenreeksen, invoerverwijzingen (InputPortDef), uitvoerverwijzingen (OutputPortDef) en pijplijnparameters (PipelineParameter) zijn. Default value: None

Retouren

Type	Description
ModuleVersion

Uitzonderingen

Type	Description
ValueError

publish_python_script

Maak een ModuleVersion die is gebaseerd op een Python-script en voeg deze toe aan de huidige module.

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)

Parameters

Name	Description
script_name Vereist	str De naam van een Python-script, ten opzichte `source_directory`van .
description Vereist	str De beschrijving van de moduleversie.
inputs Vereist	list De module-invoerbindingen.
outputs Vereist	list De uitvoerbindingen van de module.
params	dict De ModuleVersion-parameters, als naam-default_value paren. Default value: None
create_sequencing_ports	bool Geeft aan of er sequentiërende poorten worden gemaakt voor de module. Default value: True
version	str De versie van de module. Default value: None
is_default	bool Hiermee wordt aangegeven of de gepubliceerde versie de standaardversie moet zijn. Default value: False
source_directory	str map Default value: None
hash_paths	list Een lijst met paden naar hash bij het controleren op wijzigingen in de inhoud van de stap. Als er geen wijzigingen zijn gedetecteerd, gebruikt de pijplijn de stapinhoud van een vorige uitvoering opnieuw. Standaard wordt de inhoud van de `source_directory` gehasht (met uitzondering van bestanden die worden vermeld in .amlignore of .gitignore). AFGESCHAFT: niet meer nodig. Default value: None
category	str De categorie van de moduleversie Default value: None
arguments	list Argumenten die moeten worden gebruikt bij het aanroepen van de module. Argumenten kunnen tekenreeksen, invoerverwijzingen (InputPortDef), uitvoerverwijzingen (OutputPortDef) en pijplijnparameters (PipelineParameter) zijn. Default value: None
runconfig	RunConfiguration Een optionele RunConfiguration. Een RunConfiguration kan worden gebruikt om aanvullende vereisten voor de uitvoering op te geven, zoals conda-afhankelijkheden en een Docker-installatiekopieën. Default value: None

Retouren

Type	Description
ModuleVersion

resolve

Los het probleem op en retourneer de juiste ModuleVersion.

resolve(version=None)

Parameters

Name	Description
version	Default value: None

Retouren

Type	Description
ModuleVersion	De moduleversie die moet worden gebruikt.

set_default_version

Stel de standaardModuleVersie van de module in.

set_default_version(version_id)

Parameters

Name	Description
version_id Vereist

Retouren

Type	Description
str	De standaardversie.

Uitzonderingen

Type	Description
Exception

set_description

Stel de beschrijving van module in.

set_description(description)

Parameters

Name	Description
description Vereist	str De beschrijving die moet worden ingesteld.

Uitzonderingen

Type	Description
Exception

set_name

Stel de naam van de module in.

set_name(name)

Parameters

Name	Description
name Vereist	str De naam die moet worden ingesteld.

Uitzonderingen

Type	Description
Exception

Kenmerken

default_version

Haal de standaardversie van de module op.

Retouren

Type	Description
str	De standaardversietekenreeks.

description

Haal de beschrijving van de module op.

Retouren

Type	Description
str	De beschrijvingstekenreeks.

id

Haal de id van de module op.

Retouren

Type	Description
str	De id.

name

Haal de naam van de module op.

Retouren

Type	Description
str	De naam.

status

Haal de status van de module op.

Retouren

Type	Description
str	De status.

Delen via

Module Klas

Constructor

Parameters

Opmerkingen

Methoden

create

Parameters

Retouren

deprecate

disable

enable

get

Parameters

Retouren

get_default

Retouren

get_default_version

Retouren

get_versions

Parameters

Retouren

module_def_builder

Parameters

Retouren

Uitzonderingen

module_version_list

Retouren

process_source_directory

Parameters

Retouren

Uitzonderingen

publish

Parameters

Retouren

Uitzonderingen

publish_adla_script

Parameters

Retouren

publish_azure_batch

Parameters

Retouren

Uitzonderingen

publish_python_script

Parameters

Retouren

resolve

Parameters

Retouren

set_default_version

Parameters

Retouren

Uitzonderingen

set_description

Parameters

Uitzonderingen

set_name

Parameters

Uitzonderingen

Kenmerken

default_version

Retouren

description

Retouren

id

Retouren

name

Retouren

status

Retouren

Feedback

Aanvullende resources