partial

package

v1.0.5 Latest Latest Go to latest Published: Nov 24, 2025 License: Apache-2.0, Apache-2.0 Imports: 9 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/docker/model-runner

Links

Open Source Insights

Documentation ¶

Index ¶

func ChatTemplatePath(i WithLayers) (string, error)
func Config(i WithRawConfigFile) (types.Config, error)
func ConfigArchivePath(i WithLayers) (string, error)
func ConfigFile(i WithRawConfigFile) (*types.ConfigFile, error)
func Descriptor(i WithRawConfigFile) (types.Descriptor, error)
func GGUFPaths(i WithLayers) ([]string, error)
func ID(i WithRawManifest) (string, error)
func MMPROJPath(i WithLayers) (string, error)
func ManifestForLayers(i WithLayers) (*v1.Manifest, error)
func SafetensorsPaths(i WithLayers) ([]string, error)
type BaseModel
type Layer
- func NewLayer(path string, mt ggcrtypes.MediaType) (*Layer, error)
type WithLayers
type WithRawConfigFile
type WithRawManifest

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func ChatTemplatePath ¶

func ChatTemplatePath(i WithLayers) (string, error)

func Config ¶

func Config(i WithRawConfigFile) (types.Config, error)

Config returns the types.Config for the model.

func ConfigArchivePath ¶

func ConfigArchivePath(i WithLayers) (string, error)

func ConfigFile ¶

func ConfigFile(i WithRawConfigFile) (*types.ConfigFile, error)

func Descriptor ¶

func Descriptor(i WithRawConfigFile) (types.Descriptor, error)

Descriptor returns the types.Descriptor for the model.

func GGUFPaths ¶

func GGUFPaths(i WithLayers) ([]string, error)

func ID ¶

func ID(i WithRawManifest) (string, error)

func MMPROJPath ¶

func MMPROJPath(i WithLayers) (string, error)

func ManifestForLayers ¶

func ManifestForLayers(i WithLayers) (*v1.Manifest, error)

func SafetensorsPaths ¶

func SafetensorsPaths(i WithLayers) ([]string, error)

Types ¶

type BaseModel ¶ added in v1.0.3

type BaseModel struct {
	ModelConfigFile types.ConfigFile
	LayerList       []v1.Layer
}

BaseModel provides a common implementation for model types. It can be embedded by specific model format implementations (GGUF, Safetensors, etc.)

func (*BaseModel) Config ¶ added in v1.0.3

func (m *BaseModel) Config() (types.Config, error)

func (*BaseModel) ConfigFile ¶ added in v1.0.3

func (m *BaseModel) ConfigFile() (*v1.ConfigFile, error)

func (*BaseModel) ConfigName ¶ added in v1.0.3

func (m *BaseModel) ConfigName() (v1.Hash, error)

func (*BaseModel) Descriptor ¶ added in v1.0.3

func (m *BaseModel) Descriptor() (types.Descriptor, error)

func (*BaseModel) Digest ¶ added in v1.0.3

func (m *BaseModel) Digest() (v1.Hash, error)

func (*BaseModel) ID ¶ added in v1.0.3

func (m *BaseModel) ID() (string, error)

func (*BaseModel) LayerByDiffID ¶ added in v1.0.3

func (m *BaseModel) LayerByDiffID(hash v1.Hash) (v1.Layer, error)

func (*BaseModel) LayerByDigest ¶ added in v1.0.3

func (m *BaseModel) LayerByDigest(hash v1.Hash) (v1.Layer, error)

func (*BaseModel) Layers ¶ added in v1.0.3

func (m *BaseModel) Layers() ([]v1.Layer, error)

func (*BaseModel) Manifest ¶ added in v1.0.3

func (m *BaseModel) Manifest() (*v1.Manifest, error)

func (*BaseModel) MediaType ¶ added in v1.0.3

func (m *BaseModel) MediaType() (ggcr.MediaType, error)

func (*BaseModel) RawConfigFile ¶ added in v1.0.3

func (m *BaseModel) RawConfigFile() ([]byte, error)

func (*BaseModel) RawManifest ¶ added in v1.0.3

func (m *BaseModel) RawManifest() ([]byte, error)

func (*BaseModel) Size ¶ added in v1.0.3

func (m *BaseModel) Size() (int64, error)

type Layer ¶

type Layer struct {
	Path string
	v1.Descriptor
}

func NewLayer ¶

func NewLayer(path string, mt ggcrtypes.MediaType) (*Layer, error)

func (Layer) Compressed ¶

func (l Layer) Compressed() (io.ReadCloser, error)

func (Layer) DiffID ¶

func (l Layer) DiffID() (v1.Hash, error)

func (Layer) Digest ¶

func (l Layer) Digest() (v1.Hash, error)

func (Layer) MediaType ¶

func (l Layer) MediaType() (ggcrtypes.MediaType, error)

func (Layer) Size ¶

func (l Layer) Size() (int64, error)

func (Layer) Uncompressed ¶

func (l Layer) Uncompressed() (io.ReadCloser, error)

type WithLayers ¶

type WithLayers interface {
	WithRawConfigFile
	Layers() ([]v1.Layer, error)
}

type WithRawConfigFile ¶

type WithRawConfigFile interface {
	// RawConfigFile returns the serialized bytes of this model's config file.
	RawConfigFile() ([]byte, error)
}

type WithRawManifest ¶

type WithRawManifest interface {
	// RawManifest returns the serialized bytes of this model's manifest file.
	RawManifest() ([]byte, error)
}

WithRawManifest defines the subset of types.Model used by these helper methods

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL