v1

package
v0.1.215 Latest Latest
Warning

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

 Go to latest Published: Oct 12, 2023 License: Apache-2.0 Imports: 19 Imported by: 2

Documentation

Overview

Package v1 is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

This section is empty.

Variables

View Source 
var (
	ModelType_name = map[int32]string{
		0: "MODEL_TYPE_UNSPECIFIED",
		1: "MODEL_TYPE_SINGLE_LABEL_CLASSIFICATION",
		2: "MODEL_TYPE_MULTI_LABEL_CLASSIFICATION",
		3: "MODEL_TYPE_OBJECT_DETECTION",
	}
	ModelType_value = map[string]int32{
		"MODEL_TYPE_UNSPECIFIED":                 0,
		"MODEL_TYPE_SINGLE_LABEL_CLASSIFICATION": 1,
		"MODEL_TYPE_MULTI_LABEL_CLASSIFICATION":  2,
		"MODEL_TYPE_OBJECT_DETECTION":            3,
	}
)

Enum value maps for ModelType.

View Source 
var (
	TrainingStatus_name = map[int32]string{
		0: "TRAINING_STATUS_UNSPECIFIED",
		1: "TRAINING_STATUS_PENDING",
		2: "TRAINING_STATUS_IN_PROGRESS",
		3: "TRAINING_STATUS_COMPLETED",
		4: "TRAINING_STATUS_FAILED",
		5: "TRAINING_STATUS_CANCELED",
		6: "TRAINING_STATUS_CANCELING",
	}
	TrainingStatus_value = map[string]int32{
		"TRAINING_STATUS_UNSPECIFIED": 0,
		"TRAINING_STATUS_PENDING":     1,
		"TRAINING_STATUS_IN_PROGRESS": 2,
		"TRAINING_STATUS_COMPLETED":   3,
		"TRAINING_STATUS_FAILED":      4,
		"TRAINING_STATUS_CANCELED":    5,
		"TRAINING_STATUS_CANCELING":   6,
	}
)

Enum value maps for TrainingStatus.

View Source 
var File_app_mltraining_v1_ml_training_proto protoreflect.FileDescriptor
View Source 
var MLTrainingService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "viam.app.mltraining.v1.MLTrainingService",
	HandlerType: (*MLTrainingServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "SubmitTrainingJob",
			Handler:    _MLTrainingService_SubmitTrainingJob_Handler,
		},
		{
			MethodName: "GetTrainingJob",
			Handler:    _MLTrainingService_GetTrainingJob_Handler,
		},
		{
			MethodName: "ListTrainingJobs",
			Handler:    _MLTrainingService_ListTrainingJobs_Handler,
		},
		{
			MethodName: "CancelTrainingJob",
			Handler:    _MLTrainingService_CancelTrainingJob_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "app/mltraining/v1/ml_training.proto",
}

MLTrainingService_ServiceDesc is the grpc.ServiceDesc for MLTrainingService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterMLTrainingServiceHandler 

func RegisterMLTrainingServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterMLTrainingServiceHandler registers the http handlers for service MLTrainingService to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterMLTrainingServiceHandlerClient 

func RegisterMLTrainingServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client MLTrainingServiceClient) error

RegisterMLTrainingServiceHandlerClient registers the http handlers for service MLTrainingService to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "MLTrainingServiceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "MLTrainingServiceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "MLTrainingServiceClient" to call the correct interceptors.

func RegisterMLTrainingServiceHandlerFromEndpoint 

func RegisterMLTrainingServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterMLTrainingServiceHandlerFromEndpoint is same as RegisterMLTrainingServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterMLTrainingServiceHandlerServer 

func RegisterMLTrainingServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server MLTrainingServiceServer) error

RegisterMLTrainingServiceHandlerServer registers the http handlers for service MLTrainingService to "mux". UnaryRPC :call MLTrainingServiceServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterMLTrainingServiceHandlerFromEndpoint instead.

func RegisterMLTrainingServiceServer 

func RegisterMLTrainingServiceServer(s grpc.ServiceRegistrar, srv MLTrainingServiceServer)

Types

type CancelTrainingJobRequest added in v0.1.86 

