# Constants
The experiment is in an active state.
The experiment is canceled and is shut down.
The experiment is completed and is shut down.
The experiment failed to delete.
The experiment has been deleted.
The experiment is deleting.
The experiment is errored and is shut down.
The experiment is in a paused state.
The experiment is pulling the image.
The experiment is queued (waiting to be run, or job state is still queued).
The experiment has an allocation actively running.
The experiment is preparing the environment after finishing pulling the image.
The experiment is canceled and is shutting down.
The experiment is completed and is shutting down.
The experiment is errored and is shutting down.
The experiment is killed and is shutting down.
The state of the experiment is unknown.
Indicates the trial exited due to an invalid hyperparameter.
Zero-value (not allowed).
Indicates the trial exited due to a user requested stop, from the CLI or UI.
Indicates the trial exited due to a user requested stop, from code.
# Variables
No description provided by the author
No description provided by the author
Enum value maps for State.
Enum value maps for State.
Enum value maps for TrialExitedEarly_ExitedReason.
Enum value maps for TrialExitedEarly_ExitedReason.
# Structs
Close a trial with given ID.
Create a trial with given hyperparameters.
Experiment is a collection of one or more trials that are exploring a user-defined hyperparameter space.
ExperimentInactive is a searcher event triggered when an experiment is no longer active.
ExperimentTrial is trial-level data that is surfaced to the experiment level.
File node is one node of file in experiment model definition file tree.
InitialOperations is a searcher event signaling the creation of an experiment.
PatchExperiment is a partial update to an experiment with only id required.
Nested object for checkpoint_storage field patch.
Nested object for resources field patch.
SearcherOperation is an operation issued by the custom searcher.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
SearchSummary contains the estimated trials and training lengths that a search plans to execute.
SearchUnit describes a length unit used by some searchers to manage training.
Shut down custom searcher method.
TrialClosed is a searcher event triggered when a trial has successfully finished.
TrialCreated is a searcher event signaling the creation of a trial.
TrialExitedEarly is a searcher event triggered when a trial exited prematurely.
TrialOperation is any operation that a trial can perform while it is active.
No description provided by the author
TrialProgress is a searcher event that tells you the number of batches completed in the trial.
TrialSummary describes the runs that are estimated to train for a certain length.
ValidateAfterOperation means the trial should train and validate after training the given length.
ValidationCompleted is a searcher event triggered when a validation has been completed.
ValidationHistoryEntry is a single entry for a validation history for an experiment.
# Type aliases
The current state of the experiment.
The reason for an early exit.