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

experiment
Experiment
Obligatorisk

Experimentet som är associerat med körningen.

run_id
str
Obligatorisk

Körningens ID.

experiment
Experiment
Obligatorisk

Experimentet som är associerat med körningen.

run_id
str
Obligatorisk

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

Ingen

cancel_iteration

Avbryt en viss underordnad körning.

cancel_iteration(iteration)

Parametrar

iteration
int
Obligatorisk

Iterationen som ska avbrytas.

Returer

Ingen

complete

Slutför en AutoML-körning.

complete(**kwargs)

Returer

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

X
DataFrame eller ndarray eller <xref:azureml.dataprep.Dataflow>
standardvärde: None

Träningsfunktioner.

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

Träningsetiketter.

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

Exempelvikter för träningsdata.

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

Valideringsfunktioner.

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

Verifieringsetiketter.

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

valideringsuppsättningens exempelvikter.

data
DataFrame
standardvärde: None

Träningsfunktioner och etikett.

label
str
standardvärde: None

Etikettkolumn i data.

columns
list(str)
standardvärde: None

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

cv_splits_indices
ndarray
standardvärde: None

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.

spark_context
<xref:SparkContext>
standardvärde: None

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

experiment_timeout_hours
float
standardvärde: None

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

experiment_exit_score
int
standardvärde: None

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

iterations
int
standardvärde: None

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

show_output
bool
standardvärde: False

Flagga som anger om utdata ska skrivas ut till konsolen.

training_data
<xref:azureml.dataprep.Dataflow> eller DataFrame
standardvärde: None

Mata in träningsdata.

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

Valideringsdata.

Returer

Den överordnade AutoML-körningen.

Returtyp

AutoMLRun

Undantag

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

error_details
str eller BaseException
standardvärde: None

Valfri information om felet.

error_code
str
standardvärde: None

Valfri felkod för felet för felklassificeringen.

_set_status
bool
standardvärde: True

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

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

metric
str
standardvärde: None

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.

onnx_compatible
standardvärde: False

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

kwargs
Obligatorisk

Returer

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

to_console
bool
standardvärde: True

Anger om verifieringsresultatet ska skrivas till konsolen.

Returer

En ordlista med verifierarresultat.

Returtyp

dict

Undantag

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

iteration
int
standardvärde: None

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

metric
str
standardvärde: None

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.

return_onnx_model
bool
standardvärde: False

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

return_split_onnx_model
SplitOnnxModelName
standardvärde: None

Typen av split onnx-modell som ska returneras

Returer

Körningen, motsvarande monterad modell.

Returtyp

Run, <xref:Model>

Undantag

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

iteration
int
standardvärde: None

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

check_versions
bool
standardvärde: True

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

Returer

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

Returtyp

dict

Undantag

ConfigException

pause

Returnera Sant om AutoML-körningen har pausats.

Den här metoden implementeras inte.

pause()

Undantag

NotImplementedError

register_model

Registrera modellen med AzureML ACI-tjänsten.

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

Parametrar

model_name
str
standardvärde: None

Namnet på modellen som distribueras.

description
str
standardvärde: None

Beskrivningen för modellen som distribueras.

tags
dict
standardvärde: None

Taggar för modellen som distribueras.

iteration
int
standardvärde: None

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

metric
str
standardvärde: None

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

Returer

Det registrerade modellobjektet.

Returtyp

<xref:Model>

resume

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

Den här metoden har inte implementerats.

resume()

Undantag

NotImplementedError:

retry

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

Den här metoden har inte implementerats.

retry()

Undantag

NotImplementedError

summary

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

summary()

Returer

Pandas DataFrame som innehåller AutoML-modellstatistik.

Returtyp

DataFrame

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

show_output
bool
standardvärde: False

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

wait_post_processing
bool
standardvärde: False

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

Returer

Statusobjektet.

Returtyp

dict

Undantag

ExperimentExecutionException

Attribut

run_id

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

Returer

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

Returtyp

str