projectv1

package
v0.0.0-...-3511abf Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 2, 2023 License: Apache-2.0 Imports: 9 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	LocationType_name = map[int32]string{
		0: "LOCATION_TYPE_UNSPECIFIED",
		1: "LOCATION_TYPE_EXPERIMENT",
		2: "LOCATION_TYPE_HYPERPARAMETERS",
		3: "LOCATION_TYPE_VALIDATIONS",
		4: "LOCATION_TYPE_TRAINING",
		5: "LOCATION_TYPE_CUSTOM_METRIC",
	}
	LocationType_value = map[string]int32{
		"LOCATION_TYPE_UNSPECIFIED":     0,
		"LOCATION_TYPE_EXPERIMENT":      1,
		"LOCATION_TYPE_HYPERPARAMETERS": 2,
		"LOCATION_TYPE_VALIDATIONS":     3,
		"LOCATION_TYPE_TRAINING":        4,
		"LOCATION_TYPE_CUSTOM_METRIC":   5,
	}
)

Enum value maps for LocationType.

View Source
var (
	ColumnType_name = map[int32]string{
		0: "COLUMN_TYPE_UNSPECIFIED",
		1: "COLUMN_TYPE_TEXT",
		2: "COLUMN_TYPE_NUMBER",
		3: "COLUMN_TYPE_DATE",
	}
	ColumnType_value = map[string]int32{
		"COLUMN_TYPE_UNSPECIFIED": 0,
		"COLUMN_TYPE_TEXT":        1,
		"COLUMN_TYPE_NUMBER":      2,
		"COLUMN_TYPE_DATE":        3,
	}
)

Enum value maps for ColumnType.

View Source
var File_determined_project_v1_project_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type ColumnType

type ColumnType int32

ColumnType indicates the type of data under the column

const (
	// data type is unknown/mixed
	ColumnType_COLUMN_TYPE_UNSPECIFIED ColumnType = 0
	// data type is textual
	ColumnType_COLUMN_TYPE_TEXT ColumnType = 1
	// data type is numeric
	ColumnType_COLUMN_TYPE_NUMBER ColumnType = 2
	// data type is a date
	ColumnType_COLUMN_TYPE_DATE ColumnType = 3
)

func (ColumnType) Descriptor

func (ColumnType) Descriptor() protoreflect.EnumDescriptor

func (ColumnType) Enum

func (x ColumnType) Enum() *ColumnType

func (ColumnType) EnumDescriptor deprecated

func (ColumnType) EnumDescriptor() ([]byte, []int)

Deprecated: Use ColumnType.Descriptor instead.

func (ColumnType) Number

func (x ColumnType) Number() protoreflect.EnumNumber

func (ColumnType) String

func (x ColumnType) String() string

func (ColumnType) Type

type LocationType

type LocationType int32

LocationType indicates where a column comes from

const (
	// Location unknown
	LocationType_LOCATION_TYPE_UNSPECIFIED LocationType = 0
	// Column is located on the experiment
	LocationType_LOCATION_TYPE_EXPERIMENT LocationType = 1
	// Column is located in the hyperparameter config of the experiment
	LocationType_LOCATION_TYPE_HYPERPARAMETERS LocationType = 2
	// Column is located on the experiment's validation metrics
	LocationType_LOCATION_TYPE_VALIDATIONS LocationType = 3
	// Column is located on the experiment's training steps
	LocationType_LOCATION_TYPE_TRAINING LocationType = 4
	// Column is located on the experiment's custom metric
	LocationType_LOCATION_TYPE_CUSTOM_METRIC LocationType = 5
)

func (LocationType) Descriptor

func (LocationType) Enum

func (x LocationType) Enum() *LocationType

func (LocationType) EnumDescriptor deprecated

func (LocationType) EnumDescriptor() ([]byte, []int)

Deprecated: Use LocationType.Descriptor instead.

func (LocationType) Number

func (LocationType) String

func (x LocationType) String() string

func (LocationType) Type

type MetricsRange

type MetricsRange struct {

	// The name of metrics formatted as <type>.<name>.
	MetricsName string `protobuf:"bytes,1,opt,name=metrics_name,json=metricsName,proto3" json:"metrics_name,omitempty"`
	// The min of metrics values.
	Min float64 `protobuf:"fixed64,2,opt,name=min,proto3" json:"min,omitempty"`
	// The max of metrics values.
	Max float64 `protobuf:"fixed64,3,opt,name=max,proto3" json:"max,omitempty"`
	// contains filtered or unexported fields
}

MetricsRange represents the range of a metrics. Range is a in the format of [min, max].

func (*MetricsRange) Descriptor deprecated

