AutoMLRun Klass

  • Referens

Representerar ett automatiserat ML-experiment som körs i Azure Machine Learning.

Klassen AutoMLRun kan användas för att hantera en körning, kontrollera körningsstatus och hämta körningsinformation när en AutoML-körning har skickats. Mer information om hur du arbetar med experimentkörningar finns i Run klassen .

Initiera en AutoML-körning.

Arv
Run
AutoMLRun

Konstruktor

AutoMLRun(experiment, run_id, **kwargs)

Parametrar

Name Description
experiment
Obligatorisk
Experiment

Experimentet som är associerat med körningen.
run_id
Obligatorisk
str

Körningens ID.
experiment
Obligatorisk
Experiment

Experimentet som är associerat med körningen.
run_id
Obligatorisk
str

Körningens ID.

Kommentarer

Ett AutoMLRun-objekt returneras när du använder metoden för submit ett experiment.

Om du vill hämta en körning som redan har startat använder du följande kod:


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

Metoder

cancel

Avbryt en AutoML-körning.

Returnera Sant om AutoML-körningen avbröts.
cancel_iteration

Avbryt en viss underordnad körning.
complete

Slutför en AutoML-körning.
continue_experiment

Fortsätt med ett befintligt AutoML-experiment.
fail

Misslyckas med en AutoML-körning.

Du kan också ange egenskapen Fel för körningen med ett meddelande eller undantag som skickas till error_details.
get_best_child

Returnera den underordnade körningen med det bästa resultatet för den här AutoML-körningen.
get_guardrails

Skriv ut och returnera detaljerade resultat från körning av Guardrail-verifiering.
get_output

Returnera körningen med motsvarande bästa pipeline som redan har testats.

Om inga indataparametrar anges get_output returnerar den bästa pipelinen enligt det primära måttet. Du kan också använda parametern iteration eller metric för att hämta en viss iteration eller den bästa körningen per angivet mått.
get_run_sdk_dependencies

Hämta SDK-körningsberoenden för en viss körning.
pause

Returnera Sant om AutoML-körningen har pausats.

Den här metoden implementeras inte.
register_model

Registrera modellen med AzureML ACI-tjänsten.
resume

Returnera Sant om AutoML-körningen har återupptagits.

Den här metoden har inte implementerats.
retry

Returnera Sant om AutoML-körningen har gjorts om.

Den här metoden har inte implementerats.
summary

Hämta en tabell som innehåller en sammanfattning av algoritmförsök och deras poäng.
wait_for_completion

Vänta tills körningen har slutförts.

Returnerar statusobjektet efter väntetiden.

cancel

Avbryt en AutoML-körning.

Returnera Sant om AutoML-körningen avbröts.

cancel()

Returer

Typ Description

Ingen

cancel_iteration

Avbryt en viss underordnad körning.

cancel_iteration(iteration)

Parametrar

Name Description
iteration
Obligatorisk
int

Iterationen som ska avbrytas.

Returer

Typ Description

Ingen

complete

Slutför en AutoML-körning.

complete(**kwargs)

Returer

Typ Description

Ingen

continue_experiment

Fortsätt med ett befintligt AutoML-experiment.

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)

Parametrar

Name Description
X
DataFrame eller ndarray eller <xref:azureml.dataprep.Dataflow>

Träningsfunktioner.

Standardvärde: None
y
DataFrame eller ndarray eller <xref:azureml.dataprep.Dataflow>

Träningsetiketter.

Standardvärde: None
sample_weight
DataFrame eller ndarray eller <xref:azureml.dataprep.Dataflow>

Exempelvikter för träningsdata.

Standardvärde: None
X_valid
DataFrame eller ndarray eller <xref:azureml.dataprep.Dataflow>

Valideringsfunktioner.

Standardvärde: None
y_valid
DataFrame eller ndarray eller <xref:azureml.dataprep.Dataflow>

Verifieringsetiketter.

Standardvärde: None
sample_weight_valid
DataFrame eller ndarray eller <xref:azureml.dataprep.Dataflow>

valideringsuppsättningens exempelvikter.

Standardvärde: None
data
DataFrame

Träningsfunktioner och etikett.

Standardvärde: None
label
str

Etikettkolumn i data.

Standardvärde: None
columns
list(str)

En lista över tillåtna kolumner i data som ska användas som funktioner.

Standardvärde: None
cv_splits_indices
ndarray

Index där träningsdata ska delas upp för korsvalidering. Varje rad är en separat korsvikt och inom varje korsmapp ger du 2 matriser, den första med indexen för exempel som ska användas för träningsdata och den andra med indexen som ska användas för valideringsdata. dvs [[t1, v1], [t2, v2], ...] där t1 är träningsindexen för den första korsvikten och v1 är valideringsindexen för den första korsvikten.

Standardvärde: None
spark_context
<xref:SparkContext>

Spark-kontext, gäller endast när den används i azure databricks/spark-miljön.

Standardvärde: None
experiment_timeout_hours
float

Hur många ytterligare timmar du ska köra experimentet för.

Standardvärde: None
experiment_exit_score
int

Om det anges anges att experimentet avslutas när det här värdet nås.

Standardvärde: None
iterations
int

Hur många ytterligare iterationer som ska köras för det här experimentet.

Standardvärde: None
show_output
bool

Flagga som anger om utdata ska skrivas ut till konsolen.

Standardvärde: False
training_data
<xref:azureml.dataprep.Dataflow> eller DataFrame

Mata in träningsdata.

