Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

model

package

Go to main page

Versions in this module

v0

v0.17.1

Mar 27, 2026

v0.17.0

Mar 25, 2026

Changes in this version

+ const AnnotationReferenceDigest

+ const AnnotationReferenceType

+ const AnnotationValueWeights

+ const AnnotationWeightDest

+ const AnnotationWeightDigestOriginal

+ const AnnotationWeightName

+ const AnnotationWeightSizeUncompressed

+ const DefaultPushConcurrency

+ const MediaTypeWeightArtifact

+ const MediaTypeWeightConfig

+ const MediaTypeWeightLayer

+ const MediaTypeWeightLayerGzip

+ const MediaTypeWeightLayerZstd

+ const PlatformUnknown

+ const WeightsLockFilename

+ var ErrNotCogModel = errors.New("image is not a Cog model")

+ var ErrNotFound = errors.New("image not found")

+ var LabelConfig = global.LabelNamespace + "config"

+ var LabelOpenAPISchema = global.LabelNamespace + "openapi_schema"

+ var LabelVersion = global.LabelNamespace + "version"

+ var LabelWeightsManifest = global.LabelNamespace + "r8_weights_manifest"

+ func GetPushConcurrency() int

+ func OCIIndexEnabled() bool

+ func WeightTag(name, digest string) string

+ type Artifact interface

+ Descriptor func() v1.Descriptor

+ Name func() string

+ Type func() ArtifactType

+ type ArtifactSpec interface

+ Name func() string

+ Type func() ArtifactType

+ type ArtifactType int

+ const ArtifactTypeImage

+ const ArtifactTypeWeight

+ func (t ArtifactType) String() string

+ type BuildOptions struct

+ Annotations map[string]string

+ DockerfileFile string

+ ExcludeSource bool

+ ImageName string

+ NoCache bool

+ OCIIndex bool

+ Precompile bool

+ ProgressOutput string

+ SchemaFile string

+ Secrets []string

+ SeparateWeights bool

+ SkipLabels bool

+ SkipSchemaValidation bool

+ Strip bool

+ UseCogBaseImage *bool

+ UseCudaBaseImage string

+ WeightsLockPath string

+ func (o BuildOptions) WithDefaults(src *Source) BuildOptions

+ type BuildRef struct

+ Options BuildOptions

+ Source *Source

+ func FromBuild(src *Source, opts BuildOptions) *BuildRef

+ type Builder interface

+ Build func(ctx context.Context, spec ArtifactSpec) (Artifact, error)

+ type BundlePusher struct

+ func NewBundlePusher(docker command.Command, reg registry.Client) *BundlePusher

+ func (p *BundlePusher) Push(ctx context.Context, m *Model, opts PushOptions) error

+ type DockerfileFactory struct

+ func (f *DockerfileFactory) Build(ctx context.Context, src *Source, opts BuildOptions) (*ImageArtifact, error)

+ func (f *DockerfileFactory) Name() string

+ type Factory interface

+ Build func(ctx context.Context, src *Source, opts BuildOptions) (*ImageArtifact, error)

+ Name func() string

+ func NewDockerfileFactory(docker command.Command, registry registry.Client) Factory

+ type ImageArtifact struct

+ Digest string

+ Labels map[string]string

+ Platform *Platform

+ Reference string

+ Source ImageSource

+ func NewImageArtifact(name string, desc v1.Descriptor, reference string) *ImageArtifact

+ func (a *ImageArtifact) CogVersion() string

+ func (a *ImageArtifact) Config() string

+ func (a *ImageArtifact) Descriptor() v1.Descriptor

+ func (a *ImageArtifact) IsCogModel() bool

+ func (a *ImageArtifact) Name() string

+ func (a *ImageArtifact) OpenAPISchema() string

+ func (a *ImageArtifact) ParsedConfig() (*config.Config, error)

+ func (a *ImageArtifact) ParsedOpenAPISchema() (*openapi3.T, error)

