Skip to main content

​
Initialize an Experiment

​
Haiqu.init(experiment_ctx, experiment_description=”)

Set the current experiment (create or use existing own or shared experiment). If an experiment with this name doesn’t exist yet, it will be created with the given description. Most objects (e.g. circuits) and actions (e.g. running a job) must be associated with an experiment. The default experiment will be used if one is not set explicitly.
  • Parameters:
    • experiment_ctx (str) — The experiment name or ID of the shared experiment.
    • experiment_description (str) — An optional text description of the experiment. Only used when creating the experiment.
  • Returns: Status message, URL to view the experiment on the dashboard.
  • Return type: str

​
Examples

>>> haiqu.init("Example Experiment", "The experiment to use for all examples.")
'Set current experiment to: Example Experiment. View on Dashboard: https://dashboard.haiqu.ai/experiments/...'
Shared experiment can be set by its ID: 
>>> haiqu.init("exp-12345678-1234-5678-1234-567812345678")

​
Update the current experiment metadata

​
Haiqu.update_experiment(name=None, description=None)

Update the current experiment metadata. Set the current experiment if wasn’t set.
  • Parameters:
    • name (str | None) — Updated experiment name. Defaults to the current name.
    • description (str | None) — Updated experiment description. Defaults to the current description.
  • Returns: Status message.
  • Return type: str