# Functions
AgentUserGroupFromProto convert agent user group from proto to model.
DefaultConfig is the default configuration used by all commands (e.g., commands, notebooks, shells) if a request does not specify any configuration options.
DefaultConfigGenericTaskConfig merges task containter defaults into a default generic task config struct.
DefaultEnvConfig returns the default environment configuration.
DefaultResourcesConfig returns the default resources configuration.
DefaultTaskContainerDefaults returns the default for TaskContainerDefaultsConfig.
DeserializeMetricIdentifier deserialize a metric identifier from a string.
ExitedReasonFromProto returns an ExitedReason from its protobuf representation.
ExperimentFromProto converts a experimentv1.Experiment to a model.Experiment.
FmtInstances formats instance ids and states to print.
HashPassword hashes the user's password.
JobTypeFromProto maps a jobv1.Type to JobType.
MakeTLSConfig constructs a TLSClientConfig to use the provided tls.Certificate.
MostProgressedAllocationState returns the further progressed state.
MostProgressedExperimentState returns the more advanced active state based on experimentStateIndex (Queued -> Pulling -> Starting -> Running).
NewAllocationID casts string ptr to AllocationID ptr.
NewExperiment creates a new experiment struct in the paused state.
NewJobID returns a random, globally unique job ID.
NewRequestID returns a new request ID using the provided reader.
NewTaskID returns a random, globally unique task ID.
NewTrial creates a new trial in the specified state.
NewUUID creates a new, non-null and random UUID.
ParseJustResources is a helper function for breaking the circular dependency where we need the TaskContainerDefaults to unmarshal an ExperimentConfig, but we need the Resources.ResourcePool setting to know which TaskContainerDefaults to use.
ParseUUID initializes a non-null UUID from a string.
ProjectsToProto converts a slice of projects to its protobuf representation.
SCIMEmailsFromJWT returns a consistent SCIMEmails struct wrapping the single email in a JWT.
SCIMNameFromJWT returns a consistent SCIMName struct wrapping the single name in a JWT.
SortableSlotIndex returns a slot index that will sort as you want to.
StateFromProto maps experimentv1.State to State.
StatesToStrings converts a State map to a list of strings for db queries.
StateToProto maps State to experimentv1.State.
SummarizeSlots a set of slots.
TaskLogFromProto converts a proto task log to a model task log.
TaskLogLevelFromLogrus returns an equivalent task log level from a logrus level.
TaskLogLevelFromProto returns a task log level from its protobuf repr.
TaskLogLevelToProto returns a protobuf task log level from its string repr.
TokenTypeFromProto maps a userv1.TokenType to TokenType.
ToModelBindMount converts new expconf bind mounts into old modl bind mounts.
TrialMetricsJSONPath returns the legacy JSON path to the metrics field in the metrics table.
TrialSummaryMetricGroup returns the metric group for the given summary JSON path.
TrialSummaryMetricsJSONPath returns the JSON path to the trials metric summary.
UserActivityFromProto returns a model UserActivity from a proto definition.
UsingCustomImage checks for image argument in request.
ValidatePrioritySetting checks that priority if set is within a valid range.
# Constants
ActiveState constant.
ActivityTypeGet represents a get request.
AdminRole implies management / administrative access.
AggregationTypeQueued is the type of aggregation for queued tasks.
AllocationStateAssigned state denotes that the command has been assigned to an agent but has not started yet.
AllocationStatePending state denotes that the command is awaiting allocation.
AllocationStatePulling state denotes that the command's base image is being pulled from the Docker registry.
AllocationStateRunning state denotes that the service in the command is running.
AllocationStateStarting state denotes that the image has been pulled and the task is being started, but the task is not ready yet.
AllocationStateTerminated state denotes that the command has exited or has been aborted.
AllocationStateTerminating state denotes that the command is terminating.
AllocationStateWaiting state denotes that the command is waiting on data.
BCryptCost is a stopgap until we implement sane master-configuration.
CanceledState constant.
CompletedState constant.
CurrentTaskLogVersion describes the current scheme in which we store task logs.
DefaultPreemptionTimeout is the number of seconds to wait for preempted task to exit gracefully.
DefaultProjectID is the default project ID for the default workspace.
DefaultWorkspaceID is a special, always-existing, workspace titled "Uncategorized".
DefaultWorkspaceName is the default workspace name, which is always present, and always has ID 1.
DeletedState constant.
DeleteFailedState constant.
DeletingState constant.
DeterminedK8ContainerName is the name of the container that executes the task within Kubernetes pods that are launched by Determined.
EntityTypeProject represents a project.
Errored signals the searcher that the workload errored out.
ErrorState constant.
ExperimentType constant.
GlobalAccessScopeID represents global permission access.
Healthy indicates passing the health check.
InferenceMetricGroup designates metrics from inference runs.
InitInvalidHP signals the searcher that the user raised an InvalidHP exception in the trial init.
InvalidHP signals the searcher that the user raised an InvalidHP exception.
JobTypeCheckpointGC is the "CheckpointGC" job type for enum.job_type in Postgres.
JobTypeCommand is the "COMMAND" job type for the enum public.job_type in Postgres.
JobTypeExperiment is the "EXPERIMENT" job type for the enum.job_type in Postgres.
JobTypeGeneric is the "GENERIC" job type for enum.job_type in Postgres.
JobTypeNotebook is the "NOTEBOOK" job type for the enum public.job_type in Postgres.
JobTypeShell is the "SHELL" job type for the enum public.job_type in Postgres.
JobTypeTensorboard is the "TENSORBOARD" job type for the enum.job_type in Postgres.
LogLevelCritical is the critical task log level.
LogLevelDebug is the debug task log level.
LogLevelError is the error task log level.
LogLevelInfo is the info task log level.
LogLevelTrace is the trace task log level.
LogLevelUnspecified is the unspecified task log level.
LogLevelWarning is the warn task log level.
MaxUserSchedulingPriority is the largest priority users may specify.
MinUserSchedulingPriority is the smallest priority users may specify.
NoRole implies previous access has been revoked.
NotebookIdleTypeActivity indicates that a notebook should be considered active if any kernel is running a command or any terminal is inputting or outputting data.
NotebookIdleTypeKernelConnections indicates that a notebook should be considered active if any connections to kernels are open.
NotebookIdleTypeKernelsOrTerminals indicates that a notebook should be considered active if any kernels or terminals are open.
NotebookSessionEnvVar is the environment variable name for notebook task tokens.
NTSCType constant.
PartiallyDeletedState constant.
PausedState constant.
RFC3339MicroTrailingZeroes unlike time.RFC3339Nano is a time format specifier that preserves trailing zeroes.
Running describes the instance is running.
RunningState constant.
SpotRequestPendingAWS indicates that the instance is actually a pending AWS spot request.
Starting describes the instance is starting up.
StepsCompletedMetadataKey is the key within metadata to find steps completed now, if it exists.
Stopped describes the instance is stopped.
Stopping describes the instance is stopping.
StoppingCanceledState constant.
StoppingCompletedState constant.
StoppingErrorState constant.
StoppingKilledState constant.
CurrentTaskLogVersion describes the current scheme in which we store task logs.
CurrentTaskLogVersion describes the current scheme in which we store task logs.
TaskStateActive denotes that task is running.
TaskStateCanceled denotes that task is killed.
TaskStateCompleted denotes that task has finished running.
TaskStateError denotes that task has exited with an error.
TaskStatePaused denotes that task has been paused.
TaskStateStoppingCanceled denotes that the task is in the process of being canceled.
TaskStateStoppingCompleted denotes that the task is in the process of being completed.
TaskStateStoppingError denotes that the task is in the process of returning an error.
TaskStateStoppingPaused denotes that the task is in the process of being paused.
TaskTypeCheckpointGC is the "CHECKPOINT_GC" job type for the enum public.job_type in Postgres.
TaskTypeCommand is the "COMMAND" job type for the enum public.job_type in Postgres.
TaskTypeGeneric is the "GENERIC" job type for the enum public.job_type in Postgres.
TaskTypeNotebook is the "NOTEBOOK" job type for the enum public.job_type in Postgres.
TaskTypeShell is the "SHELL" job type for the enum public.job_type in Postgres.
TaskTypeTensorboard is the "TENSORBOARD" task type for the enum.task_type in Postgres.
TaskTypeTrial is the "TRIAL" job type for the enum public.job_type in Postgres.
Terminating is when the instance is in the process of being terminated.
TokenTypeAccessToken is the "ACCESS_TOKEN" token type for the enum public.token_type in Postgres.
TokenTypeUserSession is the "USER_SESSION" token type for the enum public.token_type in Postgres.
TrainingMetricGroup designates metrics from training runs.
TrialWorkloadSequencerType constant.
Unhealthy indicates failing the health check.
Unknown describes the instance state cannot be recognized.
UnknownType constant.
UserCanceled signals the searcher that the user requested a cancelation, from the CLI or UI.
UserRequestedStop signals the searcher that the user requested a cancelation, from code.
UserRole implies normal worker access.
ValidationMetricGroup designates metrics from validation runs.
WorkspaceStateDeleted constant.
WorkspaceStateDeleteFailed constant.
WorkspaceStateDeleting constant.
# Variables
CheckpointReverseTransitions list possible ancestor states.
CheckpointTransitions maps checkpoint states to their possible transitions.
DeletingStates are the valid deleting states.
EmptyPassword is the empty password (i.e., the empty string).
ExperimentReverseTransitions lists possible ancestor states.
ExperimentTransitions maps experiment states to their possible transitions.
ManualStates are the states the user can set an experiment to.
NonTerminalStates where an experiment can be canceled or killed.
NoPasswordLogin is a password that prevents the user from logging in directly.
ProfilingMetricGroups designates metrics from profiling runs.
RunningStates are the valid running states.
StepReverseTransitions list possible ancestor states.
StepTransitions maps step and validation states to their possible transitions.
StoppingStates are the valid stopping states.
StoppingToTerminalStates maps from stopping states to the corresponding terminal states.
TerminalStates are the valid terminal states.
TrialReverseTransitions list possible ancestor states.
TrialTransitions maps trial states to their possible transitions.
# Structs
AcceleratorData is the model for an allocation accelerator data in the database.
AgentStats stores the start/end status of instance.
AgentSummary summarizes the state on an agent.
An AgentUserGroup represents a username and primary group for a user on an agent host machine.
Allocation is the model for an allocation in the database.
AllocationSession corresponds to a row in the "allocation_sessions" DB table.
AllocationWorkspaceRecord is the model for persisting the workspace and experiment information associated with an allocation.
AuthTokenKeypair stores the public/private keypair used for asymmetric encryption of authentication tokens.
BindMount configures trial runner filesystem bind mounts.
Checkpoint represents a row from the `checkpoints_view` view.
CheckpointTrainingMetadata is a substruct of checkpoints encapsulating training specific information.
CheckpointV2 represents a row from the `checkpoints_v2` table.
ClusterMessage represents a server status from the `cluster_messages` table.
CommandConfig holds the necessary configurations to launch a command task in the cluster.
ConfigFile represents a row from the `config_files` table.
Constraints are non-overridable workload constraints.
DefaultLoggingConfig configures logging for tasks using HTTP to the master.
DeviceConfig configures container device access.
ElasticLoggingConfig configures logging for tasks using Elastic.
ElasticSecurityConfig configures security-related options for the elastic logging backend.
Environment configures the environment of a Determined command or experiment.
Experiment represents a row from the `experiments` table.
ExternalSessions provides an integration point for an external service to issue JWTs to control access to the cluster.
A FullUser is a User joined with any other user relations.
GenericTaskConfig like expconf or command config but for generic tasks.
Group represents a user group as it's stored in the database.
GroupMembership represents a user's membership to a group as it's stored in the database.
HealthCheck is the response to the health check request.
Instance connects a provider's name for a compute resource to the Determined agent name.
InstanceStats stores the start/end status of instance.
InvalidationMap tracks times before which users should be considered invalid.
Job is the model for a job in the database.
JWT defines the claims that are serialized and signed to make a bearer token.
KubernetesTaskContainerDefaults is task container defaults specific to Kubernetes.
LoggingConfig configures logging for tasks (currently only trials) in Determined.
LogRetentionPolicy configures the default log retention policy for trials and tasks.
MetricIdentifier packages metric group and name together.
NotebookSession corresponds to a row in the "notebook_sessions" DB table.
OAuthClient represents one OAuth client application.
OAuthToken represents an OAuth token.
OrgRoleClaims is the specification of all permissions a user has in a given org.
A PatchOperation is a RFC 6902 JSON Patch.
A PatchRequest is a SCIM patch request.
PatchSchemas is a constant schemas field for a patch.
Project is the bun model of a project.
ProjectHparam represents a row from the `project_hparams` table.
ProxyPort is a legacy-style clone of expconf.ProxyPort.
ResourceAggregates is the model for resource_aggregates in the database.
ResourceConstraints are non-overridable resource constraints.
ResourceManagerHealth is a pair of resource manager name and health status.
ResourcesConfig configures resource usage for a command, notebook, tensorboard, generic task, or old experiment(new experiment uses ResourcesConfigV0).
RoleAssignmentScope represents a RoleAssignmentScope as it's stored in the database.
Run represents a row from the `runs` table.
RunCheckpoints represents a row from the `run_checkpoints` table.
RunHparam represents a row from the `run_hparams` table.
RunMetadata is the bun model of a runMetadata entry.
RunMetadataIndex is the bun model of a runMetadataIndex entry.
RunTaskID represents a row from the `run_id_task_id` table.
RuntimeItem configures the runtime image.
RuntimeItems configures the runtime environment variables.
SCIMEmail is an email address in SCIM.
SCIMError is an error in SCIM.
SCIMErrorSchemas is the constant schemas field for errors.
SCIMGroup is a group in SCIM.
SCIMGroupMeta is the metadata for a group in SCIM.
SCIMGroupResourceType is the constant resource type field for groups.
SCIMGroups is a list of groups in SCIM.
SCIMGroupSchemas is the constant schemas field for a user.
SCIMListSchemas is the constant schemas field for lists.
SCIMName is a name in SCIM.
SCIMUser is a user in SCIM.
SCIMUserMeta is the metadata for a user in SCIM.
SCIMUserResourceType is the constant resource type field for users.
SCIMUsers is a list of users in SCIM.
SCIMUserSchemas is the constant schemas field for a user.
SlotSummary summarizes the state of a slot.
StateWithReason is the run state of an experiment with an informational reason used for logging purposes.
Task is the model for a task in the database.
TaskConfigPolicies is the bun model of a task config policy.
TaskContainerDefaultsConfig configures docker defaults for all containers.
TaskContextDirectory represents a row in database for a tasks context directory.
TaskLog represents a structured log emitted by an allocation.
TaskStats is the model for task stats in the database.
Template represents a row from the `templates` table.
TLSClientConfig configures how to make a TLS connection.
Trial represents a row from the `trials` table.
TrialLog represents a row from the `trial_logs` table.
TrialMetrics represents a row from the `steps` or `validations` table.
TrialProfilerMetricsBatch represents a row from the `trial_profiler_metrics` table.
TrialV2 represents a row from the `trials_v2` table.
User corresponds to a row in the "users" DB table.
UserActivity is a record of user activity.
UserSession corresponds to a row in the "user_sessions" DB table.
UserWebSetting is a record of user web setting.
UUID is a UUID that converts to a nullable string in SQL queries.
Workspace is the bun model of a workspace.
WorkspaceNamespace is the bun model of a workspace-namespace binding.
WorkspacePin is the bun model of a workspace.
# Interfaces
InstanceType describes an instance type.
Snapshotter is any object that implements how to save an restore its state.
# Type aliases
AccessScopeID is an identifier for an access scope.
AccessScopeSet is a set of access scopes.
ActivityType describes a user activity.
AgentsSummary is a map of agent IDs to a summary of the agent.
AllocationID is the ID of an allocation of a task.
AllocationState represents the current state of the task.
BindMountsConfig is the configuration for bind mounts.
ClusterID is a string intended specifically as a cluster ID.
DevicesConfig is the configuration for devices.
Duration is a JSON (un)marshallable version of time.Duration.
EntityType represents an entity.
ExitedReason defines why a workload exited early.
ExtendedFloat64 handles serializing floats to JSON, including special cases for infinite values.
Groups is a slice of Group objects—primarily useful for its methods.
HealthStatus is the up or down informational status.
InstanceState is an enum type that describes an instance state.
JobID is the unique ID of a job among all jobs.
JobType is the type of a job.
JSONObj is a JSON object that converts to a []byte in SQL queries.
MetricGroup denotes what custom group the metric is.
OrgID is a string intended specifically as a organization ID.
Projects is an array of project instances.
ProxyPortsConfig is a legacy-style clone of expconf.ProxyPortsConfig.
RequestID links all operations with the same ID to a single trial create request.
Role is a string intended specifically as an access level.
SCIMEmails is a list of emails in SCIM.
SessionID is the type for user session IDs.
SlotsSummary contains a summary for a number of slots.
State is the run state of an experiment / trial / step / etc.
StorageBackendID is the ID for the storage backend.
StorageSize is a named type for custom marshaling behavior for shm_size.
TaskID is the unique ID of a task among all tasks.
TaskLogBatch represents a batch of model.TaskLog.
TaskLogVersion is the version for our log-storing scheme.
TaskState represents the state of a generic task.
TaskType is the type of a task.
TokenID is the type for token IDs.
TokenType is the type of a token.
TrialLogBatch represents a batch of model.TrialLog.
TrialProfilerMetricsBatchBatch represents a batch of trialv1.TrialProfilerMetricsBatch.
UserID is the type for user IDs.
Users is a slice of User objects—primarily useful for its methods.
WorkloadManagerType indicates which type of workloads the harness should prepare to receive.
WorkloadSequencerType is the type of sequencer that a trial actor should use.
WorkspaceState is the state of the workspace state with regards to being deleted.