Custom base images for functions

[IceKhan13]

Summary

Allows usage of custom images for function execution

Details

User will need to do following steps:

• implement function template file
• build docker image with template file and push
• run function

Function template

# runner.py
class Runner:
    def run(self, arguments: dict) -> dict:
        # this is just an example
        # your function can call for other modules, function, etc.
        return {
            **arguments,
            **{
                "answer": 42
            }
        }

Dockerfile

FROM icr.io/quantum-public/quantum-serverless-ray-node:0.9.0-py39

# install all necessary dependencies for your custom image

# copy our function implementation in `/runner.py` of the docker image
RUN mkdir /runner
COPY ./runner.py /runner/runner.py

Upload funciton with custom image

serverless = ServerlessClient(...)

function_with_custom_image = QiskitFunction(
    title="custom-image-function",
    image="my-custom-function-image:latest"
)

serverless.upload(function_with_custom_image)

[psschwei]

nit: the rest of the procedural notebooks are in docs/getting_started/experimental, whereas the other ones here (VQE / QAOA) are more application-like ... which begs the question of whether we need to think about how to organize our documentation (i.e. should we start making sections for end users, for function providers, etc.)

[psschwei]

And the pending move to the qiskit org probably provides a good cover for a docs reorg ...

[IceKhan13]

Agree with you :)
I also was trying to figure out where to put those. I was trying to decide between examples or deployment

[IceKhan13]

Finally moved it to deployment as rst document.

[psschwei]

Ideally we should also add this to the e2e tests too

[IceKhan13]

Created separate issue for that #1316

Not sure yet how to make e2e, since it will not work in local mode and in docker compose as well.

[psschwei]

It might be worth creating a template repo in the Qiskit org to store these files so folks can make use of it when writing their own functions. Also would give us a little insight into some of the third party functions out there in the wild

[IceKhan13]

Good suggestion! I like it! Templates in github are very powerful

[Tansito]

Thank you so much, @IceKhan13 I left a couple of comments but reviewing my comments + @psschwei comments is almost ready to merge 🙏

[Tansito]

Regardless @psschwei comments from my part LGTM! 🥳

Thanks @IceKhan13 !!

[akihikokuroda]

unrelated question. Is the arguments for the program used?

[IceKhan13]

probably you are right and it is not used anymore. I will look it up and try to fix it in following PRs

[akihikokuroda]

Is it good to put a waring message when both image and entrypoint are set?

[IceKhan13]

I think it would be better to move all validation to QiskitFunction itself to reduce boilderplate code. Created an iissue for that. #1315

Thanks for suggestion!

[akihikokuroda]

Great work! Thanks!