qiskit.providers.ibmq.experiment.IBMExperimentService.create_experiment¶
- 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)[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 theuuid4
format. One will be generated if not supplied.parent_id (
Optional
[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.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
IBMExperimentEntryExists -- If the experiment already exits.
IBMQApiError -- If the request to the server failed.