- IBMExperimentService.create_experiment(experiment_type, backend_name, metadata=None, experiment_id=None, parent_id=None, job_ids=None, tags=None, notes=None, share_level=None, start_datetime=None, json_encoder=<class 'json.encoder.JSONEncoder'>, **kwargs)¶
Create a new experiment in the database.
str) – Experiment type.
str) – Name of the backend the experiment ran on.
Dict]) – Experiment metadata.
str]) – Experiment ID. It must be in the
uuid4format. One will be generated if not supplied.
str]) – The experiment ID of the parent experiment. The parent experiment must exist, must be on the same backend as the child, and an experiment cannot be its own parent.
str]]) – IDs of experiment jobs.
str]]) – Tags to be associated with the experiment.
str]) – Freeform notes about the experiment.
The level at which the experiment is shared. This determines who can view the experiment (but not update it). This defaults to “private” for new experiments. Possible values include:
private: The experiment is only visible to its owner (default)
project: The experiment is shared within its project
group: The experiment is shared within its group
hub: The experiment is shared within its hub
public: The experiment is shared publicly regardless of provider
None]) – Timestamp when the experiment started, in local time zone.
JSONEncoder]) – Custom JSON encoder to use to encode the experiment.
Any) – Additional experiment attributes that are not supported and will be ignored.
- Return type
IBMExperimentEntryExists – If the experiment already exits.
IBMQApiError – If the request to the server failed.