Share via

EarlyTerminationPolicy Class

  • Reference

Abstract base class for all early termination policies.

Initialize an early termination policy.

Inheritance
ABC
EarlyTerminationPolicy

Constructor

EarlyTerminationPolicy(name, properties=None)

Parameters

Name Description
name
Required
str

The name of the policy.
properties
dict

A JSON serializable object of properties.

Default value: None

Remarks

Early termination policies can be applied to HyperDrive runs. A run is cancelled when the criteria of a specified policy are met. Examples of policies you can use include:

Use the NoTerminationPolicy to specify that no early termination policy is to be applied for a run.

Use the policy parameter of the HyperDriveConfig class to specify a policy.

Methods

to_json

Return JSON representing the termination policy.

to_json

Return JSON representing the termination policy.

to_json()

Returns

Type Description
str

JSON formatted termination policy.