SweepJob Klas

  • Referentie

Sweep-taak voor het afstemmen van hyperparameters.

Overname
azure.ai.ml.entities._job.job.Job
SweepJob
azure.ai.ml.entities._job.sweep.parameterized_sweep.ParameterizedSweep
SweepJob
azure.ai.ml.entities._job.job_io_mixin.JobIOMixin
SweepJob

Constructor

SweepJob(*, name: str | None = None, description: str | None = None, tags: Dict | None = None, display_name: str | None = None, experiment_name: str | None = None, identity: ManagedIdentityConfiguration | AmlTokenConfiguration | UserIdentityConfiguration | None = None, inputs: Dict[str, int | str | float | bool | Input] | None = None, outputs: Dict[str, Output] | None = None, compute: str | None = None, limits: SweepJobLimits | None = None, sampling_algorithm: str | SamplingAlgorithm | None = None, search_space: Dict[str, Choice | LogNormal | LogUniform | Normal | QLogNormal | QLogUniform | QNormal | QUniform | Randint | Uniform] | None = None, objective: Objective | None = None, trial: CommandJob | CommandComponent | None = None, early_termination: BanditPolicy | MedianStoppingPolicy | TruncationSelectionPolicy | None = None, queue_settings: QueueSettings | None = None, **kwargs: Any)

Parameters

name
str

Naam van de taak.

display_name
str

Weergavenaam van de taak.

description
str

Beschrijving van de taak.

tags
dict[str, str]

Tagwoordenlijst. Tags kunnen worden toegevoegd, verwijderd en bijgewerkt.

properties
dict[str, str]

De woordenlijst met eigenschappen van activa.

experiment_name
str

Naam van het experiment waaronder de taak wordt gemaakt. Als Geen is opgegeven, wordt de taak gemaakt onder het experiment 'Standaard'.

identity
Union[ManagedIdentityConfiguration, AmlTokenConfiguration, UserIdentityConfiguration]

De identiteit die door de trainingstaak wordt gebruikt tijdens het uitvoeren van berekeningen.

inputs
dict

Voert in op de opdracht.

outputs
dict[str, Output]

Toewijzing van uitvoergegevensbindingen die in de taak worden gebruikt.

sampling_algorithm
str

Het algoritme voor hyperparametersampling dat moet worden gebruikt voor de search_space. Standaard ingesteld op 'willekeurig'.

search_space
Dict

Woordenlijst van de zoekruimte hyperparameter. De sleutel is de naam van de hyperparameter en de waarde is de parameterexpressie.

objective
Objective

Metrische waarde om voor te optimaliseren.

compute
str

Het rekendoel waarop de taak wordt uitgevoerd.

trial
Union[CommandJob, CommandComponent]

De taakconfiguratie voor elke proefversie. Elke proef wordt voorzien van een andere combinatie van hyperparameterwaarden die de systeemmonsters van de search_space.

early_termination
Union[BanditPolicy, MedianStoppingPolicy, TruncationSelectionPolicy]

Het beleid voor vroegtijdige beëindiging dat moet worden gebruikt. Een proeftaak wordt geannuleerd wanneer aan de criteria van het opgegeven beleid wordt voldaan. Als u dit weglaat, wordt er geen beleid voor vroegtijdige beëindiging toegepast.

limits
<xref:azure.ai.ml.entities.SweepJobLimits>

Limieten voor de sweep-taak.

queue_settings
QueueSettings

Wachtrijinstellingen voor de taak.

kwargs
dict

Een woordenlijst met aanvullende configuratieparameters.

Voorbeelden

Een sweepjob maken


   from azure.ai.ml.entities import CommandJob
   from azure.ai.ml.sweep import BayesianSamplingAlgorithm, Objective, SweepJob, SweepJobLimits

   command_job = CommandJob(
       inputs=dict(kernel="linear", penalty=1.0),
       compute=cpu_cluster,
       environment=f"{job_env.name}:{job_env.version}",
       code="./scripts",
       command="python scripts/train.py --kernel $kernel --penalty $penalty",
       experiment_name="sklearn-iris-flowers",
   )

   sweep = SweepJob(
       sampling_algorithm=BayesianSamplingAlgorithm(),
       trial=command_job,
       search_space={"ss": Choice(type="choice", values=[{"space1": True}, {"space2": True}])},
       inputs={"input1": {"file": "top_level.csv", "mode": "ro_mount"}},
       compute="top_level",
       limits=SweepJobLimits(trial_timeout=600),
       objective=Objective(goal="maximize", primary_metric="accuracy"),
   )

Methoden

dump

Dumpt de taakinhoud in een bestand in YAML-indeling.
set_limits

Stel limieten in voor het knooppunt Opruimen. Laat parameters op Geen staan als u de bijbehorende waarden niet wilt bijwerken.
set_objective

Stel het sweep-object in. Laat parameters op Geen staan als u de bijbehorende waarden niet wilt bijwerken.

"minimaliseren", "maximaliseren". :type doel: str :trefwoord primary_metric: naam van de te optimaliseren metrische waarde. :p aramtype primary_metric: str

dump

Dumpt de taakinhoud in een bestand in YAML-indeling.

dump(dest: str | PathLike | IO, **kwargs) -> None

Parameters

dest
Union[<xref:PathLike>, str, IO[AnyStr]]
Vereist