func (*MetricsRange) Descriptor() ([]byte, []int)

Deprecated: Use MetricsRange.ProtoReflect.Descriptor instead.

func (*MetricsRange) GetMax

func (x *MetricsRange) GetMax() float64

func (*MetricsRange) GetMetricsName

func (x *MetricsRange) GetMetricsName() string

func (*MetricsRange) GetMin

func (x *MetricsRange) GetMin() float64

func (*MetricsRange) ProtoMessage

func (*MetricsRange) ProtoMessage()

func (*MetricsRange) ProtoReflect

func (x *MetricsRange) ProtoReflect() protoreflect.Message

func (*MetricsRange) Reset

func (x *MetricsRange) Reset()

func (*MetricsRange) String

func (x *MetricsRange) String() string

type Note

type Note struct {

	// The name or title of the note.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The text contents of the note.
	Contents string `protobuf:"bytes,2,opt,name=contents,proto3" json:"contents,omitempty"`
	// contains filtered or unexported fields
}

Note is a user comment connected to a project.

func (*Note) Descriptor deprecated

func (*Note) Descriptor() ([]byte, []int)

Deprecated: Use Note.ProtoReflect.Descriptor instead.

func (*Note) GetContents

func (x *Note) GetContents() string

func (*Note) GetName

func (x *Note) GetName() string

func (*Note) ProtoMessage

func (*Note) ProtoMessage()

func (*Note) ProtoReflect

func (x *Note) ProtoReflect() protoreflect.Message

func (*Note) Reset

func (x *Note) Reset()

func (*Note) String

func (x *Note) String() string

type PatchProject

type PatchProject struct {

	// The new name for the project.
	Name *wrappers.StringValue `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// The new description for the project.
	Description *wrappers.StringValue `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	// contains filtered or unexported fields
}

PatchProject is a partial update to a project with all optional fields.

func (*PatchProject) Descriptor deprecated

func (*PatchProject) Descriptor() ([]byte, []int)

Deprecated: Use PatchProject.ProtoReflect.Descriptor instead.

func (*PatchProject) GetDescription

func (x *PatchProject) GetDescription() *wrappers.StringValue

func (*PatchProject) GetName

func (x *PatchProject) GetName() *wrappers.StringValue

func (*PatchProject) ProtoMessage

func (*PatchProject) ProtoMessage()

func (*PatchProject) ProtoReflect

func (x *PatchProject) ProtoReflect() protoreflect.Message

func (*PatchProject) Reset

func (x *PatchProject) Reset()

func (*PatchProject) String

func (x *PatchProject) String() string

type Project

