valueobject

Documentation

Index

• func GetKFServingDeploymentParametersJson(userParametersJson string, kubeflowConfig KubeflowConfig) (string, error)
• type AlgorithmConfig
  • func (c *AlgorithmConfig) Scan(v interface{}) error
  • func (c AlgorithmConfig) Value() (driver.Value, error)
• type IDEncryptionType
• type IDMetaInfo
  • func (i *IDMetaInfo) Scan(v interface{}) error
  • func (i IDMetaInfo) Value() (driver.Value, error)
• type IDType
• type KFServingParameter
• type KFServingWithMinIOParameter
• type KubeflowConfig
  • func (c *KubeflowConfig) Scan(v interface{}) error
  • func (c *KubeflowConfig) Validate() error
  • func (c KubeflowConfig) Value() (driver.Value, error)
• type MinIOStorageMParameters
• type ModelEvaluation
  • func (i *ModelEvaluation) Scan(v interface{}) error
  • func (i ModelEvaluation) Value() (driver.Value, error)
• type ProjectCreatorInfo
• type UserPermissionInfo

Functions

func GetKFServingDeploymentParametersJson

func GetKFServingDeploymentParametersJson(userParametersJson string, kubeflowConfig KubeflowConfig) (string, error)

GetKFServingDeploymentParametersJson returns a deployment parameter json

Types

type AlgorithmConfig

type AlgorithmConfig struct {
	TrainingValidationEnabled     bool     `json:"training_validation_enabled"`
	TrainingValidationSizePercent uint     `json:"training_validation_percent"`
	TrainingComponentsToDeploy    []string `json:"training_component_list_to_deploy"`
}

AlgorithmConfig contains some configurations for running a training job

func (*AlgorithmConfig) Scan

func (c *AlgorithmConfig) Scan(v interface{}) error

func (AlgorithmConfig) Value

func (c AlgorithmConfig) Value() (driver.Value, error)

type IDEncryptionType

type IDEncryptionType uint8

IDEncryptionType is the encryption type of the ID field

const (
	IDEncryptionTypeNone IDEncryptionType = iota
	IDEncryptionTypeMD5
	IDEncryptionTypeSHA256
)

type IDMetaInfo

type IDMetaInfo struct {
	IDType           IDType           `json:"id_type"`
	IDEncryptionType IDEncryptionType `json:"id_encryption_type"`
}

IDMetaInfo records the metadata describing certain data

func (*IDMetaInfo) Scan

func (i *IDMetaInfo) Scan(v interface{}) error

func (IDMetaInfo) Value

func (i IDMetaInfo) Value() (driver.Value, error)

type IDType

type IDType uint8

IDType is the type of the ID

const (
	IDTypeOther IDType = iota
	IDTypeCellPhone
	IDTypeDeviceIMEI
	IDTypeDeviceIDFA
	IDTypeDeviceIDFV
)

type KFServingParameter

type KFServingParameter struct {
	ProtocolVersion         string `json:"protocol_version"`
	KubeconfigContent       string `json:"config_file_content"`
	Namespace               string `json:"namespace"`
	Replace                 bool   `json:"replace"`
	SKipCreateStorageSecret bool   `json:"skip_create_storage_secret"`
	ModelStorageType        string `json:"model_storage_type"`
}

KFServingParameter is the parameters used for deploying to KFServing

type KFServingWithMinIOParameter

type KFServingWithMinIOParameter struct {
	KFServingParameter
	ModelStorageParameters MinIOStorageMParameters `json:"model_storage_parameters"`
}

KFServingWithMinIOParameter is the parameters used for deploying to KFServing

type KubeflowConfig

type KubeflowConfig struct {
	// MinIOEndpoint is the address for the MinIO server
	MinIOEndpoint string `json:"minio_endpoint"`
	// MinIOAccessKey is the access-key for the MinIO server
	MinIOAccessKey string `json:"minio_access_key"`
	// MinIOSecretKey is the secret-key for the MinIO server
	MinIOSecretKey string `json:"minio_secret_key"`
	// MinIOSSLEnabled is whether this connection should be over ssl
	MinIOSSLEnabled bool `json:"minio_ssl_enabled"`
	// MinIORegion is the region of the MinIO service
	MinIORegion string `json:"minio_region"`
	// KubeConfig is the content of the kubeconfig file to connect to kubernetes
	KubeConfig string `json:"kubeconfig"`
}

KubeflowConfig contains necessary information needed to deploy model to Kubeflow

func (*KubeflowConfig) Scan

func (c *KubeflowConfig) Scan(v interface{}) error

func (*KubeflowConfig) Validate

func (c *KubeflowConfig) Validate() error

Validate checks the connection to the kubernetes, the installation of KFServing and the connection to MinIO

func (KubeflowConfig) Value

func (c KubeflowConfig) Value() (driver.Value, error)

type MinIOStorageMParameters

type MinIOStorageMParameters struct {
	Endpoint  string `json:"endpoint"`
	AccessKey string `json:"access_key"`
	SecretKey string `json:"secret_key"`
	Secure    bool   `json:"secure"`
	Region    string `json:"region"`
}

MinIOStorageMParameters is the parameters for the minio storage

type ModelEvaluation

type ModelEvaluation map[string]string

ModelEvaluation is a key-value pair of the model evaluation metrics

func (*ModelEvaluation) Scan

func (i *ModelEvaluation) Scan(v interface{}) error

func (ModelEvaluation) Value

func (i ModelEvaluation) Value() (driver.Value, error)

type ProjectCreatorInfo

type ProjectCreatorInfo struct {
	Manager             string `json:"manager" gorm:"type:varchar(255)"`
	ManagingSiteName    string `json:"managing_site_name" gorm:"type:varchar(255)"`
	ManagingSitePartyID uint   `json:"managing_site_party_id"`
	ManagingSiteUUID    string `json:"managing_site_uuid" gorm:"type:varchar(36)"`
}

ProjectCreatorInfo contains info of the site managing/creating the project

type UserPermissionInfo

type UserPermissionInfo struct {
	// SitePortalAccess controls whether the user can access site portal
	SitePortalAccess bool `json:"site_portal_access"`
	// FATEBoardAccess controls whether the user can access fate board
	FATEBoardAccess bool `json:"fateboard_access" gorm:"column:fateboard_access"`
	// NoteBookAccess controls whether the user can access notebook
	NotebookAccess bool `json:"notebook_access"`
}

UserPermissionInfo holds information about user's permissions