constants

Documentation

Index

• Constants
• Variables
• func CanaryExplainerServiceName(name string) string
• func CanaryPredictorServiceName(name string) string
• func CanaryPredictorServiceURL(name string, namespace string, domain string) string
• func CanaryServiceName(name string, component InferenceServiceComponent) string
• func CanaryTransformerServiceName(name string) string
• func DefaultExplainerServiceName(name string) string
• func DefaultPredictorServiceName(name string) string
• func DefaultPredictorServiceURL(name string, namespace string, domain string) string
• func DefaultServiceName(name string, component InferenceServiceComponent) string
• func DefaultTransformerServiceName(name string) string
• func ExplainPrefix(name string) string
• func GetLoggerDefaultUrl(namespace string) string
• func HostRegExp(host string) string
• func InferenceServiceHostName(name string, namespace string, domain string) string
• func InferenceServicePrefix(name string) string
• func InferenceServiceURL(scheme, name, namespace, domain string) string
• func PredictPrefix(name string) string
• func PredictorURL(metadata v1.ObjectMeta, isCanary bool) string
• func TransformerURL(metadata v1.ObjectMeta, isCanary bool) string
• type InferenceServiceComponent
  • func (e InferenceServiceComponent) String() string
• type InferenceServiceVerb
  • func (v InferenceServiceVerb) String() string

Constants

const (
	KnativeLocalGateway   = "knative-serving/cluster-local-gateway"
	KnativeIngressGateway = "knative-serving/knative-ingress-gateway"
)

const (
	InferenceServiceDefaultHttpPort   = "8080"
	InferenceServiceDefaultLoggerPort = "8081"
	CommonDefaultHttpPort             = 80
)

InferenceService Endpoint Ports

const (
	KServiceComponentLabel = "component"
	KServiceModelLabel     = "model"
	KServiceEndpointLabel  = "endpoint"
)

Labels to put on kservice

const (
	InferenceServiceDefault = "default"
	InferenceServiceCanary  = "canary"
)

InferenceService default/canary constants

const (
	ArgumentModelName      = "--model_name"
	ArgumentModelDir       = "--model_dir"
	ArgumentModelClassName = "--model_class_name"
	ArgumentPredictorHost  = "--predictor_host"
	ArgumentHttpPort       = "--http_port"
	ArgumentWorkers        = "--workers"
)

InferenceService model server args

const (
	CustomSpecStorageUriEnvVarKey = "STORAGE_URI"
)

InferenceService Environment Variables

const DefaultModelLocalMountPath = "/mnt/models"

DefaultModelLocalMountPath is where models will be mounted by the storage-initializer

const (
	InferenceServiceContainerName = "kfserving-container"
)

InferenceService container name

const (
	NvidiaGPUResourceType = "nvidia.com/gpu"
)

GPU Constants

Variables

var (
	KFServingName           = "kfserving"
	KFServingAPIGroupName   = "serving.kubeflow.org"
	KFServingNamespace      = getEnvOrDefault("POD_NAMESPACE", "kfserving-system")
	KFServingDefaultVersion = "v0.3.0"
)

KFServing Constants

var (
	InferenceServiceName          = "inferenceservice"
	InferenceServiceAPIName       = "inferenceservices"
	InferenceServicePodLabelKey   = KFServingAPIGroupName + "/" + InferenceServiceName
	InferenceServiceConfigMapName = "inferenceservice-config"
)

InferenceService Constants

var (
	InferenceServiceInternalAnnotationsPrefix        = "internal." + KFServingAPIGroupName
	StorageInitializerSourceUriInternalAnnotationKey = InferenceServiceInternalAnnotationsPrefix + "/storage-initializer-sourceuri"
	LoggerInternalAnnotationKey                      = InferenceServiceInternalAnnotationsPrefix + "/logger"
	LoggerSinkUrlInternalAnnotationKey               = InferenceServiceInternalAnnotationsPrefix + "/logger-sink-url"
	LoggerModeInternalAnnotationKey                  = InferenceServiceInternalAnnotationsPrefix + "/logger-mode"
)

InferenceService Internal Annotations

var (
	ControllerLabelName             = KFServingName + "-controller-manager"
	DefaultPredictorTimeout   int64 = 60
	DefaultTransformerTimeout int64 = 120
	DefaultExplainerTimeout   int64 = 300
	DefaultScalingTarget            = "1"
	DefaultMinReplicas              = 1
)

Controller Constants

var (
	EnableKFServingMutatingWebhook         = "enabled"
	EnableWebhookNamespaceSelectorEnvName  = "ENABLE_WEBHOOK_NAMESPACE_SELECTOR"
	EnableWebhookNamespaceSelectorEnvValue = "enabled"
	IsEnableWebhookNamespaceSelector       = isEnvVarMatched(EnableWebhookNamespaceSelectorEnvName, EnableWebhookNamespaceSelectorEnvValue)
	PodMutatorWebhookName                  = KFServingName + "-pod-mutator-webhook"
)

Webhook Constants

var (
	InferenceServiceGKEAcceleratorAnnotationKey = KFServingAPIGroupName + "/gke-accelerator"
)

InferenceService Annotations

var (
	LocalGatewayHost = "cluster-local-gateway.istio-system.svc." + network.GetClusterDomainName()
)

Functions

func CanaryExplainerServiceName

func CanaryExplainerServiceName(name string) string

func CanaryPredictorServiceName

func CanaryPredictorServiceName(name string) string

func CanaryPredictorServiceURL

func CanaryPredictorServiceURL(name string, namespace string, domain string) string

func CanaryServiceName

func CanaryServiceName(name string, component InferenceServiceComponent) string

func CanaryTransformerServiceName

func CanaryTransformerServiceName(name string) string

func DefaultExplainerServiceName

func DefaultExplainerServiceName(name string) string

func DefaultPredictorServiceName

func DefaultPredictorServiceName(name string) string

func DefaultPredictorServiceURL

func DefaultPredictorServiceURL(name string, namespace string, domain string) string

func DefaultServiceName

func DefaultServiceName(name string, component InferenceServiceComponent) string

func DefaultTransformerServiceName

func DefaultTransformerServiceName(name string) string

func ExplainPrefix

func ExplainPrefix(name string) string

func GetLoggerDefaultUrl

func GetLoggerDefaultUrl(namespace string) string

func HostRegExp

func HostRegExp(host string) string

hostRegExp returns an ECMAScript regular expression to match either host or host:<any port> for clusterLocalHost, we will also match the prefixes.

func InferenceServiceHostName

func InferenceServiceHostName(name string, namespace string, domain string) string

func InferenceServicePrefix

func InferenceServicePrefix(name string) string

func InferenceServiceURL

func InferenceServiceURL(scheme, name, namespace, domain string) string

func PredictPrefix

func PredictPrefix(name string) string

func PredictorURL

func PredictorURL(metadata v1.ObjectMeta, isCanary bool) string

func TransformerURL

func TransformerURL(metadata v1.ObjectMeta, isCanary bool) string

Types

type InferenceServiceComponent

type InferenceServiceComponent string

const (
	Predictor   InferenceServiceComponent = "predictor"
	Explainer   InferenceServiceComponent = "explainer"
	Transformer InferenceServiceComponent = "transformer"
)

InferenceService Component enums

func (InferenceServiceComponent) String

func (e InferenceServiceComponent) String() string

type InferenceServiceVerb

type InferenceServiceVerb string

const (
	Predict InferenceServiceVerb = "predict"
	Explain InferenceServiceVerb = "explain"
)

InferenceService verb enums

func (InferenceServiceVerb) String

func (v InferenceServiceVerb) String() string