+ func (a *ImageArtifact) ToModel() (*Model, error)

+ func (a *ImageArtifact) Type() ArtifactType

+ type ImageBuilder struct

+ func NewImageBuilder(factory Factory, docker command.Command, source *Source, opts BuildOptions) *ImageBuilder

+ func (b *ImageBuilder) Build(ctx context.Context, spec ArtifactSpec) (Artifact, error)

+ type ImagePushOption func(*imagePushOptions)

+ func WithOnFallback(fn func()) ImagePushOption

+ func WithProgressFn(fn func(PushProgress)) ImagePushOption

+ type ImagePusher struct

+ func (p *ImagePusher) Push(ctx context.Context, artifact *ImageArtifact, opts ...ImagePushOption) error

+ type ImageSource string

+ const ImageSourceBuild

+ const ImageSourceLocal

+ const ImageSourceRemote

+ type ImageSpec struct

+ ImageName string

+ NoCache bool

+ Secrets []string

+ func NewImageSpec(name, imageName string, opts ...ImageSpecOption) *ImageSpec

+ func (s *ImageSpec) Name() string

+ func (s *ImageSpec) Type() ArtifactType

+ type ImageSpecOption func(*ImageSpec)

+ func WithImageNoCache(noCache bool) ImageSpecOption

+ func WithImageSecrets(secrets []string) ImageSpecOption

+ type Index struct

+ Digest string

+ Manifests []IndexManifest

+ MediaType string

+ Reference string

+ type IndexBuilder struct

+ func NewIndexBuilder() *IndexBuilder

+ func (b *IndexBuilder) AddWeightDescriptor(desc v1.Descriptor, imageDigest, name, target string)

+ func (b *IndexBuilder) BuildFromDescriptors() (v1.ImageIndex, error)

+ func (b *IndexBuilder) SetImageDescriptor(desc v1.Descriptor, platform *v1.Platform)

+ type IndexManifest struct

+ Annotations map[string]string

+ Digest string

+ MediaType string

+ Platform *Platform

+ Size int64

+ Type ManifestType

+ type LocalRef struct

+ Parsed *ParsedRef

+ func FromLocal(ref string) (*LocalRef, error)

+ type ManifestType string

+ const ManifestTypeImage

+ const ManifestTypeWeights

type Model

+ Artifacts []Artifact

+ CogVersion string

+ Config *config.Config

+ Image *ImageArtifact

+ Index *Index

+ OCIIndex bool

+ Schema *openapi3.T

+ func (m *Model) ArtifactsByType(t ArtifactType) []Artifact

+ func (m *Model) GetImageArtifact() *ImageArtifact

+ func (m *Model) HasGPU() bool

+ func (m *Model) ImageRef() string

+ func (m *Model) IsBundle() bool

+ func (m *Model) SchemaJSON() ([]byte, error)

+ func (m *Model) WeightArtifacts() []*WeightArtifact

+ type Option func(*options)

+ func LocalOnly() Option

+ func PreferLocal() Option

+ func PreferRemote() Option

+ func RemoteOnly() Option

+ func WithPlatform(p *registry.Platform) Option

+ type ParseOption func(*parseOptions)

+ func Insecure() ParseOption

+ func WithDefaultRegistry(registry string) ParseOption

+ func WithDefaultTag(tag string) ParseOption

+ type ParsedRef struct

+ Original string

+ Ref name.Reference

+ func ParseRef(ref string, opts ...ParseOption) (*ParsedRef, error)

+ func (p *ParsedRef) Digest() string

+ func (p *ParsedRef) IsDigest() bool

+ func (p *ParsedRef) IsReplicate() bool

+ func (p *ParsedRef) IsTag() bool

+ func (p *ParsedRef) Registry() string

+ func (p *ParsedRef) Repository() string

+ func (p *ParsedRef) String() string

+ func (p *ParsedRef) Tag() string

+ type Platform struct

