AutoMLRun Klas

Vertegenwoordigt een geautomatiseerd ML-experiment dat wordt uitgevoerd in Azure Machine Learning.

De autoMLRun-klasse kan worden gebruikt om een uitvoering te beheren, de uitvoeringsstatus te controleren en uitvoeringsdetails op te halen zodra een AutoML-uitvoering is verzonden. Zie de klasse voor meer informatie over het Run werken met experimentuitvoeringen.

Initialiseer een AutoML-uitvoering.

Overname

Run

AutoMLRun

Constructor

AutoMLRun(experiment, run_id, **kwargs)

Parameters

Name	Description
experiment Vereist	Experiment Het experiment dat is gekoppeld aan de uitvoering.
run_id Vereist	str De id van de uitvoering.
experiment Vereist	Experiment Het experiment dat is gekoppeld aan de uitvoering.
run_id Vereist	str De id van de uitvoering.

Opmerkingen

Een AutoMLRun-object wordt geretourneerd wanneer u de submit methode van een experiment gebruikt.

Gebruik de volgende code om een uitvoering op te halen die al is gestart:

   from azureml.train.automl.run import AutoMLRun
   ws = Workspace.from_config()
   experiment = ws.experiments['my-experiment-name']
   automl_run = AutoMLRun(experiment, run_id = 'AutoML_9fe201fe-89fd-41cc-905f-2f41a5a98883')

Methoden

cancel	Een AutoML-uitvoering annuleren. Retourneer Waar als de AutoML-uitvoering is geannuleerd.
cancel_iteration	Een bepaalde onderliggende uitvoering annuleren.
complete	Voltooi een AutoML-uitvoering.
continue_experiment	Een bestaand AutoML-experiment voortzetten.
fail	Een AutoML-uitvoering mislukt. Stel eventueel de eigenschap Error van de uitvoering in met een bericht of uitzondering die is doorgegeven aan error_details.
get_best_child	Retourneer de onderliggende uitvoering met de beste score voor deze AutoML-uitvoering.
get_guardrails	Gedetailleerde resultaten van het uitvoeren van Guardrail-verificatie afdrukken en retourneren.
get_output	Retourneer de uitvoering met de bijbehorende beste pijplijn die al is getest. Als er geen invoerparameters worden opgegeven, get_output retourneert de beste pijplijn op basis van de primaire metrische waarde. U kunt ook de iteration parameter of metric gebruiken om respectievelijk een bepaalde iteratie of de beste uitvoering per opgegeven metrische waarde op te halen.
get_run_sdk_dependencies	Haal de SDK-uitvoeringsafhankelijkheden op voor een bepaalde uitvoering.
pause	Retourneer Waar als de AutoML-uitvoering is onderbroken. Deze methode is niet geïmplementeerd.
register_model	Registreer het model bij de AzureML ACI-service.
resume	Retourneer Waar als de AutoML-uitvoering is hervat. Deze methode is niet geïmplementeerd.
retry	Retourneer Waar als de AutoML-uitvoering opnieuw is geprobeerd. Deze methode is niet geïmplementeerd.
summary	Haal een tabel op met een samenvatting van de algoritmen die zijn geprobeerd en de bijbehorende scores.
wait_for_completion	Wacht totdat deze uitvoering is voltooid. Retourneert het statusobject na de wachttijd.

cancel

Een AutoML-uitvoering annuleren.

Retourneer Waar als de AutoML-uitvoering is geannuleerd.

cancel()

Retouren

Type	Description
	Geen

cancel_iteration

Een bepaalde onderliggende uitvoering annuleren.

cancel_iteration(iteration)

Parameters

Name	Description
iteration Vereist	int De herhaling die moet worden geannuleerd.

Retouren

Type	Description
	Geen

complete

Voltooi een AutoML-uitvoering.

complete(**kwargs)

Retouren

Type	Description
	Geen

continue_experiment

Een bestaand AutoML-experiment voortzetten.

continue_experiment(X=None, y=None, sample_weight=None, X_valid=None, y_valid=None, sample_weight_valid=None, data=None, label=None, columns=None, cv_splits_indices=None, spark_context=None, experiment_timeout_hours=None, experiment_exit_score=None, iterations=None, show_output=False, training_data=None, validation_data=None, **kwargs)

Parameters

