feat: align with the latest model spec (#67)

Signed-off-by: chlins <[email protected]>

Author: chlins

go.mod

@@ -3,7 +3,7 @@ module github.com/CloudNativeAI/modctl
 go 1.23.3
 
 require (
-	github.com/CloudNativeAI/model-spec v0.0.0-20241121031550-59ad02d4a225
+	github.com/CloudNativeAI/model-spec v0.0.0-20250212030633-7aabe2b8eadc
 	github.com/distribution/distribution/v3 v3.0.0-rc.2
 	github.com/distribution/reference v0.6.0
 	github.com/dustin/go-humanize v1.0.1

go.sum

@@ -1,5 +1,7 @@
 github.com/CloudNativeAI/model-spec v0.0.0-20241121031550-59ad02d4a225 h1:/wakwn9KDTKnVSlg+H12XxsGSVSNs0XK/j9UjUw3vUs=
 github.com/CloudNativeAI/model-spec v0.0.0-20241121031550-59ad02d4a225/go.mod h1:/wGtOmyHRaxmWGWguc1oh7pcYbWyiuXG+VkAV8vmOTI=
+github.com/CloudNativeAI/model-spec v0.0.0-20250212030633-7aabe2b8eadc h1:EmVmYn5o4jGweOlvjsbsdeSlSpNYvWPQ2muLaQXT1L8=
+github.com/CloudNativeAI/model-spec v0.0.0-20250212030633-7aabe2b8eadc/go.mod h1:3U/4zubBfbUkW59ATSg41HnkYyKrKUcKFH/cVdoPQnk=
 github.com/VividCortex/ewma v1.2.0 h1:f58SaIzcDXrSy3kWaHNvuJgJ3Nmz59Zji6XoJR/q1ow=
 github.com/VividCortex/ewma v1.2.0/go.mod h1:nz4BbCtbLyFDeC9SUHbtcT5644juEuWfUAUnGx7j5l4=
 github.com/acarl005/stripansi v0.0.0-20180116102854-5a71ef0e047d h1:licZJFw2RwpHMqeKTCYkitsPqHNxTmd4SNR5r94FGM8=

pkg/backend/build.go

@@ -21,12 +21,10 @@ import (
 	"fmt"
 	"os"
 	"path/filepath"
-	"time"
 
 	"github.com/CloudNativeAI/modctl/pkg/backend/build"
 	"github.com/CloudNativeAI/modctl/pkg/backend/processor"
 	"github.com/CloudNativeAI/modctl/pkg/modelfile"
-	modelspec "github.com/CloudNativeAI/model-spec/specs-go/v1"
 
 	humanize "github.com/dustin/go-humanize"
 	ocispec "github.com/opencontainers/image-spec/specs-go/v1"
@@ -55,15 +53,15 @@ func (b *backend) Build(ctx context.Context, modelfilePath, workDir, target stri
 	layers = append(layers, layerDescs...)
 
 	// build the image config.
-	configDesc, err := build.BuildConfig(ctx, b.store, repo)
+	configDesc, err := build.BuildConfig(ctx, b.store, modelfile, repo)
 	if err != nil {
 		return fmt.Errorf("failed to build image config: %w", err)
 	}
 
 	fmt.Printf("%-15s => %s (%s)\n", "Built config", configDesc.Digest, humanize.IBytes(uint64(configDesc.Size)))
 
 	// build the image manifest.
-	manifestDesc, err := build.BuildManifest(ctx, b.store, repo, tag, layers, configDesc, manifestAnnotation(modelfile))
+	manifestDesc, err := build.BuildManifest(ctx, b.store, repo, tag, layers, configDesc, manifestAnnotation())
 	if err != nil {
 		return fmt.Errorf("failed to build image manifest: %w", err)
 	}
@@ -133,38 +131,8 @@ func (b *backend) process(ctx context.Context, workDir string, repo string, proc
 }
 
 // manifestAnnotation returns the annotations for the manifest.
-func manifestAnnotation(modelfile modelfile.Modelfile) map[string]string {
-	anno := map[string]string{
-		modelspec.AnnotationCreated: time.Now().Format(time.RFC3339),
-	}
-
-	if arch := modelfile.GetArch(); arch != "" {
-		anno[modelspec.AnnotationArchitecture] = arch
-	}
-
-	if family := modelfile.GetFamily(); family != "" {
-		anno[modelspec.AnnotationFamily] = family
-	}
-
-	if name := modelfile.GetName(); name != "" {
-		anno[modelspec.AnnotationName] = name
-	}
-
-	if format := modelfile.GetFormat(); format != "" {
-		anno[modelspec.AnnotationFormat] = format
-	}
-
-	if paramsize := modelfile.GetParamsize(); paramsize != "" {
-		anno[modelspec.AnnotationParamSize] = paramsize
-	}
-
-	if precision := modelfile.GetPrecision(); precision != "" {
-		anno[modelspec.AnnotationPrecision] = precision
-	}
-
-	if quantization := modelfile.GetQuantization(); quantization != "" {
-		anno[modelspec.AnnotationQuantization] = quantization
-	}
-
+func manifestAnnotation() map[string]string {
+	// placeholder for future expansion of annotations.
+	anno := map[string]string{}
 	return anno
 }

pkg/backend/build/build.go

@@ -22,9 +22,11 @@ import (
 	"encoding/json"
 	"fmt"
 	"path/filepath"
+	"strconv"
 	"time"
 
 	"github.com/CloudNativeAI/modctl/pkg/archiver"
+	"github.com/CloudNativeAI/modctl/pkg/modelfile"
 	"github.com/CloudNativeAI/modctl/pkg/storage"
 	modelspec "github.com/CloudNativeAI/model-spec/specs-go/v1"
 
@@ -33,14 +35,8 @@ import (
 	ocispec "github.com/opencontainers/image-spec/specs-go/v1"
 )
 
-// ModelConfig is a configuration that corresponds to the image config in the image spec.
-type ModelConfig struct {
-	// Created is the time when the model image is created.
-	Created string `json:"Created"`
-}
-
 // BuildLayer converts the file to the image blob and push it to the storage.
-func BuildLayer(ctx context.Context, store storage.Storage, repo, path, workDir string) (ocispec.Descriptor, error) {
+func BuildLayer(ctx context.Context, store storage.Storage, mediaType, repo, path, workDir string) (ocispec.Descriptor, error) {
 	reader, err := archiver.Tar(path)
 	if err != nil {
 		return ocispec.Descriptor{}, fmt.Errorf("failed to tar file: %w", err)
@@ -62,21 +58,55 @@ func BuildLayer(ctx context.Context, store storage.Storage, repo, path, workDir
 	}
 
 	return ocispec.Descriptor{
-		ArtifactType: modelspec.ArtifactTypeModelLayer,
-		MediaType:    ocispec.MediaTypeImageLayer,
-		Digest:       godigest.Digest(digest),
-		Size:         size,
+		MediaType: mediaType,
+		Digest:    godigest.Digest(digest),
+		Size:      size,
 		Annotations: map[string]string{
 			modelspec.AnnotationFilepath: filePath,
 		},
 	}, nil
 }
 
+// buildModelConfig builds the model config.
+func buildModelConfig(modelfile modelfile.Modelfile) (*modelspec.Model, error) {
+	config := modelspec.ModelConfig{
+		Architecture: modelfile.GetArch(),
+		Format:       modelfile.GetFormat(),
+		Precision:    modelfile.GetPrecision(),
+		Quantization: modelfile.GetQuantization(),
+	}
+	// parse the parameter size.
+	paramSize, err := strconv.ParseUint(modelfile.GetParamsize(), 10, 64)
+	if err != nil {
+		return nil, fmt.Errorf("failed to parse paramsize %s to uint64: %w", modelfile.GetParamsize(), err)
+	}
+	config.ParameterSize = paramSize
+
+	createdAt := time.Now()
+	descriptor := modelspec.ModelDescriptor{
+		CreatedAt: &createdAt,
+		Family:    modelfile.GetFamily(),
+		Name:      modelfile.GetName(),
+	}
+
+	fs := modelspec.ModelFS{
+		Type: "layers",
+	}
+
+	return &modelspec.Model{
+		Config:     config,
+		Descriptor: descriptor,
+		ModelFS:    fs,
+	}, nil
+}
+
 // BuildConfig builds the image config and push it to the storage.
-func BuildConfig(ctx context.Context, store storage.Storage, repo string) (ocispec.Descriptor, error) {
-	config := &ModelConfig{
-		Created: time.Now().Format(time.RFC3339Nano),
+func BuildConfig(ctx context.Context, store storage.Storage, modelfile modelfile.Modelfile, repo string) (ocispec.Descriptor, error) {
+	config, err := buildModelConfig(modelfile)
+	if err != nil {
+		return ocispec.Descriptor{}, fmt.Errorf("failed to build model config: %w", err)
 	}
+
 	configJSON, err := json.Marshal(config)
 	if err != nil {
 		return ocispec.Descriptor{}, fmt.Errorf("failed to marshal config: %w", err)
@@ -88,8 +118,7 @@ func BuildConfig(ctx context.Context, store storage.Storage, repo string) (ocisp
 	}
 
 	return ocispec.Descriptor{
-		// reuse the image config media type for runtime compatibility.
-		MediaType: ocispec.MediaTypeImageConfig,
+		MediaType: modelspec.MediaTypeModelConfig,
 		Size:      size,
 		Digest:    godigest.Digest(digest),
 	}, nil

pkg/backend/build_test.go

@@ -18,39 +18,12 @@ package backend
 
 import (
 	"testing"
-	"time"
 
 	"github.com/CloudNativeAI/modctl/test/mocks/modelfile"
-	modelspec "github.com/CloudNativeAI/model-spec/specs-go/v1"
 
 	"github.com/stretchr/testify/assert"
 )
 
-func TestManifestAnnotation(t *testing.T) {
-	modelfile := &modelfile.Modelfile{}
-	modelfile.On("GetArch").Return("test-arch")
-	modelfile.On("GetFamily").Return("test-family")
-	modelfile.On("GetName").Return("test-model")
-	modelfile.On("GetFormat").Return("test-format")
-	modelfile.On("GetParamsize").Return("12345")
-	modelfile.On("GetPrecision").Return("FP32")
-	modelfile.On("GetQuantization").Return("INT8")
-
-	annotations := manifestAnnotation(modelfile)
-
-	assert.Equal(t, "test-arch", annotations[modelspec.AnnotationArchitecture])
-	assert.Equal(t, "test-family", annotations[modelspec.AnnotationFamily])
-	assert.Equal(t, "test-model", annotations[modelspec.AnnotationName])
-	assert.Equal(t, "test-format", annotations[modelspec.AnnotationFormat])
-	assert.Equal(t, "12345", annotations[modelspec.AnnotationParamSize])
-	assert.Equal(t, "FP32", annotations[modelspec.AnnotationPrecision])
-	assert.Equal(t, "INT8", annotations[modelspec.AnnotationQuantization])
-
-	createdTime, err := time.Parse(time.RFC3339, annotations[modelspec.AnnotationCreated])
-	assert.NoError(t, err)
-	assert.WithinDuration(t, time.Now(), createdTime, time.Minute)
-}
-
 func TestGetProcessors(t *testing.T) {
 	modelfile := &modelfile.Modelfile{}
 	modelfile.On("GetConfigs").Return([]string{"config1", "config2"})

pkg/backend/inspect.go

@@ -20,6 +20,7 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+	"time"
 
 	modelspec "github.com/CloudNativeAI/model-spec/specs-go/v1"
 	ocispec "github.com/opencontainers/image-spec/specs-go/v1"
@@ -33,8 +34,8 @@ type InspectedModelArtifact struct {
 	Digest string `json:"Digest"`
 	// Architecture is the architecture of the model.
 	Architecture string `json:"Architecture"`
-	// Created is the creation time of the model artifact.
-	Created string `json:"Created"`
+	// CreatedAt is the creation time of the model artifact.
+	CreatedAt string `json:"CreatedAt"`
 	// Family is the family of the model.
 	Family string `json:"Family"`
 	// Format is the format of the model.
@@ -79,17 +80,32 @@ func (b *backend) Inspect(ctx context.Context, target string) (*InspectedModelAr
 		return nil, fmt.Errorf("failed to unmarshal manifest: %w", err)
 	}
 
+	// fetch and parse the model config.
+	configReader, err := b.store.PullBlob(ctx, repo, manifest.Config.Digest.String())
+	if err != nil {
+		return nil, fmt.Errorf("failed to pull config: %w", err)
+	}
+
+	defer configReader.Close()
+	var config modelspec.Model
+	if err := json.NewDecoder(configReader).Decode(&config); err != nil {
+		return nil, fmt.Errorf("failed to decode config: %w", err)
+	}
+
 	inspectedModelArtifact := &InspectedModelArtifact{
 		ID:           manifest.Config.Digest.String(),
 		Digest:       digest,
-		Architecture: manifest.Annotations[modelspec.AnnotationArchitecture],
-		Created:      manifest.Annotations[modelspec.AnnotationCreated],
-		Family:       manifest.Annotations[modelspec.AnnotationFamily],
-		Format:       manifest.Annotations[modelspec.AnnotationFormat],
-		Name:         manifest.Annotations[modelspec.AnnotationName],
-		ParamSize:    manifest.Annotations[modelspec.AnnotationParamSize],
-		Precision:    manifest.Annotations[modelspec.AnnotationPrecision],
-		Quantization: manifest.Annotations[modelspec.AnnotationQuantization],
+		Architecture: config.Config.Architecture,
+		Family:       config.Descriptor.Family,
+		Format:       config.Config.Format,
+		Name:         config.Descriptor.Name,
+		ParamSize:    fmt.Sprintf("%d", config.Config.ParameterSize),
+		Precision:    config.Config.Precision,
+		Quantization: config.Config.Quantization,
+	}
+
+	if config.Descriptor.CreatedAt != nil {
+		inspectedModelArtifact.CreatedAt = config.Descriptor.CreatedAt.Format(time.RFC3339)
 	}
 
 	for _, layer := range manifest.Layers {