format

package
v1.1.0-rc.3 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 19, 2026 License: EPL-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package format detects and unpacks OCI AI artifact packaging formats.

Index

Constants

View Source
const (
	MediaDockerModelConfigV01 = "application/vnd.docker.ai.model.config.v0.1+json"
	MediaDockerModelConfigV02 = "application/vnd.docker.ai.model.config.v0.2+json"
	MediaDockerGGUF           = "application/vnd.docker.ai.gguf.v3"
	MediaDockerGGUFLora       = "application/vnd.docker.ai.gguf.v3.lora"
	MediaDockerGGUFMMProj     = "application/vnd.docker.ai.gguf.v3.mmproj"
	MediaDockerLicense        = "application/vnd.docker.ai.license"
	MediaDockerChatTemplate   = "application/vnd.docker.ai.chat.template.jinja"
	MediaDockerSafetensors    = "application/vnd.docker.ai.safetensors"
	MediaDockerMMProj         = "application/vnd.docker.ai.mmproj"
	MediaDockerModelFile      = "application/vnd.docker.ai.model.file"
	MediaDockerDDUF           = "application/vnd.docker.ai.dduf"

	MediaModelPackManifest = "application/vnd.cncf.model.manifest.v1+json"
	MediaModelPackConfig   = "application/vnd.cncf.model.config.v1+json"

	MediaKitOpsConfig = "application/vnd.kitops.modelkit.config.v1+json"
	MediaJozuConfig   = "application/vnd.jozu.model.config.v1+json"

	AnnotationFilePath   = "org.cncf.model.filepath"
	AnnotationTitle      = "org.opencontainers.image.title"
	AnnotationKitfile    = "ml.kitops.modelkit.kitfile"
	AnnotationKitfileAlt = "org.kitops.modelkit.kitfile"
	MediaTypeOctetStream = "application/octet-stream"
)

Media types used to detect and unpack model artifacts.

Variables

This section is empty.

Functions

This section is empty.

Types

type BlobOpener

type BlobOpener interface {
	Open(digest string) (io.ReadCloser, error)
}

BlobOpener opens a stored blob by digest (sha256:…).

type Kind

type Kind string

Kind is a detected OCI AI artifact packaging format.

const (
	KindDocker    Kind = "docker-model-spec"
	KindModelPack Kind = "modelpack"
	KindModelKit  Kind = "modelkit"
	KindORAS      Kind = "oras"
)

func Detect

func Detect(manifest ocispec.Manifest) Kind

Detect returns the packaging format for an OCI manifest. Order: Docker model-spec, CNCF ModelPack, KitOps ModelKit, generic ORAS.

type UnpackResult

type UnpackResult struct {
	// RelPaths are paths relative to the model directory (content/…).
	RelPaths []string
	// Format is a model format hint inferred from layers (gguf, safetensors, …).
	Format string
}

UnpackResult is the set of files materialized under content/.

func Unpack

func Unpack(kind Kind, manifest ocispec.Manifest, blobs BlobOpener, destDir string) (*UnpackResult, error)

Unpack materializes artifact layers into destDir (the content/ directory).

Jump to

Keyboard shortcuts

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