Name	Description
X	DataFrame of ndarray of <xref:azureml.dataprep.Dataflow> Trainingsfuncties. Default value: None
y	DataFrame of ndarray of <xref:azureml.dataprep.Dataflow> Trainingslabels. Default value: None
sample_weight	DataFrame of ndarray of <xref:azureml.dataprep.Dataflow> Voorbeeldgewichten voor trainingsgegevens. Default value: None
X_valid	DataFrame of ndarray of <xref:azureml.dataprep.Dataflow> Validatiefuncties. Default value: None
y_valid	DataFrame of ndarray of <xref:azureml.dataprep.Dataflow> Validatielabels. Default value: None
sample_weight_valid	DataFrame of ndarray of <xref:azureml.dataprep.Dataflow> voorbeeldgewichten van validatieset. Default value: None
data	DataFrame Trainingsfuncties en -labels. Default value: None
label	str Kolom in gegevens labelen. Default value: None
columns	list(str) Een lijst met toegestane kolommen in de gegevens die als functies moeten worden gebruikt. Default value: None
cv_splits_indices	ndarray Indexen waar trainingsgegevens moeten worden gesplitst voor kruisvalidatie. Elke rij is een afzonderlijke kruisvouw en geef binnen elke kruismap twee matrices op, de eerste met de indexen voor voorbeelden die moeten worden gebruikt voor trainingsgegevens en de tweede met de indexen die moeten worden gebruikt voor validatiegegevens. bijvoorbeeld [[t1, v1], [t2, v2], ...] waarbij t1 de trainingsindexen voor de eerste kruisvouw is en v1 de validatie-indexen voor de eerste kruisvouw is. Default value: None
spark_context	<xref:SparkContext> Spark-context, alleen van toepassing wanneer deze wordt gebruikt in een Azure Databricks-/Spark-omgeving. Default value: None
experiment_timeout_hours	float Hoeveel extra uren moet dit experiment worden uitgevoerd. Default value: None
experiment_exit_score	int Indien opgegeven geeft aan dat het experiment wordt beëindigd wanneer deze waarde is bereikt. Default value: None
iterations	int Hoeveel extra iteraties moeten worden uitgevoerd voor dit experiment. Default value: None
show_output	bool Vlag die aangeeft of uitvoer naar de console moet worden afgedrukt. Default value: False
training_data	<xref:azureml.dataprep.Dataflow> of DataFrame Trainingsgegevens invoeren. Default value: None
validation_data	<xref:azureml.dataprep.Dataflow> of DataFrame Validatiegegevens. Default value: None

Retouren

Type	Description
AutoMLRun	De bovenliggende AutoML-uitvoering.

Uitzonderingen

Type	Description
ConfigException
InvalidRunState

fail

Een AutoML-uitvoering mislukt.

Stel eventueel de eigenschap Error van de uitvoering in met een bericht of uitzondering die is doorgegeven aan error_details.

fail(error_details=None, error_code=None, _set_status=True, **kwargs)

Parameters

Name	Description
error_details	str of BaseException Optionele details van de fout. Default value: None
error_code	str Optionele foutcode van de fout voor de foutclassificatie. Default value: None
_set_status	bool Hiermee wordt aangegeven of de status-gebeurtenis voor het bijhouden moet worden verzonden. Default value: True

get_best_child

Retourneer de onderliggende uitvoering met de beste score voor deze AutoML-uitvoering.

get_best_child(metric: str | None = None, onnx_compatible: bool = False, **kwargs: Any) -> Run

Parameters

Name	Description
metric	str De metrische waarde die moet worden gebruikt bij het selecteren van de beste uitvoering die u wilt retourneren. Standaard ingesteld op het primaire metrische gegeven. Default value: None
onnx_compatible	Hiermee wordt aangegeven of alleen uitvoeringen worden geretourneerd die onnx-modellen hebben gegenereerd. Default value: False
kwargs Vereist

Retouren

Type	Description
	Onderliggende autoML-uitvoering.

get_guardrails

Gedetailleerde resultaten van het uitvoeren van Guardrail-verificatie afdrukken en retourneren.

get_guardrails(to_console: bool = True) -> Dict[str, Any]

Parameters

Name	Description
to_console	bool Geeft aan of de verificatieresultaten naar de console moeten worden geschreven. Default value: True

Retouren

Type	Description
dict	Een woordenlijst met controleresultaten.

Uitzonderingen

Type	Description
UserErrorException

get_output

Retourneer de uitvoering met de bijbehorende beste pijplijn die al is getest.

Als er geen invoerparameters worden opgegeven, get_output retourneert de beste pijplijn op basis van de primaire metrische waarde. U kunt ook de iteration parameter of metric gebruiken om respectievelijk een bepaalde iteratie of de beste uitvoering per opgegeven metrische waarde op te halen.

