qiskit_serverless.core.QiskitFunction

class QiskitFunction(title, provider=None, entrypoint=None, working_dir='./', env_vars=None, dependencies=None, description=None, version=None, tags=None, raw_data=None, job_client=None, image=None, validate=True, schema=None)

Serverless QiskitPattern.

Parameters:

• title (str) – program name

• provider (Optional[str]) – Qiskit Function provider reference

• entrypoint (Optional[str]) – is a script that will be executed as a job ex: job.py

• env_vars (Optional[Dict[str, str]]) – env vars

• dependencies (Optional[List[str]]) – list of python dependencies to execute a program

• working_dir (Optional[str]) – directory where entrypoint file is located (max size 50MB)

• description (Optional[str]) – description of a program

• version (Optional[str]) – version of a program

__init__(title, provider=None, entrypoint=None, working_dir='./', env_vars=None, dependencies=None, description=None, version=None, tags=None, raw_data=None, job_client=None, image=None, validate=True, schema=None)

Methods

__init__(title[, provider, entrypoint, ...])
from_json(data)	Reconstructs QiskitPattern from dictionary.
get_jobs()	List of jobs created in this function.
jobs()	List of jobs created in this function.
run(**kwargs)	Run function

Attributes

dependencies
description
entrypoint
env_vars
image
job_client
provider
raw_data
schema
tags
validate
version
working_dir
title