Het lokale pad of de bestandsstroom waar de YAML-inhoud naar moet worden geschreven. Als dest een bestandspad is, wordt er een nieuw bestand gemaakt. Als dest een geopend bestand is, wordt het bestand rechtstreeks naar geschreven.

kwargs
dict

Aanvullende argumenten die moeten worden doorgegeven aan de YAML-serializer.

Uitzonderingen

FileExistsError

Gegenereerd als dest een bestandspad is en het bestand al bestaat.

IOError

Gegenereerd als dest een geopend bestand is en het bestand niet beschrijfbaar is.

set_limits

Stel limieten in voor het knooppunt Opruimen. Laat parameters op Geen staan als u de bijbehorende waarden niet wilt bijwerken.

set_limits(*, max_concurrent_trials: int | None = None, max_total_trials: int | None = None, timeout: int | None = None, trial_timeout: int | None = None) -> None

Parameters

max_concurrent_trials
int

maximum aantal gelijktijdige proefversies.

max_total_trials
int

maximum totaal aantal proefabonnementen.

timeout
int

totale time-out in seconden voor sweep-knooppunt

trial_timeout
int

time-out in seconden voor elke proefversie

Uitzonderingen

FileExistsError

Gegenereerd als dest een bestandspad is en het bestand al bestaat.

IOError

Gegenereerd als dest een geopend bestand is en het bestand niet beschrijfbaar is.

set_objective

Stel het sweep-object in. Laat parameters op Geen staan als u de bijbehorende waarden niet wilt bijwerken.

"minimaliseren", "maximaliseren". :type doel: str :trefwoord primary_metric: naam van de te optimaliseren metrische waarde. :p aramtype primary_metric: str

set_objective(*, goal: str | None = None, primary_metric: str | None = None) -> None

Parameters

goal

Definieert ondersteunde metrische doelen voor het afstemmen van hyperparameters. Acceptabele waarden zijn:

Uitzonderingen

FileExistsError

Gegenereerd als dest een bestandspad is en het bestand al bestaat.

IOError

Gegenereerd als dest een geopend bestand is en het bestand niet beschrijfbaar is.

Kenmerken

base_path

Het basispad van de resource.

Retouren

Het basispad van de resource.

Retourtype

str

creation_context

De context voor het maken van de resource.

Retouren

De metagegevens voor het maken van de resource.

Retourtype

Optional[SystemData]

early_termination

Beleid voor vroegtijdige beëindiging voor opruimen.

Retouren

Beleid voor vroegtijdige beëindiging voor opruimen.

Retourtype

<xref:azure.ai.ml.entities._job.sweep.early_termination_policy.EarlyTerminationPolicy>

id

De resource-id.

Retouren

De globale id van de resource, een ARM-id (Azure Resource Manager).

Retourtype

Optional[str]

inputs

limits

Limieten voor sweep-taak.

Retouren

Limieten voor sweep-taak.

Retourtype

SweepJobLimits

log_files

Taakuitvoerbestanden.

Retouren

De woordenlijst met logboeknamen en URL's.

Retourtype

Optional[Dict[str, str]]

outputs

sampling_algorithm

Sampling-algoritme voor sweep-taak.

Retouren

Sampling-algoritme voor sweep-taak.

Retourtype

SamplingAlgorithm

status

De status van de taak.

Veelvoorkomende geretourneerde waarden zijn 'Wordt uitgevoerd', 'Voltooid' en 'Mislukt'. Alle mogelijke waarden zijn:

  • NotStarted: dit is een tijdelijke status waarin Run-objecten aan de clientzijde zich bevinden voordat ze in de cloud worden verzonden.

  • Starten: de uitvoering wordt verwerkt in de cloud. De aanroeper heeft op dit moment een uitvoerings-id.

  • Inrichten: er wordt rekenproces op aanvraag gemaakt voor een bepaalde taakverzending.

  • Voorbereiden: de uitvoeringsomgeving wordt voorbereid en bevindt zich in een van de volgende twee fasen:

    • Build van Docker-installatiekopieën

    • conda-omgeving instellen

  • In wachtrij: de taak wordt in de wachtrij geplaatst op het rekendoel. In BatchAI bevindt de taak zich bijvoorbeeld in een wachtrijstatus

    terwijl u wacht tot alle aangevraagde knooppunten gereed zijn.

  • Uitvoeren: de taak wordt uitgevoerd op het rekendoel.

  • Voltooien: de uitvoering van de gebruikerscode is voltooid en de uitvoering bevindt zich in de naverwerkingsfasen.

  • CancelRequested: annulering is aangevraagd voor de taak.

  • Voltooid: de uitvoering is voltooid. Dit omvat zowel de uitvoering van de gebruikerscode als de uitvoering

    naverwerkingsfasen.

  • Mislukt: de uitvoering is mislukt. Meestal geeft de eigenschap Error bij een uitvoering details over de reden.

  • Geannuleerd: volgt een annuleringsaanvraag en geeft aan dat de uitvoering nu is geannuleerd.

  • Reageert niet: voor uitvoeringen waarvoor Heartbeats is ingeschakeld, is er onlangs geen heartbeat verzonden.

Retouren

Status van de taak.

Retourtype

Optional[str]

studio_url

Azure ML Studio-eindpunt.

Retouren

De URL naar de pagina met taakgegevens.

Retourtype

Optional[str]

type

Het type taak.

Retouren

Het type taak.

Retourtype

Optional[str]