Standardvärde: None
validation_data
<xref:azureml.dataprep.Dataflow> eller DataFrame

Valideringsdata.

Standardvärde: None

Returer

Typ Description
AutoMLRun

Den överordnade AutoML-körningen.

Undantag

Typ Description
ConfigException
InvalidRunState

fail

Misslyckas med en AutoML-körning.

Du kan också ange egenskapen Fel för körningen med ett meddelande eller undantag som skickas till error_details.

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

Parametrar

Name Description
error_details
str eller BaseException

Valfri information om felet.

Standardvärde: None
error_code
str

Valfri felkod för felet för felklassificeringen.

Standardvärde: None
_set_status
bool

Anger om statushändelsen ska skickas för spårning.

Standardvärde: True

get_best_child

Returnera den underordnade körningen med det bästa resultatet för den här AutoML-körningen.

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

Parametrar

Name Description
metric
str

Måttet som ska användas för när du väljer den bästa körningen som ska returneras. Standardvärdet är det primära måttet.

Standardvärde: None
onnx_compatible

Om du bara vill returnera körningar som genererade onnx-modeller.

Standardvärde: False
kwargs
Obligatorisk

Returer

Typ Description

AutoML Underordnad körning.

get_guardrails

Skriv ut och returnera detaljerade resultat från körning av Guardrail-verifiering.

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

Parametrar

Name Description
to_console
bool

Anger om verifieringsresultatet ska skrivas till konsolen.

Standardvärde: True

Returer

Typ Description
dict

En ordlista med verifierarresultat.

Undantag

Typ Description
UserErrorException

get_output

Returnera körningen med motsvarande bästa pipeline som redan har testats.

Om inga indataparametrar anges get_output returnerar den bästa pipelinen enligt det primära måttet. Du kan också använda parametern iteration eller metric för att hämta en viss iteration eller den bästa körningen per angivet mått.

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]

Parametrar

Name Description
iteration
int

Iterationsnumret för motsvarande körning och monterade modell som ska returneras.

Standardvärde: None
metric
str

Måttet som ska användas för när du väljer den bästa körningen och den anpassade modellen som ska returneras.

Standardvärde: None
return_onnx_model
bool

Den här metoden returnerar den konverterade ONNX-modellen om parametern enable_onnx_compatible_models har angetts till True i AutoMLConfig objektet.

Standardvärde: False
return_split_onnx_model
SplitOnnxModelName

Typen av split onnx-modell som ska returneras

Standardvärde: None

Returer

Typ Description
Run, <xref:Model>

Körningen, motsvarande monterad modell.

Undantag

Typ Description
ConfigException
OnnxConvertException
NotFoundException

Kommentarer

Om du vill inspektera de förprocessorer och algoritmer (estimator) som används kan du göra det via Model.steps, ungefär som sklearn.pipeline.Pipeline.steps. Koden nedan visar till exempel hur du hämtar uppskattningen.


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

get_run_sdk_dependencies

Hämta SDK-körningsberoenden för en viss körning.

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

Parametrar

Name Description
iteration
int

Iterationsnumret för den monterade körningen som ska hämtas. Om ingen hämtar du den överordnade miljön.

Standardvärde: None
check_versions
bool

Om sant kontrollerar du versionerna med den aktuella miljön. Om falskt, skicka.

Standardvärde: True

Returer

Typ Description
dict

Ordlistan med beroenden som hämtats från RunHistory.

Undantag

Typ Description
ConfigException

pause

Returnera Sant om AutoML-körningen har pausats.

Den här metoden implementeras inte.

pause()

Undantag

Typ Description
NotImplementedError

register_model

Registrera modellen med AzureML ACI-tjänsten.

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

Parametrar

Name Description
model_name
str

Namnet på modellen som distribueras.

Standardvärde: None
description
str

Beskrivningen för modellen som distribueras.

Standardvärde: None
tags
dict

Taggar för modellen som distribueras.

Standardvärde: None
iteration
int

Åsidosätt vilken modell som ska distribueras. Distribuerar modellen för en viss iteration.

Standardvärde: None
metric
str

Åsidosätt vilken modell som ska distribueras. Distribuerar den bästa modellen för ett annat mått.

Standardvärde: None

Returer

Typ Description
<xref:Model>

Det registrerade modellobjektet.

resume

Returnera Sant om AutoML-körningen har återupptagits.

Den här metoden har inte implementerats.

resume()

Undantag

Typ Description
NotImplementedError:

retry

Returnera Sant om AutoML-körningen har gjorts om.

Den här metoden har inte implementerats.

retry()

Undantag

Typ Description
NotImplementedError

summary

Hämta en tabell som innehåller en sammanfattning av algoritmförsök och deras poäng.

summary()

Returer

Typ Description
DataFrame

Pandas DataFrame som innehåller AutoML-modellstatistik.

wait_for_completion

Vänta tills körningen har slutförts.

Returnerar statusobjektet efter väntetiden.

wait_for_completion(show_output=False, wait_post_processing=False)

Parametrar

Name Description
show_output
bool

Anger om körningsutdata ska visas på sys.stdout.

Standardvärde: False
wait_post_processing
bool

Anger om efterbearbetningen ska slutföras efter att körningen har slutförts.

Standardvärde: False

Returer

Typ Description
dict

Statusobjektet.

Undantag

Typ Description
ExperimentExecutionException

Attribut

run_id

Returnera körnings-ID för den aktuella körningen.

Returer

Typ Description
str

Körnings-ID för den aktuella körningen.