If there is a running experiment, finalize it and flush all pending data to the Comet server. See end for more details. If no experiment was running, this does nothing.

If there is a running experiment, flush all pending data to the Comet server. See flush for more details. If no experiment was running, this does nothing.

Returns:

• Optional[bool] –

  If there is a running experiment, returns a Boolean True or False indicating whether the flush was successful or not. If no experiment was running, returns None.

Returns a currently running experiment or None if there is no such.

Returns:

• Optional[BaseExperiment] –

  Returns the running experiment or None.

1
2
3

import comet_ml

experiment = comet_ml.get_running_experiment()

Return an upload callback that can be used to upload offline archive when an online Experiment has fallback to offline.

See also: comet_ml.Experiment.set_offline_zip_uploader

The AWS credentials must be present either via environment variables or in the user home directory in format supported by boto3 client as described at: https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html

Parameters:

• bucket (str) –

  The bucket name to which the PUT action was initiated.

• key (Optional[str], default: None ) –

  Object key for which the PUT action was initiated. If not provided the automatically generated file name will be used.

• kwargs –

  The additional parameters supported by boto3 client as described here: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/s3/client/put_object.html

Returns:

• UploadCallback –

  A callback to be used to upload offline experiment data to S3.

For example:

from comet_ml import get_s3_uploader

upload_callback = get_s3_uploader(bucket="my_bucket")
experiment = Experiment()
experiment.set_offline_zip_uploader(upload_callback)