+ Architecture string

+ OS string

+ Variant string

+ type PushOptions struct

+ FilePaths map[string]string

+ ImageProgressFn func(PushProgress)

+ OnFallback func()

+ Platform *Platform

+ ProjectDir string

+ type PushProgress struct

+ Complete int64

+ LayerDigest string

+ Total int64

+ type Ref interface

+ type RemoteRef struct

+ Parsed *ParsedRef

+ func FromRemote(ref string) (*RemoteRef, error)

+ type Resolver struct

+ func NewResolver(docker command.Command, reg registry.Client) *Resolver

+ func (r *Resolver) Build(ctx context.Context, src *Source, opts BuildOptions) (*Model, error)

+ func (r *Resolver) Inspect(ctx context.Context, ref *ParsedRef, opts ...Option) (*Model, error)

+ func (r *Resolver) InspectByID(ctx context.Context, id string) (*Model, error)

+ func (r *Resolver) Pull(ctx context.Context, ref *ParsedRef, opts ...Option) (*Model, error)

+ func (r *Resolver) Push(ctx context.Context, m *Model, opts PushOptions) error

+ func (r *Resolver) Resolve(ctx context.Context, ref Ref) (*Model, error)

+ func (r *Resolver) WithFactory(f Factory) *Resolver

+ type Source struct

+ Config *config.Config

+ ConfigFilename string

+ ProjectDir string

+ Warnings []config.DeprecationWarning

+ func NewSource(configPath string) (*Source, error)

+ func NewSourceFromConfig(cfg *config.Config, projectDir string) *Source

+ func (s *Source) ArtifactSpecs() []ArtifactSpec

+ type TagRef struct

+ Parsed *ParsedRef

+ func FromTag(ref string) (*TagRef, error)

+ type WeightArtifact struct

+ Config WeightConfig

+ FilePath string

+ Target string

+ func NewWeightArtifact(name string, desc v1.Descriptor, filePath, target string, cfg WeightConfig) *WeightArtifact

+ func (a *WeightArtifact) Descriptor() v1.Descriptor

+ func (a *WeightArtifact) Name() string

+ func (a *WeightArtifact) Type() ArtifactType

+ type WeightBuilder struct

+ func NewWeightBuilder(source *Source, cogVersion, lockPath string) *WeightBuilder

+ func (b *WeightBuilder) Build(ctx context.Context, spec ArtifactSpec) (Artifact, error)

+ type WeightConfig struct

+ CogVersion string

+ Created time.Time

+ Name string

+ SchemaVersion string

+ Target string

+ type WeightFile struct

+ ContentType string

+ Dest string

+ Digest string

+ DigestOriginal string

+ MediaType string

+ Name string

+ Size int64

+ SizeUncompressed int64

+ type WeightPushOptions struct

+ ProgressFn func(PushProgress)

+ RetryFn func(WeightRetryEvent) bool

+ type WeightPushResult struct

+ Descriptor v1.Descriptor

+ Ref string

+ type WeightPusher struct

+ func NewWeightPusher(reg registry.Client) *WeightPusher

+ func (p *WeightPusher) Push(ctx context.Context, repo string, artifact *WeightArtifact, ...) (*WeightPushResult, error)

+ type WeightRetryEvent struct

+ Attempt int

+ Err error

+ MaxAttempts int

+ Name string

+ NextRetryIn time.Duration

+ type WeightSpec struct

+ Source string

+ Target string

+ func NewWeightSpec(name, source, target string) *WeightSpec

+ func (s *WeightSpec) Name() string

+ func (s *WeightSpec) Type() ArtifactType

+ type WeightsLock struct

+ Created time.Time

+ Files []WeightFile

+ Version string

+ func LoadWeightsLock(path string) (*WeightsLock, error)

+ func ParseWeightsLock(data []byte) (*WeightsLock, error)

+ func (wl *WeightsLock) Save(path string) error

v0.17.0-rc.4

