Documentation
¶
Overview ¶
Package v1alpha1 contains API Schema definitions for the serving v1alpha1 API group +k8s:openapi-gen=true +k8s:deepcopy-gen=package,register +k8s:conversion-gen=kfserving/pkg/apis/serving +k8s:defaulter-gen=TypeMeta +groupName=serving.kubeflow.org
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( // APIVersion is the current API version used to register these objects APIVersion = "v1alpha1" // SchemeGroupVersion is group version used to register these objects SchemeGroupVersion = schema.GroupVersion{Group: constants.KFServingAPIGroupName, Version: APIVersion} // SchemeBuilder is used to add go types to the GroupVersionKind scheme SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion} // AddToScheme is required by pkg/client/... AddToScheme = SchemeBuilder.AddToScheme )
Functions ¶
func Resource ¶
func Resource(resource string) schema.GroupResource
Resource is required by pkg/client/listers/...
Types ¶
type ModelSpec ¶
type ModelSpec struct {
// Storage URI for the model repository
StorageURI string `json:"storageUri"`
// Machine Learning <framework name>
// The values could be: "tensorflow","pytorch","sklearn","onnx","xgboost", "myawesomeinternalframework" etc.
Framework string `json:"framework"`
// Maximum memory this model will consume, this field is used to decide if a model server has enough memory to load this model.
// +optional
Memory resource.Quantity `json:"memory,omitempty"`
}
ModelSpec describes a TrainedModel +k8s:openapi-gen=true
func (*ModelSpec) DeepCopy ¶
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ModelSpec.
func (*ModelSpec) DeepCopyInto ¶
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TrainedModel ¶ added in v0.5.0
type TrainedModel struct {
metav1.TypeMeta `json:",inline"`
metav1.ObjectMeta `json:"metadata,omitempty"`
Spec TrainedModelSpec `json:"spec,omitempty"`
Status TrainedModelStatus `json:"status,omitempty"`
}
TrainedModel is the Schema for the TrainedModel API +k8s:openapi-gen=true +kubebuilder:object:root=true +kubebuilder:subresource:status +kubebuilder:printcolumn:name="URL",type="string",JSONPath=".status.url" +kubebuilder:printcolumn:name="Ready",type="string",JSONPath=".status.conditions[?(@.type=='Ready')].status" +kubebuilder:printcolumn:name="Age",type="date",JSONPath=".metadata.creationTimestamp" +kubebuilder:resource:path=trainedmodels,shortName=tm,singular=trainedmodel
func (*TrainedModel) DeepCopy ¶ added in v0.5.0
func (in *TrainedModel) DeepCopy() *TrainedModel
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TrainedModel.
func (*TrainedModel) DeepCopyInto ¶ added in v0.5.0
func (in *TrainedModel) DeepCopyInto(out *TrainedModel)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*TrainedModel) DeepCopyObject ¶ added in v0.5.0
func (in *TrainedModel) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type TrainedModelList ¶ added in v0.5.0
type TrainedModelList struct {
metav1.TypeMeta `json:",inline"`
metav1.ListMeta `json:"metadata,omitempty"`
// +listType=set
Items []TrainedModel `json:"items"`
}
TrainedModelList contains a list of TrainedModel +k8s:openapi-gen=true +kubebuilder:object:root=true
func (*TrainedModelList) DeepCopy ¶ added in v0.5.0
func (in *TrainedModelList) DeepCopy() *TrainedModelList
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TrainedModelList.
func (*TrainedModelList) DeepCopyInto ¶ added in v0.5.0
func (in *TrainedModelList) DeepCopyInto(out *TrainedModelList)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
func (*TrainedModelList) DeepCopyObject ¶ added in v0.5.0
func (in *TrainedModelList) DeepCopyObject() runtime.Object
DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.
type TrainedModelSpec ¶ added in v0.5.0
type TrainedModelSpec struct {
// parent inference service to deploy to
// +required
InferenceService string `json:"inferenceService"`
// Predictor model spec
// +required
Model ModelSpec `json:"model"`
}
TrainedModelSpec defines the TrainedModel spec +k8s:openapi-gen=true
func (*TrainedModelSpec) DeepCopy ¶ added in v0.5.0
func (in *TrainedModelSpec) DeepCopy() *TrainedModelSpec
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TrainedModelSpec.
func (*TrainedModelSpec) DeepCopyInto ¶ added in v0.5.0
func (in *TrainedModelSpec) DeepCopyInto(out *TrainedModelSpec)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
type TrainedModelStatus ¶ added in v0.5.0
type TrainedModelStatus struct {
// Conditions for trained model
duckv1.Status `json:",inline"`
// URL holds the url that will distribute traffic over the provided traffic targets.
// For v1: http[s]://{route-name}.{route-namespace}.{cluster-level-suffix}/v1/models/<trainedmodel>:predict
// For v2: http[s]://{route-name}.{route-namespace}.{cluster-level-suffix}/v2/models/<trainedmodel>/infer
URL *apis.URL `json:"url,omitempty"`
// Addressable endpoint for the deployed trained model
// http://<inferenceservice.metadata.name>/v1/models/<trainedmodel>.metadata.name
Address *duckv1.Addressable `json:"address,omitempty"`
}
TrainedModelStatus defines the observed state of TrainedModel
func (*TrainedModelStatus) DeepCopy ¶ added in v0.5.0
func (in *TrainedModelStatus) DeepCopy() *TrainedModelStatus
DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TrainedModelStatus.
func (*TrainedModelStatus) DeepCopyInto ¶ added in v0.5.0
func (in *TrainedModelStatus) DeepCopyInto(out *TrainedModelStatus)
DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.
Source Files