get_output(iteration: int | None = None, metric: str | None = None, return_onnx_model: bool = False, return_split_onnx_model: SplitOnnxModelName | None = None, **kwargs: Any) -> Tuple[Run, Any]

Parameters

Name	Description
iteration	int Het iteratienummer van de bijbehorende uitvoering en het aangepaste model dat moet worden geretourneerd. Default value: None
metric	str De metrische waarde die moet worden gebruikt bij het selecteren van de beste uitvoering en het aangepaste model dat moet worden geretourneerd. Default value: None
return_onnx_model	bool Deze methode retourneert het geconverteerde ONNX-model als de enable_onnx_compatible_models parameter is ingesteld op True in het AutoMLConfig -object. Default value: False
return_split_onnx_model	SplitOnnxModelName Het type van het gesplitste onnx-model dat moet worden geretourneerd Default value: None

Retouren

Type	Description
Run, <xref:Model>	De uitvoering, het bijbehorende aangepaste model.

Uitzonderingen

Type	Description
ConfigException
OnnxConvertException
NotFoundException

Opmerkingen

Als u de gebruikte preprocessor(s) en het algoritme (estimator) wilt inspecteren, kunt u dit doen via Model.steps, vergelijkbaar met sklearn.pipeline.Pipeline.steps. De onderstaande code laat bijvoorbeeld zien hoe u de estimator ophaalt.

   best_run, model = parent_run.get_output()
   estimator = model.steps[-1]

get_run_sdk_dependencies

Haal de SDK-uitvoeringsafhankelijkheden op voor een bepaalde uitvoering.

get_run_sdk_dependencies(iteration=None, check_versions=True, **kwargs)

Parameters

Name	Description
iteration	int Het iteratienummer van de aangepaste uitvoering die moet worden opgehaald. Als dit geen is, haalt u de bovenliggende omgeving op. Default value: None
check_versions	bool Indien waar, controleert u de versies met de huidige omgeving. Als onwaar is, geeft u door. Default value: True

Retouren

Type	Description
dict	De woordenlijst met afhankelijkheden die zijn opgehaald uit RunHistory.

Uitzonderingen

Type	Description
ConfigException

pause

Retourneer Waar als de AutoML-uitvoering is onderbroken.

Deze methode is niet geïmplementeerd.

pause()

Uitzonderingen

Type	Description
NotImplementedError

register_model

Registreer het model bij de AzureML ACI-service.

register_model(model_name=None, description=None, tags=None, iteration=None, metric=None)

Parameters

Name	Description
model_name	str De naam van het model dat wordt geïmplementeerd. Default value: None
description	str De beschrijving van het model dat wordt geïmplementeerd. Default value: None
tags	dict Tags voor het model dat wordt geïmplementeerd. Default value: None
iteration	int Overschrijven voor welk model moet worden geïmplementeerd. Hiermee wordt het model voor een bepaalde iteratie geïmplementeerd. Default value: None
metric	str Overschrijven voor welk model moet worden geïmplementeerd. Hiermee implementeert u het beste model voor een andere metrische waarde. Default value: None

Retouren

Type	Description
<xref:Model>	Het geregistreerde modelobject.

resume

Retourneer Waar als de AutoML-uitvoering is hervat.

Deze methode is niet geïmplementeerd.

resume()

Uitzonderingen

Type	Description
NotImplementedError:

retry

Retourneer Waar als de AutoML-uitvoering opnieuw is geprobeerd.

Deze methode is niet geïmplementeerd.

retry()

Uitzonderingen

Type	Description
NotImplementedError

summary

Haal een tabel op met een samenvatting van de algoritmen die zijn geprobeerd en de bijbehorende scores.

summary()

Retouren

Type	Description
DataFrame	Pandas DataFrame met AutoML-modelstatistieken.

wait_for_completion

Wacht totdat deze uitvoering is voltooid.

Retourneert het statusobject na de wachttijd.

wait_for_completion(show_output=False, wait_post_processing=False)

Parameters

Name	Description
show_output	bool Geeft aan of de uitvoer van de uitvoering op sys.stdout moet worden weergegeven. Default value: False
wait_post_processing	bool Geeft aan of moet worden gewacht tot de naverwerking is voltooid nadat de uitvoering is voltooid. Default value: False

Retouren

Type	Description
dict	Het statusobject.

Uitzonderingen

Type	Description
ExperimentExecutionException

Kenmerken

run_id

Retourneer de uitvoerings-id van de huidige uitvoering.

Retouren

Type	Description
str	De uitvoerings-id van de huidige uitvoering.