fix(compose): make sure any flags defined for compose up also exist for compose down

When compose calls the model provider, the same arguments are passed to both compose
up and compose down. Unless compose down supports any flag supported by compose up, some
of these flags will cause a parsing error and cause compose down to fail.

To fix this, move the flag setup to a dedicated type and function that can be shared
by both commands.

Signed-off-by: Alberto Garcia Hierro <[email protected]>

Author: fiam

commands/compose.go

@@ -13,6 +13,13 @@ import (
 	"github.com/spf13/cobra"
 )
 
+type composeCommandFlags struct {
+	Models          []string
+	CtxSize         int64
+	RawRuntimeFlags string
+	Backend         string
+}
+
 func newComposeCmd() *cobra.Command {
 
 	c := &cobra.Command{
@@ -26,15 +33,19 @@ func newComposeCmd() *cobra.Command {
 	return c
 }
 
+func setupComposeCommandFlags(c *cobra.Command, flags *composeCommandFlags) {
+	c.Flags().StringArrayVar(&flags.Models, "model", nil, "model to use")
+	c.Flags().Int64Var(&flags.CtxSize, "context-size", -1, "context size for the model")
+	c.Flags().StringVar(&flags.RawRuntimeFlags, "runtime-flags", "", "raw runtime flags to pass to the inference engine")
+	c.Flags().StringVar(&flags.Backend, "backend", llamacpp.Name, "inference backend to use")
+}
+
 func newUpCommand() *cobra.Command {
-	var models []string
-	var ctxSize int64
-	var rawRuntimeFlags string
-	var backend string
+	flags := &composeCommandFlags{}
 	c := &cobra.Command{
 		Use: "up",
 		RunE: func(cmd *cobra.Command, args []string) error {
-			if len(models) == 0 {
+			if len(flags.Models) == 0 {
 				err := errors.New("options.model is required")
 				_ = sendError(err.Error())
 				return err
@@ -52,26 +63,26 @@ func newUpCommand() *cobra.Command {
 				return errors.New("unable to determine standalone runner endpoint")
 			}
 
-			if err := downloadModelsOnlyIfNotFound(desktopClient, models); err != nil {
+			if err := downloadModelsOnlyIfNotFound(desktopClient, flags.Models); err != nil {
 				return err
 			}
 
-			if ctxSize > 0 {
-				sendInfo(fmt.Sprintf("Setting context size to %d", ctxSize))
+			if flags.CtxSize > 0 {
+				sendInfo(fmt.Sprintf("Setting context size to %d", flags.CtxSize))
 			}
-			if rawRuntimeFlags != "" {
-				sendInfo("Setting raw runtime flags to " + rawRuntimeFlags)
+			if flags.RawRuntimeFlags != "" {
+				sendInfo("Setting raw runtime flags to " + flags.RawRuntimeFlags)
 			}
 
-			for _, model := range models {
+			for _, model := range flags.Models {
 				if err := desktopClient.ConfigureBackend(scheduling.ConfigureRequest{
 					Model:           model,
-					ContextSize:     ctxSize,
-					RawRuntimeFlags: rawRuntimeFlags,
+					ContextSize:     flags.CtxSize,
+					RawRuntimeFlags: flags.RawRuntimeFlags,
 				}); err != nil {
 					configErrFmtString := "failed to configure backend for model %s with context-size %d and runtime-flags %s"
-					_ = sendErrorf(configErrFmtString+": %v", model, ctxSize, rawRuntimeFlags, err)
-					return fmt.Errorf(configErrFmtString+": %w", model, ctxSize, rawRuntimeFlags, err)
+					_ = sendErrorf(configErrFmtString+": %v", model, flags.CtxSize, flags.RawRuntimeFlags, err)
+					return fmt.Errorf(configErrFmtString+": %w", model, flags.CtxSize, flags.RawRuntimeFlags, err)
 				}
 				sendInfo("Successfully configured backend for model " + model)
 			}
@@ -91,23 +102,19 @@ func newUpCommand() *cobra.Command {
 			return nil
 		},
 	}
-	c.Flags().StringArrayVar(&models, "model", nil, "model to use")
-	c.Flags().Int64Var(&ctxSize, "context-size", -1, "context size for the model")
-	c.Flags().StringVar(&rawRuntimeFlags, "runtime-flags", "", "raw runtime flags to pass to the inference engine")
-	c.Flags().StringVar(&backend, "backend", llamacpp.Name, "inference backend to use")
+	setupComposeCommandFlags(c, flags)
 	return c
 }
 
 func newDownCommand() *cobra.Command {
-	var model []string
 	c := &cobra.Command{
 		Use: "down",
 		RunE: func(cmd *cobra.Command, args []string) error {
 			// No required cleanup on down
 			return nil
 		},
 	}
-	c.Flags().StringArrayVar(&model, "model", nil, "model to use")
+	setupComposeCommandFlags(c, &composeCommandFlags{})
 	return c
 }
 

docs/reference/docker_model_compose_down.yaml

@@ -3,6 +3,26 @@ usage: docker model compose down
 pname: docker model compose
 plink: docker_model_compose.yaml
 options:
+    - option: backend
+      value_type: string
+      default_value: llama.cpp
+      description: inference backend to use
+      deprecated: false
+      hidden: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
+    - option: context-size
+      value_type: int64
+      default_value: "-1"
+      description: context size for the model
+      deprecated: false
+      hidden: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
     - option: model
       value_type: stringArray
       default_value: '[]'
@@ -13,6 +33,15 @@ options:
       experimentalcli: false
       kubernetes: false
       swarm: false
+    - option: runtime-flags
+      value_type: string
+      description: raw runtime flags to pass to the inference engine
+      deprecated: false
+      hidden: false
+      experimental: false
+      experimentalcli: false
+      kubernetes: false
+      swarm: false
 inherited_options:
     - option: project-name
       value_type: string