Mar 24, 2026

v0.17.0-rc.3

Mar 23, 2026

v0.17.0-rc.2

Mar 12, 2026

v0.17.0-rc.1

Feb 28, 2026

v0.17.0-beta2

Feb 17, 2026

v0.17.0-beta1

Feb 11, 2026

v0.17.0-alpha4

Feb 10, 2026

v0.17.0-alpha3

Feb 9, 2026

v0.17.0-alpha2

Feb 7, 2026

v0.0.4

Jun 25, 2021

v0.0.3

Jun 8, 2021

v0.0.2

Jun 7, 2021

Changes in this version

+ const TargetDockerCPU

+ const TargetDockerGPU

+ var CUDABaseImages []CUDABaseImage

+ var TFCompatibilityMatrix []TFCompatibility

+ var TorchCompatibilityMatrix []TorchCompatibility

+ func CUDABaseImageFor(cuda string, cuDNN string) (string, error)

+ type ArgumentType string

+ const ArgumentTypeBool

+ const ArgumentTypeFloat

+ const ArgumentTypeInt

+ const ArgumentTypePath

+ const ArgumentTypeString

+ type CUDABaseImage struct

+ CUDA string

+ CuDNN string

+ IsDevel bool

+ Tag string

+ Ubuntu string

+ func (i *CUDABaseImage) ImageTag() string

+ func (i *CUDABaseImage) UnmarshalJSON(data []byte) error

+ type Config struct

+ Environment *Environment

+ Examples []*Example

+ Model string

+ Workdir string

+ func ConfigFromYAML(contents []byte) (*Config, error)

+ func DefaultConfig() *Config

+ func (c *Config) CUDABaseImageTag() (string, error)

+ func (c *Config) HasCPU() bool

+ func (c *Config) HasGPU() bool

+ func (c *Config) PythonPackagesForArch(arch string, goos string, goarch string) (packages []string, indexURLs []string, err error)

+ func (c *Config) ValidateAndCompleteConfig() error

+ type Environment struct

+ Architectures []string

+ BuildRequiresGPU bool

+ CUDA string

+ CuDNN string

+ PreInstall []string

+ PythonExtraIndexURLs []string

+ PythonFindLinks []string

+ PythonPackages []string

+ PythonRequirements string

+ PythonVersion string

+ SystemPackages []string

+ type Example struct

+ Input map[string]string

+ Output string

+ type Image struct

+ Arch string

+ BuildFailed bool

+ Created time.Time

+ RunArguments map[string]*RunArgument

+ TestStats *Stats

+ URI string

+ func ImageForArch(images []*Image, arch string) *Image

+ type Model struct

+ Host string

+ Name string

+ User string

+ func (m *Model) String() string

+ type RunArgument struct

+ Default *string

+ Help *string

+ Max *string

+ Min *string

+ Options *[]string

+ Type ArgumentType

+ type Stats struct

+ BootTime float64

+ CPUUsage float64

+ MemoryUsage uint64

+ RunTime float64

+ SetupTime float64

+ type TFCompatibility struct

+ CUDA string

+ CuDNN string

+ Pythons []string

+ TF string

+ TFCPUPackage string

+ TFGPUPackage string

+ func (compat *TFCompatibility) UnmarshalJSON(data []byte) error

+ type TorchCompatibility struct

+ CUDA *string

+ IndexURL string

+ Pythons []string

+ Torch string

+ Torchaudio string

+ Torchvision string

+ func (c *TorchCompatibility) TorchVersion() string

+ func (c *TorchCompatibility) TorchvisionVersion() string

+ type Version struct

+ BuildIDs map[string]string

+ Config *Config

+ Created time.Time

+ ID string

v0.0.1-alpha4

Jun 1, 2021

v0.0.1-alpha3

Mar 26, 2021

v0.0.1-alpha2

Mar 23, 2021

v0.0.1-alpha1

Mar 23, 2021