Merge branch 'main' into feature/docs

Author: gaius-qi

README.md

@@ -12,4 +12,4 @@ You can find the full documentation on the [getting started](./docs/getting-star
 
 ## LICENSE
 
-Apache 2.0 License. Please see [LICENSE](LICENSE) for more information.
+Apache 2.0 License. Please see [LICENSE](LICENSE) for more information.

cmd/build.go

@@ -50,7 +50,7 @@ var buildCmd = &cobra.Command{
 func init() {
 	flags := buildCmd.Flags()
 	flags.StringVarP(&buildConfig.Target, "target", "t", "", "target model artifact name")
-	flags.StringVarP(&buildConfig.Modelfile, "modelfile", "f", "", "model file path")
+	flags.StringVarP(&buildConfig.Modelfile, "modelfile", "f", "Modelfile", "model file path")
 
 	if err := viper.BindPFlags(flags); err != nil {
 		panic(fmt.Errorf("bind cache list flags to viper: %w", err))

cmd/inspect.go

@@ -0,0 +1,75 @@
+/*
+ *     Copyright 2024 The CNAI Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package cmd
+
+import (
+	"context"
+	"encoding/json"
+	"fmt"
+
+	"github.com/CloudNativeAI/modctl/pkg/backend"
+
+	"github.com/spf13/cobra"
+	"github.com/spf13/viper"
+)
+
+// inspectCmd represents the modctl command for inspect.
+var inspectCmd = &cobra.Command{
+	Use:                "inspect [flags] <target>",
+	Short:              "A command line tool for modctl inspect",
+	Args:               cobra.ExactArgs(1),
+	DisableAutoGenTag:  true,
+	SilenceUsage:       true,
+	FParseErrWhitelist: cobra.FParseErrWhitelist{UnknownFlags: true},
+	RunE: func(cmd *cobra.Command, args []string) error {
+		return runInspect(context.Background(), args[0])
+	},
+}
+
+// init initializes inspect command.
+func init() {
+	flags := rmCmd.Flags()
+
+	if err := viper.BindPFlags(flags); err != nil {
+		panic(fmt.Errorf("bind cache inspect flags to viper: %w", err))
+	}
+}
+
+// runInspect runs the inspect modctl.
+func runInspect(ctx context.Context, target string) error {
+	b, err := backend.New()
+	if err != nil {
+		return err
+	}
+
+	if target == "" {
+		return fmt.Errorf("target is required")
+	}
+
+	inspected, err := b.Inspect(ctx, target)
+	if err != nil {
+		return err
+	}
+
+	data, err := json.MarshalIndent(inspected, "", "	")
+	if err != nil {
+		return err
+	}
+
+	fmt.Println(string(data))
+	return nil
+}

cmd/root.go

@@ -65,4 +65,5 @@ func init() {
 	rootCmd.AddCommand(pushCmd)
 	rootCmd.AddCommand(rmCmd)
 	rootCmd.AddCommand(pruneCmd)
+	rootCmd.AddCommand(inspectCmd)
 }

pkg/backend/backend.go

@@ -47,6 +47,9 @@ type Backend interface {
 
 	// Prune prunes the unused blobs and clean up the storage.
 	Prune(ctx context.Context) ([]string, error)
+
+	// Inspect inspects the model artifact.
+	Inspect(ctx context.Context, target string) (*InspectedModelArtifact, error)
 }
 
 // backend is the implementation of Backend.

pkg/backend/build.go

@@ -114,7 +114,7 @@ func (b *backend) process(ctx context.Context, workDir string, repo string, proc
 		for _, p := range processors {
 			// process the file if it can be recognized.
 			if p.Identify(ctx, path, info) {
-				desc, err := p.Process(ctx, b.store, repo, path, info)
+				desc, err := p.Process(ctx, b.store, repo, path, workDir)
 				if err != nil {
 					return fmt.Errorf("failed to process file: %w", err)
 				}

pkg/backend/build/build.go

@@ -21,6 +21,8 @@ import (
 	"context"
 	"encoding/json"
 	"fmt"
+	"path/filepath"
+	"time"
 
 	modelspec "github.com/CloudNativeAI/modctl/pkg/spec"
 	"github.com/CloudNativeAI/modctl/pkg/storage"
@@ -30,16 +32,14 @@ import (
 	ocispec "github.com/opencontainers/image-spec/specs-go/v1"
 )
 
-// DescriptorEmptyJSON is the descriptor of a blob with content of `{}`.
-var DescriptorEmptyJSON = ocispec.Descriptor{
-	MediaType: ocispec.MediaTypeImageConfig,
-	Digest:    `sha256:44136fa355b3678a1146ad16f7e8649e94fb4fc21fe77e8310c060f61caaff8a`,
-	Size:      2,
-	Data:      []byte(`{}`),
+// 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 string) (ocispec.Descriptor, error) {
+func BuildLayer(ctx context.Context, store storage.Storage, repo, path, workDir string) (ocispec.Descriptor, error) {
 	reader, err := TarFileToStream(path)
 	if err != nil {
 		return ocispec.Descriptor{}, fmt.Errorf("failed to tar file: %w", err)
@@ -50,23 +50,48 @@ func BuildLayer(ctx context.Context, store storage.Storage, repo, path string) (
 		return ocispec.Descriptor{}, fmt.Errorf("failed to push blob to storage: %w", err)
 	}
 
+	absPath, err := filepath.Abs(workDir)
+	if err != nil {
+		return ocispec.Descriptor{}, fmt.Errorf("failed to get absolute path of workDir: %w", err)
+	}
+
+	filePath, err := filepath.Rel(absPath, path)
+	if err != nil {
+		return ocispec.Descriptor{}, fmt.Errorf("failed to get relative path: %w", err)
+	}
+
 	return ocispec.Descriptor{
 		ArtifactType: modelspec.ArtifactTypeModelLayer,
 		MediaType:    ocispec.MediaTypeImageLayer,
 		Digest:       godigest.Digest(digest),
 		Size:         size,
+		Annotations: map[string]string{
+			modelspec.AnnotationFilepath: filePath,
+		},
 	}, 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) {
-	// by default using the empty JSON config.
-	_, _, err := store.PushBlob(ctx, repo, bytes.NewReader(DescriptorEmptyJSON.Data))
+	config := &ModelConfig{
+		Created: time.Now().Format(time.RFC3339Nano),
+	}
+	configJSON, err := json.Marshal(config)
+	if err != nil {
+		return ocispec.Descriptor{}, fmt.Errorf("failed to marshal config: %w", err)
+	}
+
+	digest, size, err := store.PushBlob(ctx, repo, bytes.NewReader(configJSON))
 	if err != nil {
 		return ocispec.Descriptor{}, fmt.Errorf("failed to push config to storage: %w", err)
 	}
 
-	return DescriptorEmptyJSON, nil
+	return ocispec.Descriptor{
+		// reuse the image config media type for runtime compatibility.
+		MediaType: ocispec.MediaTypeImageConfig,
+		Size:      size,
+		Digest:    godigest.Digest(digest),
+	}, nil
 }
 
 // BuildManifest builds the manifest and push it to the storage.

pkg/backend/inspect.go

@@ -0,0 +1,104 @@
+/*
+ *     Copyright 2024 The CNAI Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package backend
+
+import (
+	"context"
+	"encoding/json"
+	"fmt"
+
+	modelspec "github.com/CloudNativeAI/modctl/pkg/spec"
+	ocispec "github.com/opencontainers/image-spec/specs-go/v1"
+)
+
+// InspectedModelArtifact is the data structure for model artifact that has been inspected.
+type InspectedModelArtifact struct {
+	// ID is the image id of the model artifact.
+	ID string `json:"Id"`
+	// Digest is the digest of the model artifact.
+	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"`
+	// Family is the family of the model.
+	Family string `json:"Family"`
+	// Format is the format of the model.
+	Format string `json:"Format"`
+	// Name is the name of the model.
+	Name string `json:"Name"`
+	// ParamSize is the param size of the model.
+	ParamSize string `json:"ParamSize"`
+	// Precision is the precision of the model.
+	Precision string `json:"Precision"`
+	// Quantization is the quantization of the model.
+	Quantization string `json:"Quantization"`
+	// Layers is the layers of the model artifact.
+	Layers []InspectedModelArtifactLayer `json:"Layers"`
+}
+
+// InspectedModelArtifactLayer is the data structure for model artifact layer that has been inspected.
+type InspectedModelArtifactLayer struct {
+	// Digest is the digest of the model artifact layer.
+	Digest string `json:"Digest"`
+	// Size is the size of the model artifact layer.
+	Size int64 `json:"Size"`
+	// Filepath is the filepath of the model artifact layer.
+	Filepath string `json:"Filepath"`
+}
+
+// Inspect inspects the target from the storage.
+func (b *backend) Inspect(ctx context.Context, target string) (*InspectedModelArtifact, error) {
+	ref, err := ParseReference(target)
+	if err != nil {
+		return nil, fmt.Errorf("failed to parse target: %w", err)
+	}
+
+	repo, tag := ref.Repository(), ref.Tag()
+	manifestRaw, digest, err := b.store.PullManifest(ctx, repo, tag)
+	if err != nil {
+		return nil, fmt.Errorf("failed to get manifest: %w", err)
+	}
+
+	var manifest ocispec.Manifest
+	if err := json.Unmarshal(manifestRaw, &manifest); err != nil {
+		return nil, fmt.Errorf("failed to unmarshal manifest: %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],
+	}
+
+	for _, layer := range manifest.Layers {
+		inspectedModelArtifact.Layers = append(inspectedModelArtifact.Layers, InspectedModelArtifactLayer{
+			Digest:   layer.Digest.String(),
+			Size:     layer.Size,
+			Filepath: layer.Annotations[modelspec.AnnotationFilepath],
+		})
+	}
+
+	return inspectedModelArtifact, nil
+}