0.29.1
Languages
English
Japanese
German
Korean
Portuguese, Brazilian
French
Tamil
Previous Releases
0.19
0.24
0.25
0.26
0.27
0.28
0.29
Table of Contents
Shortcuts

qiskit.providers.ibmq.experiment.IBMExperimentService.create_experiment

IBMExperimentService.create_experiment(experiment_type, backend_name, metadata=None, experiment_id=None, job_ids=None, tags=None, notes=None, share_level=None, start_datetime=None, json_encoder=<class 'json.encoder.JSONEncoder'>, **kwargs)[source]

Create a new experiment in the database.

Parameters

  • experiment_type (str) – Experiment type.

  • backend_name (str) – Name of the backend the experiment ran on.

  • metadata (Optional[Dict]) – Experiment metadata.

  • experiment_id (Optional[str]) – Experiment ID. It must be in the uuid4 format. One will be generated if not supplied.

  • job_ids (Optional[List[str]]) – IDs of experiment jobs.

  • tags (Optional[List[str]]) – Tags to be associated with the experiment.

  • notes (Optional[str]) – Freeform notes about the experiment.

  • share_level (Union[str, ExperimentShareLevel, None]) –

    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

  • start_datetime (Union[str, datetime, None]) – Timestamp when the experiment started, in local time zone.

  • json_encoder (Type[JSONEncoder]) – Custom JSON encoder to use to encode the experiment.

  • kwargs (Any) – Additional experiment attributes that are not supported and will be ignored.

Return type

str

Returns

Experiment ID.

Raises