operations

Documentation

Index

• type DlframeworkAPI
  • func NewDlframeworkAPI(spec *loads.Document) *DlframeworkAPI
  • func (o *DlframeworkAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator
  • func (o *DlframeworkAPI) Authorizer() runtime.Authorizer
  • func (o *DlframeworkAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer
  • func (o *DlframeworkAPI) Context() *middleware.Context
  • func (o *DlframeworkAPI) DefaultConsumes() string
  • func (o *DlframeworkAPI) DefaultProduces() string
  • func (o *DlframeworkAPI) Formats() strfmt.Registry
  • func (o *DlframeworkAPI) HandlerFor(method, path string) (http.Handler, bool)
  • func (o *DlframeworkAPI) Init()
  • func (o *DlframeworkAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer
  • func (o *DlframeworkAPI) RegisterConsumer(mediaType string, consumer runtime.Consumer)
  • func (o *DlframeworkAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)
  • func (o *DlframeworkAPI) RegisterProducer(mediaType string, producer runtime.Producer)
  • func (o *DlframeworkAPI) Serve(builder middleware.Builder) http.Handler
  • func (o *DlframeworkAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)
  • func (o *DlframeworkAPI) SetDefaultConsumes(mediaType string)
  • func (o *DlframeworkAPI) SetDefaultProduces(mediaType string)
  • func (o *DlframeworkAPI) SetSpec(spec *loads.Document)
  • func (o *DlframeworkAPI) Validate() error

Types

type DlframeworkAPI

type DlframeworkAPI struct {
	Middleware func(middleware.Builder) http.Handler

	// BasicAuthenticator generates a runtime.Authenticator from the supplied basic auth function.
	// It has a default implementation in the security package, however you can replace it for your particular usage.
	BasicAuthenticator func(security.UserPassAuthentication) runtime.Authenticator
	// APIKeyAuthenticator generates a runtime.Authenticator from the supplied token auth function.
	// It has a default implementation in the security package, however you can replace it for your particular usage.
	APIKeyAuthenticator func(string, string, security.TokenAuthentication) runtime.Authenticator
	// BearerAuthenticator generates a runtime.Authenticator from the supplied bearer token auth function.
	// It has a default implementation in the security package, however you can replace it for your particular usage.
	BearerAuthenticator func(string, security.ScopedTokenAuthentication) runtime.Authenticator

	// JSONConsumer registers a consumer for a "application/json" mime type
	JSONConsumer runtime.Consumer

	// JSONProducer registers a producer for a "application/json" mime type
	JSONProducer runtime.Producer

	// BasicAuthAuth registers a function that takes username and password and returns a principal
	// it performs authentication with basic auth
	BasicAuthAuth func(string, string) (*models.User, error)

	// APIAuthorizer provides access control (ACL/RBAC/ABAC) by providing access to the request and authenticated principal
	APIAuthorizer runtime.Authorizer

	// PredictCloseHandler sets the operation handler for the close operation
	PredictCloseHandler predict.CloseHandler
	// PredictDatasetHandler sets the operation handler for the dataset operation
	PredictDatasetHandler predict.DatasetHandler
	// RegistryFrameworkAgentsHandler sets the operation handler for the framework agents operation
	RegistryFrameworkAgentsHandler registry.FrameworkAgentsHandler
	// RegistryFrameworkManifestsHandler sets the operation handler for the framework manifests operation
	RegistryFrameworkManifestsHandler registry.FrameworkManifestsHandler
	// PredictImagesHandler sets the operation handler for the images operation
	PredictImagesHandler predict.ImagesHandler
	// AuthenticationLoginHandler sets the operation handler for the login operation
	AuthenticationLoginHandler authentication.LoginHandler
	// AuthenticationLogoutHandler sets the operation handler for the logout operation
	AuthenticationLogoutHandler authentication.LogoutHandler
	// RegistryModelAgentsHandler sets the operation handler for the model agents operation
	RegistryModelAgentsHandler registry.ModelAgentsHandler
	// RegistryModelManifestsHandler sets the operation handler for the model manifests operation
	RegistryModelManifestsHandler registry.ModelManifestsHandler
	// PredictOpenHandler sets the operation handler for the open operation
	PredictOpenHandler predict.OpenHandler
	// PredictResetHandler sets the operation handler for the reset operation
	PredictResetHandler predict.ResetHandler
	// AuthenticationSignupHandler sets the operation handler for the signup operation
	AuthenticationSignupHandler authentication.SignupHandler
	// PredictURLsHandler sets the operation handler for the u r ls operation
	PredictURLsHandler predict.URLsHandler
	// AuthenticationUpdateHandler sets the operation handler for the update operation
	AuthenticationUpdateHandler authentication.UpdateHandler
	// AuthenticationUserInfoHandler sets the operation handler for the user info operation
	AuthenticationUserInfoHandler authentication.UserInfoHandler

	// ServeError is called when an error is received, there is a default handler
	// but you can set your own with this
	ServeError func(http.ResponseWriter, *http.Request, error)

	// ServerShutdown is called when the HTTP(S) server is shut down and done
	// handling all active connections and does not accept connections any more
	ServerShutdown func()

	// Custom command line argument groups with their descriptions
	CommandLineOptionsGroups []swag.CommandLineOptionsGroup

	// User defined logger function.
	Logger func(string, ...interface{})
	// contains filtered or unexported fields
}

DlframeworkAPI MLModelScope is a hardware/software agnostic platform to facilitate the evaluation, measurement, and introspection of ML models within AI pipelines. MLModelScope aids application developers in discovering and experimenting with models, data scientists developers in replicating and evaluating for publishing models, and system architects in understanding the performance of AI workloads.

func NewDlframeworkAPI

func NewDlframeworkAPI(spec *loads.Document) *DlframeworkAPI

NewDlframeworkAPI creates a new Dlframework instance

func (*DlframeworkAPI) AuthenticatorsFor

func (o *DlframeworkAPI) AuthenticatorsFor(schemes map[string]spec.SecurityScheme) map[string]runtime.Authenticator

AuthenticatorsFor gets the authenticators for the specified security schemes

func (*DlframeworkAPI) Authorizer

func (o *DlframeworkAPI) Authorizer() runtime.Authorizer

Authorizer returns the registered authorizer

func (*DlframeworkAPI) ConsumersFor

func (o *DlframeworkAPI) ConsumersFor(mediaTypes []string) map[string]runtime.Consumer

ConsumersFor gets the consumers for the specified media types

func (*DlframeworkAPI) Context

func (o *DlframeworkAPI) Context() *middleware.Context

Context returns the middleware context for the dlframework API

func (*DlframeworkAPI) DefaultConsumes

func (o *DlframeworkAPI) DefaultConsumes() string

DefaultConsumes returns the default consumes media type

func (*DlframeworkAPI) DefaultProduces

func (o *DlframeworkAPI) DefaultProduces() string

DefaultProduces returns the default produces media type

func (*DlframeworkAPI) Formats

func (o *DlframeworkAPI) Formats() strfmt.Registry

Formats returns the registered string formats

func (*DlframeworkAPI) HandlerFor

func (o *DlframeworkAPI) HandlerFor(method, path string) (http.Handler, bool)

HandlerFor gets a http.Handler for the provided operation method and path

func (*DlframeworkAPI) Init

func (o *DlframeworkAPI) Init()

Init allows you to just initialize the handler cache, you can then recompose the middleware as you see fit

func (*DlframeworkAPI) ProducersFor

func (o *DlframeworkAPI) ProducersFor(mediaTypes []string) map[string]runtime.Producer

ProducersFor gets the producers for the specified media types

func (*DlframeworkAPI) RegisterConsumer

func (o *DlframeworkAPI) RegisterConsumer(mediaType string, consumer runtime.Consumer)

RegisterConsumer allows you to add (or override) a consumer for a media type.

func (*DlframeworkAPI) RegisterFormat

func (o *DlframeworkAPI) RegisterFormat(name string, format strfmt.Format, validator strfmt.Validator)

RegisterFormat registers a custom format validator

func (*DlframeworkAPI) RegisterProducer

func (o *DlframeworkAPI) RegisterProducer(mediaType string, producer runtime.Producer)

RegisterProducer allows you to add (or override) a producer for a media type.

func (*DlframeworkAPI) Serve

func (o *DlframeworkAPI) Serve(builder middleware.Builder) http.Handler

Serve creates a http handler to serve the API over HTTP can be used directly in http.ListenAndServe(":8000", api.Serve(nil))

func (*DlframeworkAPI) ServeErrorFor

func (o *DlframeworkAPI) ServeErrorFor(operationID string) func(http.ResponseWriter, *http.Request, error)

ServeErrorFor gets a error handler for a given operation id

func (*DlframeworkAPI) SetDefaultConsumes

func (o *DlframeworkAPI) SetDefaultConsumes(mediaType string)

SetDefaultConsumes returns the default consumes media type

func (*DlframeworkAPI) SetDefaultProduces

func (o *DlframeworkAPI) SetDefaultProduces(mediaType string)

SetDefaultProduces sets the default produces media type

func (*DlframeworkAPI) SetSpec

func (o *DlframeworkAPI) SetSpec(spec *loads.Document)

SetSpec sets a spec that will be served for the clients.

func (*DlframeworkAPI) Validate

func (o *DlframeworkAPI) Validate() error

Validate validates the registrations in the DlframeworkAPI