type CancelTrainingJobRequest struct {
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

func (*CancelTrainingJobRequest) Descriptor deprecated added in v0.1.86 

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

Deprecated: Use CancelTrainingJobRequest.ProtoReflect.Descriptor instead.

func (*CancelTrainingJobRequest) GetId added in v0.1.86 

func (x *CancelTrainingJobRequest) GetId() string

func (*CancelTrainingJobRequest) ProtoMessage added in v0.1.86 

func (*CancelTrainingJobRequest) ProtoMessage()

func (*CancelTrainingJobRequest) ProtoReflect added in v0.1.86 

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

func (*CancelTrainingJobRequest) Reset added in v0.1.86 

func (x *CancelTrainingJobRequest) Reset()

func (*CancelTrainingJobRequest) String added in v0.1.86 

func (x *CancelTrainingJobRequest) String() string

type CancelTrainingJobResponse added in v0.1.86 

type CancelTrainingJobResponse struct {
	// contains filtered or unexported fields
}

func (*CancelTrainingJobResponse) Descriptor deprecated added in v0.1.86 

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

Deprecated: Use CancelTrainingJobResponse.ProtoReflect.Descriptor instead.

func (*CancelTrainingJobResponse) ProtoMessage added in v0.1.86 

func (*CancelTrainingJobResponse) ProtoMessage()

func (*CancelTrainingJobResponse) ProtoReflect added in v0.1.86 

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

func (*CancelTrainingJobResponse) Reset added in v0.1.86 

func (x *CancelTrainingJobResponse) Reset()

func (*CancelTrainingJobResponse) String added in v0.1.86 

func (x *CancelTrainingJobResponse) String() string

type GetTrainingJobRequest 

type GetTrainingJobRequest struct {
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

func (*GetTrainingJobRequest) Descriptor deprecated 

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

Deprecated: Use GetTrainingJobRequest.ProtoReflect.Descriptor instead.

func (*GetTrainingJobRequest) GetId 

func (x *GetTrainingJobRequest) GetId() string

func (*GetTrainingJobRequest) ProtoMessage 

func (*GetTrainingJobRequest) ProtoMessage()

func (*GetTrainingJobRequest) ProtoReflect 

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

func (*GetTrainingJobRequest) Reset 

func (x *GetTrainingJobRequest) Reset()

func (*GetTrainingJobRequest) String 

func (x *GetTrainingJobRequest) String() string

type GetTrainingJobResponse 

type GetTrainingJobResponse struct {
	Metadata *TrainingJobMetadata `protobuf:"bytes,1,opt,name=metadata,proto3" json:"metadata,omitempty"`
	// contains filtered or unexported fields
}

func (*GetTrainingJobResponse) Descriptor deprecated 

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

Deprecated: Use GetTrainingJobResponse.ProtoReflect.Descriptor instead.

func (*GetTrainingJobResponse) GetMetadata 

func (x *GetTrainingJobResponse) GetMetadata() *TrainingJobMetadata

func (*GetTrainingJobResponse) ProtoMessage 

func (*GetTrainingJobResponse) ProtoMessage()

func (*GetTrainingJobResponse) ProtoReflect 

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

func (*GetTrainingJobResponse) Reset 

func (x *GetTrainingJobResponse) Reset()

func (*GetTrainingJobResponse) String 

func (x *GetTrainingJobResponse) String() string

type ListTrainingJobsRequest added in v0.1.75 

type ListTrainingJobsRequest struct {
	OrganizationId string         `protobuf:"bytes,1,opt,name=organization_id,json=organizationId,proto3" json:"organization_id,omitempty"`
	Status         TrainingStatus `protobuf:"varint,2,opt,name=status,proto3,enum=viam.app.mltraining.v1.TrainingStatus" json:"status,omitempty"`
	// contains filtered or unexported fields
}

func (*ListTrainingJobsRequest) Descriptor deprecated added in v0.1.75 

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

Deprecated: Use ListTrainingJobsRequest.ProtoReflect.Descriptor instead.

func (*ListTrainingJobsRequest) GetOrganizationId added in v0.1.75 

func (x *ListTrainingJobsRequest) GetOrganizationId() string

func (*ListTrainingJobsRequest) GetStatus added in v0.1.75 

func (x *ListTrainingJobsRequest) GetStatus() TrainingStatus

func (*ListTrainingJobsRequest) ProtoMessage added in v0.1.75 

func (*ListTrainingJobsRequest) ProtoMessage()

func (*ListTrainingJobsRequest) ProtoReflect added in v0.1.75 

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

func (*ListTrainingJobsRequest) Reset added in v0.1.75 

func (x *ListTrainingJobsRequest) Reset()

func (*ListTrainingJobsRequest) String added in v0.1.75 

func (x *ListTrainingJobsRequest) String() string

type ListTrainingJobsResponse added in v0.1.75 

type ListTrainingJobsResponse struct {
	Jobs []*TrainingJobMetadata `protobuf:"bytes,1,rep,name=jobs,proto3" json:"jobs,omitempty"`
	// contains filtered or unexported fields
}

func (*ListTrainingJobsResponse) Descriptor deprecated added in v0.1.75 

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

Deprecated: Use ListTrainingJobsResponse.ProtoReflect.Descriptor instead.

func (*ListTrainingJobsResponse) GetJobs added in v0.1.75 

func (x *ListTrainingJobsResponse) GetJobs() []*TrainingJobMetadata

func (*ListTrainingJobsResponse) ProtoMessage added in v0.1.75 

func (*ListTrainingJobsResponse) ProtoMessage()

func (*ListTrainingJobsResponse) ProtoReflect added in v0.1.75 

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

func (*ListTrainingJobsResponse) Reset added in v0.1.75 

func (x *ListTrainingJobsResponse) Reset()

func (*ListTrainingJobsResponse) String added in v0.1.75 

func (x *ListTrainingJobsResponse) String() string

type MLTrainingServiceClient 

type MLTrainingServiceClient interface {
	SubmitTrainingJob(ctx context.Context, in *SubmitTrainingJobRequest, opts ...grpc.CallOption) (*SubmitTrainingJobResponse, error)
	GetTrainingJob(ctx context.Context, in *GetTrainingJobRequest, opts ...grpc.CallOption) (*GetTrainingJobResponse, error)
	ListTrainingJobs(ctx context.Context, in *ListTrainingJobsRequest, opts ...grpc.CallOption) (*ListTrainingJobsResponse, error)
	CancelTrainingJob(ctx context.Context, in *CancelTrainingJobRequest, opts ...grpc.CallOption) (*CancelTrainingJobResponse, error)
}

MLTrainingServiceClient is the client API for MLTrainingService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewMLTrainingServiceClient 

func NewMLTrainingServiceClient(cc grpc.ClientConnInterface) MLTrainingServiceClient

type MLTrainingServiceServer 

type MLTrainingServiceServer interface {
	SubmitTrainingJob(context.Context, *SubmitTrainingJobRequest) (*SubmitTrainingJobResponse, error)
	GetTrainingJob(context.Context, *GetTrainingJobRequest) (*GetTrainingJobResponse, error)
	ListTrainingJobs(context.Context, *ListTrainingJobsRequest) (*ListTrainingJobsResponse, error)
	CancelTrainingJob(context.Context, *CancelTrainingJobRequest) (*CancelTrainingJobResponse, error)
	// contains filtered or unexported methods
}

MLTrainingServiceServer is the server API for MLTrainingService service. All implementations must embed UnimplementedMLTrainingServiceServer for forward compatibility

type ModelType 

type ModelType int32
const (
	ModelType_MODEL_TYPE_UNSPECIFIED                 ModelType = 0
	ModelType_MODEL_TYPE_SINGLE_LABEL_CLASSIFICATION ModelType = 1
	ModelType_MODEL_TYPE_MULTI_LABEL_CLASSIFICATION  ModelType = 2
	ModelType_MODEL_TYPE_OBJECT_DETECTION            ModelType = 3
)

func (ModelType) Descriptor 

func (ModelType) Descriptor() protoreflect.EnumDescriptor

func (ModelType) Enum 

func (x ModelType) Enum() *ModelType

func (ModelType) EnumDescriptor deprecated 

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

Deprecated: Use ModelType.Descriptor instead.

func (ModelType) Number 

func (x ModelType) Number() protoreflect.EnumNumber

func (ModelType) String 

func (x ModelType) String() string

func (ModelType) Type 

func (ModelType) Type() protoreflect.EnumType

type SubmitTrainingJobRequest 

type SubmitTrainingJobRequest struct {
	Filter         *v1.Filter `protobuf:"bytes,1,opt,name=filter,proto3" json:"filter" bson:"filter"`
	OrganizationId string     `protobuf:"bytes,2,opt,name=organization_id,json=organizationId,proto3" json:"organization_id" bson:"organization_id"`
	ModelName      string     `protobuf:"bytes,3,opt,name=model_name,json=modelName,proto3" json:"model_name" bson:"model_name"`
	ModelVersion   string     `protobuf:"bytes,4,opt,name=model_version,json=modelVersion,proto3" json:"model_version" bson:"model_version"`
	ModelType      ModelType  `` /* 135-byte string literal not displayed */
	Tags           []string   `protobuf:"bytes,6,rep,name=tags,proto3" json:"tags" bson:"tags"`
	// contains filtered or unexported fields
}

func (*SubmitTrainingJobRequest) Descriptor deprecated 

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

Deprecated: Use SubmitTrainingJobRequest.ProtoReflect.Descriptor instead.

func (*SubmitTrainingJobRequest) GetFilter 

func (x *SubmitTrainingJobRequest) GetFilter() *v1.Filter

func (*SubmitTrainingJobRequest) GetModelName 

func (x *SubmitTrainingJobRequest) GetModelName() string

func (*SubmitTrainingJobRequest) GetModelType 

func (x *SubmitTrainingJobRequest) GetModelType() ModelType

func (*SubmitTrainingJobRequest) GetModelVersion 

func (x *SubmitTrainingJobRequest) GetModelVersion() string

func (*SubmitTrainingJobRequest) GetOrganizationId 

func (x *SubmitTrainingJobRequest) GetOrganizationId() string

func (*SubmitTrainingJobRequest) GetTags 

func (x *SubmitTrainingJobRequest) GetTags() []string

func (*SubmitTrainingJobRequest) ProtoMessage 

func (*SubmitTrainingJobRequest) ProtoMessage()

func (*SubmitTrainingJobRequest) ProtoReflect 

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

func (*SubmitTrainingJobRequest) Reset 

func (x *SubmitTrainingJobRequest) Reset()

func (*SubmitTrainingJobRequest) String 

func (x *SubmitTrainingJobRequest) String() string

type SubmitTrainingJobResponse 

type SubmitTrainingJobResponse struct {
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

func (*SubmitTrainingJobResponse) Descriptor deprecated 

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

Deprecated: Use SubmitTrainingJobResponse.ProtoReflect.Descriptor instead.

func (*SubmitTrainingJobResponse) GetId 

func (x *SubmitTrainingJobResponse) GetId() string

func (*SubmitTrainingJobResponse) ProtoMessage 

func (*SubmitTrainingJobResponse) ProtoMessage()

func (*SubmitTrainingJobResponse) ProtoReflect 

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

func (*SubmitTrainingJobResponse) Reset 

func (x *SubmitTrainingJobResponse) Reset()

func (*SubmitTrainingJobResponse) String 

func (x *SubmitTrainingJobResponse) String() string

type TrainingJobMetadata 

type TrainingJobMetadata struct {
	Request       *SubmitTrainingJobRequest `protobuf:"bytes,1,opt,name=request,proto3" json:"request" bson:"request"`
	Status        TrainingStatus            `protobuf:"varint,2,opt,name=status,proto3,enum=viam.app.mltraining.v1.TrainingStatus" json:"status" bson:"status"`
	CreatedOn     *timestamppb.Timestamp    `protobuf:"bytes,3,opt,name=created_on,json=createdOn,proto3" json:"created_on" bson:"created_on"`
	LastModified  *timestamppb.Timestamp    `protobuf:"bytes,4,opt,name=last_modified,json=lastModified,proto3" json:"last_modified" bson:"last_modified"`
	SyncedModelId string                    `protobuf:"bytes,5,opt,name=synced_model_id,json=syncedModelId,proto3" json:"synced_model_id" bson:"synced_model_id"`
	Id            string                    `protobuf:"bytes,7,opt,name=id,proto3" json:"id,omitempty" bson:"_id"`
	ErrorStatus   *status.Status            `protobuf:"bytes,8,opt,name=error_status,json=errorStatus,proto3" json:"error_status" bson:"error_status"`
	// contains filtered or unexported fields
}

func (*TrainingJobMetadata) Descriptor deprecated 

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

Deprecated: Use TrainingJobMetadata.ProtoReflect.Descriptor instead.

func (*TrainingJobMetadata) GetCreatedOn 

func (x *TrainingJobMetadata) GetCreatedOn() *timestamppb.Timestamp

func (*TrainingJobMetadata) GetErrorStatus added in v0.1.130 

func (x *TrainingJobMetadata) GetErrorStatus() *status.Status

func (*TrainingJobMetadata) GetId added in v0.1.75 

func (x *TrainingJobMetadata) GetId() string

func (*TrainingJobMetadata) GetLastModified 

func (x *TrainingJobMetadata) GetLastModified() *timestamppb.Timestamp

func (*TrainingJobMetadata) GetRequest 

func (x *TrainingJobMetadata) GetRequest() *SubmitTrainingJobRequest

func (*TrainingJobMetadata) GetStatus 

func (x *TrainingJobMetadata) GetStatus() TrainingStatus

func (*TrainingJobMetadata) GetSyncedModelId 

func (x *TrainingJobMetadata) GetSyncedModelId() string

func (*TrainingJobMetadata) ProtoMessage 

func (*TrainingJobMetadata) ProtoMessage()

func (*TrainingJobMetadata) ProtoReflect 

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

func (*TrainingJobMetadata) Reset 

func (x *TrainingJobMetadata) Reset()

func (*TrainingJobMetadata) String 

func (x *TrainingJobMetadata) String() string

type TrainingStatus 

type TrainingStatus int32
const (
	TrainingStatus_TRAINING_STATUS_UNSPECIFIED TrainingStatus = 0
	TrainingStatus_TRAINING_STATUS_PENDING     TrainingStatus = 1
	TrainingStatus_TRAINING_STATUS_IN_PROGRESS TrainingStatus = 2
	TrainingStatus_TRAINING_STATUS_COMPLETED   TrainingStatus = 3
	TrainingStatus_TRAINING_STATUS_FAILED      TrainingStatus = 4
	TrainingStatus_TRAINING_STATUS_CANCELED    TrainingStatus = 5
	TrainingStatus_TRAINING_STATUS_CANCELING   TrainingStatus = 6
)

func (TrainingStatus) Descriptor 

func (TrainingStatus) Descriptor() protoreflect.EnumDescriptor

func (TrainingStatus) Enum 

func (x TrainingStatus) Enum() *TrainingStatus

func (TrainingStatus) EnumDescriptor deprecated 

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

Deprecated: Use TrainingStatus.Descriptor instead.

func (TrainingStatus) Number 

func (x TrainingStatus) Number() protoreflect.EnumNumber

func (TrainingStatus) String 

func (x TrainingStatus) String() string

func (TrainingStatus) Type 

func (TrainingStatus) Type() protoreflect.EnumType

type UnimplementedMLTrainingServiceServer 

type UnimplementedMLTrainingServiceServer struct {
}

UnimplementedMLTrainingServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedMLTrainingServiceServer) CancelTrainingJob added in v0.1.86 

func (UnimplementedMLTrainingServiceServer) CancelTrainingJob(context.Context, *CancelTrainingJobRequest) (*CancelTrainingJobResponse, error)

func (UnimplementedMLTrainingServiceServer) GetTrainingJob 

func (UnimplementedMLTrainingServiceServer) GetTrainingJob(context.Context, *GetTrainingJobRequest) (*GetTrainingJobResponse, error)

func (UnimplementedMLTrainingServiceServer) ListTrainingJobs added in v0.1.75 

func (UnimplementedMLTrainingServiceServer) ListTrainingJobs(context.Context, *ListTrainingJobsRequest) (*ListTrainingJobsResponse, error)

func (UnimplementedMLTrainingServiceServer) SubmitTrainingJob 

func (UnimplementedMLTrainingServiceServer) SubmitTrainingJob(context.Context, *SubmitTrainingJobRequest) (*SubmitTrainingJobResponse, error)

type UnsafeMLTrainingServiceServer 

type UnsafeMLTrainingServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeMLTrainingServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to MLTrainingServiceServer will result in compilation errors.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.