feat: support for list in inputs

[dkhokhlov]

• added support for list[File] and list[Path]
• only in cog, still need to add list support in web UI
• updated docs/python.md

$ echo test1 > 1.txt
$ echo test2 > 2.txt
$ cat predict.py
from cog import BasePredictor, Path

class Predictor(BasePredictor):
   def predict(self, paths: list[Path]) -> str:
       output_parts = [] 
       for path in paths:
           with open(path) as f:
             output_parts.append(f.read())
       return "".join(output_parts)

$ cog predict -i paths=@1.txt -i paths=@2.txt

Running prediction...
test1

test2

• Note the repeated inputs with the same name "paths" which constitute the list

Ref:

• Array as inputs and outputs using Input method #527
• https://linear.app/replicate/issue/PRO-1153/add-support-for-list[file]-input-to-web-ui

[zeke]

This is awesome, @dkhokhlov!

Can you take a shot at documenting this in docs/python.md ?

Let me know if you want help with that.

[nickstenning]

I haven't finished going through this yet, but I figure I should release the comments I've made already to get started :)

[nickstenning]

This import moved, and it should move back :)

[nickstenning]

Suggested change

[dkhokhlov]

this change is required by one of new linters in make lint:
python -m ruff format --check python
and reformatted by:
python -m ruff format python/cog/command/openapi_schema.py

[nickstenning]

Changes like this suggest that you don't have your editor set up to do autoformatting the same as script/format. Would you look into that?

[dkhokhlov]

this change is required by one of new linters in our make lint:
python -m ruff python/cog
and reformatted by:
python -m ruff format python/cog/schema.py

[nickstenning]

Two small points:

1. it's nice to use any rather than interface{} these days
2. this doesn't need to be a pointer -- slices are already pointer types

[nickstenning]

It's not a big deal, but it would be more conventional when you know the length of the slice beforehand to do something like

Suggested change

	var dataURLs []string
	for _, elem := range *input.Array {
	if str, ok := elem.(string); ok && strings.HasPrefix(str, "@") {
	filePath := str[1:] // Remove '@' prefix
	dataURL, err := fileToDataURL(filePath)
	if err != nil {
	return keyVals, err
	}
	dataURLs = append(dataURLs, dataURL)
	} else if ok {
	// Directly use the string if it's not a file path
	dataURLs = append(dataURLs, str)
	}
	}
	keyVals[key] = dataURLs
	dataURLs := make([]string, len(input.Array))
	for i, elem := range input.Array {
	if str, ok := elem.(string); ok && strings.HasPrefix(str, "@") {
	filePath := str[1:] // Remove '@' prefix
	dataURL, err := fileToDataURL(filePath)
	if err != nil {
	return keyVals, err
	}
	dataURLs[i] = dataURL
	} else if ok {
	// Directly use the string if it's not a file path
	dataURLs[i] = str
	}
	}
	keyVals[key] = dataURLs

[nickstenning]

Is JSON unmarshalling right here? That means the strings have to be quoted, which is inconsistent with the other types.

For example, I can do

cog predict hello-world -i text=world

or

cog predict resnet -i image=@input.jpg

but with this implementation, the following will throw an error

cog predict mymodel -i names=[foo,bar]

I think there are two possibilities here. Either:

1. do the work to allow individual strings to be either quoted or unquoted, so that they're consistent with the rest of the interface, or
2. change approach to do arrays by just repeating inputs, e.g. cog predict ... -i names=one -i names=two

[dkhokhlov]

I chose repeated inputs. Good idea. Thanks.

[dkhokhlov]

Can you take a shot at documenting this in docs/python.md ?

Let me know if you want help with that.

@zeke
added new section about List type with cog cli example in docs/python.md:
https://github.com/replicate/cog/pull/1561/files#diff-3576f8388f597edf93166fb888bc0c6c7ebca8aba465d941c17b3c1804b99cab
please feel free to polish/add more.