feat: Update Model Repo interfaces (#227)

Author: brosenpod

README.md

@@ -23,7 +23,6 @@ _Note: All pods automatically come with runpodctl installed with a pod-scoped AP
     - [To receive a file](#to-receive-a-file)
     - [Using Google Drive](#using-google-drive)
   - [Pod Commands](#pod-commands)
-  - [Model Repository Commands](#model-repository-commands)
   - [Acknowledgements](#acknowledgements)
 
 ## Get Started
@@ -135,32 +134,6 @@ runpodctl stop pod {podId}
 
 For a comprehensive list of commands, visit [RunPod CLI documentation](docs/runpodctl.md).
 
-## Model Repository Commands
-
-Model repository commands let you upload, list, and remove AI models that can later be deployed with pods.
-
-```bash
-# Upload a model directory to your account's repository
-runpodctl create model \
-  --provider huggingface \
-  --name lodestones/Chroma \
-  --credential-reference secret://runpod/model-storage \
-  --version 1.0.0 \
-  --model-path ./chroma-model
-
-# List models in your repository
-runpodctl get models
-
-# Remove a model by owner and name
-runpodctl remove model \
-  --owner your-org \
-  --name lodestones/Chroma
-```
-
-Supplying `--model-path` archives the directory into a `.tar.gz` file, starts a multipart upload, transfers the artifact using the pre-signed URLs, and finalizes the upload automatically.
-
-You can still pass `--create-upload` on its own to inspect the multipart session details without uploading any files.
-
 ## Acknowledgements
 
 - [cobra](https://github.com/spf13/cobra)

api/model.go

@@ -201,6 +201,7 @@ type CreateModelRepoUploadInput struct {
 	Name                string                 `json:"name,omitempty"`
 	FileName            string                 `json:"fileName"`
 	FileSizeBytes       string                 `json:"fileSizeBytes"`
+	ModelVersionHash    string                 `json:"modelVersionHash,omitempty"`
 	PartSizeBytes       string                 `json:"partSizeBytes,omitempty"`
 	ContentType         string                 `json:"contentType,omitempty"`
 	Metadata            map[string]interface{} `json:"metadata,omitempty"`
@@ -647,6 +648,7 @@ func CreateModelRepoUpload(input *CreateModelRepoUploadInput) (*ModelRepoMutatio
 	addString("contentType", input.ContentType)
 	addString("credentialType", input.CredentialType)
 	addString("credentialReference", input.CredentialReference)
+	addString("modelVersionHash", input.ModelVersionHash)
 
 	if len(input.Metadata) > 0 {
 		payload["metadata"] = input.Metadata

cmd/model/addModelToRepo.go

@@ -79,13 +79,11 @@ type modelFile struct {
 // TODO: replace the manual completion call with github.com/aws/aws-sdk-go-v2/service/s3's
 // CompleteMultipartUpload to rely on the SDK for payload formatting and signing logic.
 
-// AddModelToRepoCmd uploads a model to the RunPod model repository.
-// Hidden while the model repository feature is in development and not ready for general use.
 var AddModelToRepoCmd = &cobra.Command{
 	Use:    "model",
 	Args:   cobra.ExactArgs(0),
-	Short:  "upload a model",
-	Long:   "upload a model to the RunPod model repository",
+	Short:  "internal command",
+	Long:   "",
 	Hidden: true,
 	Run: func(cmd *cobra.Command, args []string) {
 		setModelGraphQLTimeout(cmd)
@@ -189,18 +187,18 @@ var AddModelToRepoCmd = &cobra.Command{
 }
 
 func init() {
-	AddModelToRepoCmd.Flags().StringVar(&addModelName, "name", "", "model name within your namespace")
-	AddModelToRepoCmd.Flags().StringVar(&addModelCredentialReference, "credential-reference", "", "reference that allows RunPod to access the model artifact")
-	AddModelToRepoCmd.Flags().StringVar(&addModelCredentialType, "credential-type", "", "type of credential used to access the model artifact (API_KEY, OAUTH_TOKEN, OTHER, USERNAME_PASSWORD)")
-	AddModelToRepoCmd.Flags().StringVar(&addModelVersionStatus, "version-status", "", "status to assign to the uploaded model version")
-	AddModelToRepoCmd.Flags().StringVar(&addModelStatus, "model-status", "", "status to assign to the model record")
-	AddModelToRepoCmd.Flags().BoolVar(&addModelCreateUpload, "create-upload", false, "initialize a multipart upload session for the model artifact")
-	AddModelToRepoCmd.Flags().StringVar(&addModelFileName, "file-name", "", "file name to use for the model artifact upload")
-	AddModelToRepoCmd.Flags().StringVar(&addModelFileSize, "file-size", "", "size of the model artifact in bytes")
-	AddModelToRepoCmd.Flags().StringVar(&addModelPartSize, "part-size", "", "preferred multipart upload part size in bytes")
-	AddModelToRepoCmd.Flags().StringVar(&addModelContentType, "content-type", "", "content type for the model artifact upload")
-	AddModelToRepoCmd.Flags().StringVar(&addModelDirectoryPath, "model-path", "", "path to a directory containing the model files to upload")
-	AddModelToRepoCmd.Flags().StringToStringVar(&addModelMetadata, "metadata", nil, "key=value metadata to associate with the model and upload")
+	AddModelToRepoCmd.Flags().StringVar(&addModelName, "name", "", "")
+	AddModelToRepoCmd.Flags().StringVar(&addModelCredentialReference, "credential-reference", "", "")
+	AddModelToRepoCmd.Flags().StringVar(&addModelCredentialType, "credential-type", "", "")
+	AddModelToRepoCmd.Flags().StringVar(&addModelVersionStatus, "version-status", "", "")
+	AddModelToRepoCmd.Flags().StringVar(&addModelStatus, "model-status", "", "")
+	AddModelToRepoCmd.Flags().BoolVar(&addModelCreateUpload, "create-upload", false, "")
+	AddModelToRepoCmd.Flags().StringVar(&addModelFileName, "file-name", "", "")
+	AddModelToRepoCmd.Flags().StringVar(&addModelFileSize, "file-size", "", "")
+	AddModelToRepoCmd.Flags().StringVar(&addModelPartSize, "part-size", "", "")
+	AddModelToRepoCmd.Flags().StringVar(&addModelContentType, "content-type", "", "")
+	AddModelToRepoCmd.Flags().StringVar(&addModelDirectoryPath, "model-path", "", "")
+	AddModelToRepoCmd.Flags().StringToStringVar(&addModelMetadata, "metadata", nil, "")
 
 	AddModelToRepoCmd.MarkFlagRequired("name") //nolint
 }
@@ -260,10 +258,15 @@ func collectModelFiles(dir string) ([]modelFile, error) {
 }
 
 func uploadModelFiles(files []modelFile, baseInput *api.CreateModelRepoUploadInput) error {
+	var modelVersionHash string
+
 	for _, file := range files {
 		input := *baseInput
 		input.FileName = file.RelativePath
 		input.FileSizeBytes = strconv.FormatInt(file.Size, 10)
+		if modelVersionHash != "" {
+			input.ModelVersionHash = modelVersionHash
+		}
 
 		result, err := api.CreateModelRepoUpload(&input)
 		if err != nil {
@@ -272,6 +275,12 @@ func uploadModelFiles(files []modelFile, baseInput *api.CreateModelRepoUploadInp
 		if result.Upload == nil {
 			return fmt.Errorf("upload response missing upload session details for %s", file.RelativePath)
 		}
+		if modelVersionHash == "" {
+			if result.Version == nil || result.Version.Hash == "" {
+				return fmt.Errorf("upload response missing model version hash for %s", file.RelativePath)
+			}
+			modelVersionHash = result.Version.Hash
+		}
 
 		if err = completeModelUpload(result.Upload, file.AbsolutePath); err != nil {
 			return fmt.Errorf("upload %s: %w", file.RelativePath, err)

cmd/model/getModels.go

@@ -20,13 +20,11 @@ var (
 	getAll      bool
 )
 
-// GetModelsCmd lists models that are available in the RunPod model repository.
-// Hidden while the model repository feature is in development and not ready for general use.
 var GetModelsCmd = &cobra.Command{
 	Use:    "models",
 	Args:   cobra.ExactArgs(0),
-	Short:  "list models",
-	Long:   "list models available in the RunPod model repository",
+	Short:  "internal command",
+	Long:   "",
 	Hidden: true,
 	Run: func(cmd *cobra.Command, args []string) {
 		input := &api.GetModelsInput{
@@ -56,9 +54,9 @@ var GetModelsCmd = &cobra.Command{
 }
 
 func init() {
-	GetModelsCmd.Flags().StringVar(&getProvider, "provider", "", "filter models by provider (e.g. huggingface)")
-	GetModelsCmd.Flags().StringVar(&getName, "name", "", "filter models by name")
-	GetModelsCmd.Flags().BoolVar(&getAll, "all", false, "list all models available in the RunPod repository")
+	GetModelsCmd.Flags().StringVar(&getProvider, "provider", "", "")
+	GetModelsCmd.Flags().StringVar(&getName, "name", "", "")
+	GetModelsCmd.Flags().BoolVar(&getAll, "all", false, "")
 }
 
 func displayModels(models []*api.Model) {

cmd/model/removeModel.go

@@ -14,13 +14,11 @@ var (
 	removeName  string
 )
 
-// RemoveModelCmd removes a model from the RunPod model repository.
-// Hidden while the model repository feature is in development and not ready for general use.
 var RemoveModelCmd = &cobra.Command{
 	Use:    "model",
 	Args:   cobra.ExactArgs(0),
-	Short:  "remove a model",
-	Long:   "remove a model from the RunPod model repository",
+	Short:  "internal command",
+	Long:   "",
 	Hidden: true,
 	Run: func(cmd *cobra.Command, args []string) {
 		if removeOwner == "" || removeName == "" {
@@ -63,8 +61,8 @@ var RemoveModelCmd = &cobra.Command{
 }
 
 func init() {
-	RemoveModelCmd.Flags().StringVar(&removeOwner, "owner", "", "account or namespace that owns the model")
-	RemoveModelCmd.Flags().StringVar(&removeName, "name", "", "model name within the owner namespace")
+	RemoveModelCmd.Flags().StringVar(&removeOwner, "owner", "", "")
+	RemoveModelCmd.Flags().StringVar(&removeName, "name", "", "")
 
 	RemoveModelCmd.MarkFlagRequired("owner") //nolint
 	RemoveModelCmd.MarkFlagRequired("name")  //nolint