Comet
Logging and visualizing experiments with Comet.
When would you want to use it?
You should use the Comet Experiment Tracker:
if you have already been using Comet to track experiment results for your project and would like to continue doing so as you are incorporating MLOps workflows and best practices in your project through ZenML.
if you are looking for a more visually interactive way of navigating the results produced from your ZenML pipeline runs (e.g., models, metrics, datasets)
if you would like to connect ZenML to Comet to share the artifacts and metrics logged by your pipelines with your team, organization, or external stakeholders
How do you deploy it?
The Comet Experiment Tracker flavor is provided by the Comet ZenML integration. You need to install it on your local machine to be able to register a Comet Experiment Tracker and add it to your stack:
The Comet Experiment Tracker needs to be configured with the credentials required to connect to the Comet platform using one of the available authentication methods.
Authentication Methods
You need to configure the following credentials for authentication to the Comet platform:
api_key
: Mandatory API key token of your Comet account.project_name
: The name of the project where you're sending the new experiment. If the project is not specified, the experiment is put in the default project associated with your API key.workspace
: Optional. The name of the workspace where your project is located. If not specified, the default workspace associated with your API key will be used.
This option configures the credentials for the Comet platform directly as stack component attributes.
This is not recommended for production settings as the credentials won't be stored securely and will be clearly visible in the stack configuration.
How do you use it?
To be able to log information from a ZenML pipeline step using the Comet Experiment Tracker component in the active stack, you need to enable an experiment tracker using the @step
decorator. Then use Comet logging capabilities as you would normally do, e.g.:
Comet UI
Comet comes with a web-based UI that you can use to find further details about your tracked experiments.
Every ZenML step that uses Comet should create a separate experiment which you can inspect in the Comet UI.
You can find the URL of the Comet experiment linked to a specific ZenML run via the metadata of the step in which the experiment tracker was used:
Alternatively, you can see an overview of all experiments at https://www.comet.com/{WORKSPACE_NAME}/{PROJECT_NAME}/experiments/
.
The naming convention of each Comet experiment is {pipeline_run_name}_{step_name}
(e.g., comet_example_pipeline-25_Apr_22-20_06_33_535737_my_step
), and each experiment will be tagged with both pipeline_name
and pipeline_run_name
, which you can use to group and filter experiments.
Additional configuration
For additional configuration of the Comet experiment tracker, you can pass CometExperimentTrackerSettings
to provide additional tags for your experiments:
Last updated