type Project struct {

	// The unique id of the project.
	Id int32 `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	// The unique name of the project.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// The id of the associated workspace.
	WorkspaceId int32 `protobuf:"varint,3,opt,name=workspace_id,json=workspaceId,proto3" json:"workspace_id,omitempty"`
	// The description of the project.
	Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
	// Time of most recently started experiment within this project.
	LastExperimentStartedAt *timestamp.Timestamp `` /* 134-byte string literal not displayed */
	// Notes associated with this project.
	Notes []*Note `protobuf:"bytes,6,rep,name=notes,proto3" json:"notes,omitempty"`
	// Count of experiments associated with this project.
	NumExperiments int32 `protobuf:"varint,7,opt,name=num_experiments,json=numExperiments,proto3" json:"num_experiments,omitempty"`
	// Count of active experiments associated with this project.
	NumActiveExperiments int32 `protobuf:"varint,8,opt,name=num_active_experiments,json=numActiveExperiments,proto3" json:"num_active_experiments,omitempty"`
	// Whether this project is archived or not.
	Archived bool `protobuf:"varint,9,opt,name=archived,proto3" json:"archived,omitempty"`
	// User who created this project.
	Username string `protobuf:"bytes,10,opt,name=username,proto3" json:"username,omitempty"`
	// Whether this project is immutable (default uncategorized project).
	Immutable bool `protobuf:"varint,11,opt,name=immutable,proto3" json:"immutable,omitempty"`
	// ID of the user who created this project.
	UserId int32 `protobuf:"varint,12,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"`
	// The name of the associated workspace.
	WorkspaceName string `protobuf:"bytes,13,opt,name=workspace_name,json=workspaceName,proto3" json:"workspace_name,omitempty"`
	// State of project during deletion.
	State workspacev1.WorkspaceState `protobuf:"varint,14,opt,name=state,proto3,enum=determined.workspace.v1.WorkspaceState" json:"state,omitempty"`
	// Message stored from errors on async-deleting a project.
	ErrorMessage string `protobuf:"bytes,15,opt,name=error_message,json=errorMessage,proto3" json:"error_message,omitempty"`
	// contains filtered or unexported fields
}

Project is a named collection of experiments.

func (*Project) Descriptor deprecated

func (*Project) Descriptor() ([]byte, []int)

Deprecated: Use Project.ProtoReflect.Descriptor instead.

func (*Project) GetArchived

func (x *Project) GetArchived() bool

func (*Project) GetDescription

func (x *Project) GetDescription() string

func (*Project) GetErrorMessage

func (x *Project) GetErrorMessage() string

func (*Project) GetId

func (x *Project) GetId() int32

func (*Project) GetImmutable

func (x *Project) GetImmutable() bool

func (*Project) GetLastExperimentStartedAt

func (x *Project) GetLastExperimentStartedAt() *timestamp.Timestamp

func (*Project) GetName

func (x *Project) GetName() string

func (*Project) GetNotes

func (x *Project) GetNotes() []*Note

func (*Project) GetNumActiveExperiments

func (x *Project) GetNumActiveExperiments() int32

func (*Project) GetNumExperiments

func (x *Project) GetNumExperiments() int32

func (*Project) GetState

func (x *Project) GetState() workspacev1.WorkspaceState

func (*Project) GetUserId

func (x *Project) GetUserId() int32

func (*Project) GetUsername

func (x *Project) GetUsername() string

func (*Project) GetWorkspaceId

func (x *Project) GetWorkspaceId() int32

func (*Project) GetWorkspaceName

func (x *Project) GetWorkspaceName() string

func (*Project) ProtoMessage

func (*Project) ProtoMessage()

func (*Project) ProtoReflect

func (x *Project) ProtoReflect() protoreflect.Message

func (*Project) Reset

func (x *Project) Reset()

func (*Project) String

func (x *Project) String() string

type ProjectColumn

type ProjectColumn struct {

	// Raw column name.
	Column string `protobuf:"bytes,1,opt,name=column,proto3" json:"column,omitempty"`
	// Where the column comes from.
	Location LocationType `protobuf:"varint,2,opt,name=location,proto3,enum=determined.project.v1.LocationType" json:"location,omitempty"`
	// Type of data in the column.
	Type ColumnType `protobuf:"varint,3,opt,name=type,proto3,enum=determined.project.v1.ColumnType" json:"type,omitempty"`
	// Human-friendly name.
	DisplayName string `protobuf:"bytes,4,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"`
	// contains filtered or unexported fields
}

Project Column is a description of a column used on experiments in the project.

func (*ProjectColumn) Descriptor deprecated

func (*ProjectColumn) Descriptor() ([]byte, []int)

Deprecated: Use ProjectColumn.ProtoReflect.Descriptor instead.

func (*ProjectColumn) GetColumn

func (x *ProjectColumn) GetColumn() string

func (*ProjectColumn) GetDisplayName

func (x *ProjectColumn) GetDisplayName() string

func (*ProjectColumn) GetLocation

func (x *ProjectColumn) GetLocation() LocationType

func (*ProjectColumn) GetType

func (x *ProjectColumn) GetType() ColumnType

func (*ProjectColumn) ProtoMessage

func (*ProjectColumn) ProtoMessage()

func (*ProjectColumn) ProtoReflect

func (x *ProjectColumn) ProtoReflect() protoreflect.Message

func (*ProjectColumn) Reset

func (x *ProjectColumn) Reset()

func (*ProjectColumn) String

func (x *ProjectColumn) String() string

type ProjectModel

type ProjectModel struct {

	// Name of the saved checkpoint.
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Checkpoint associated with the project.
	Checkpoint *checkpointv1.Checkpoint `protobuf:"bytes,2,opt,name=checkpoint,proto3" json:"checkpoint,omitempty"`
	// contains filtered or unexported fields
}

ProjectModel is a checkpoint associated with a project.

func (*ProjectModel) Descriptor deprecated

func (*ProjectModel) Descriptor() ([]byte, []int)

Deprecated: Use ProjectModel.ProtoReflect.Descriptor instead.

func (*ProjectModel) GetCheckpoint

func (x *ProjectModel) GetCheckpoint() *checkpointv1.Checkpoint

func (*ProjectModel) GetName

func (x *ProjectModel) GetName() string

func (*ProjectModel) ProtoMessage

func (*ProjectModel) ProtoMessage()

func (*ProjectModel) ProtoReflect

func (x *ProjectModel) ProtoReflect() protoreflect.Message

func (*ProjectModel) Reset

func (x *ProjectModel) Reset()

func (*ProjectModel) String

func (x *ProjectModel) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL