Configure the Comet SDK¶

When getting started with Comet experiment tracking, you need to make sure your API key is correctly configured and you may also want to make sure that you have customized Comet exactly for the kind of experiment logging you want.

Set the API key¶

You should use the login() method to provide your API key to Comet, either from command line or in your Python code:

1

comet login

1
2
3

import comet_ml

comet_ml.login()

With either approach, the login() method interactively prompts you for your API key which, once provided, is automatically accessed from your ~/.comet.config configuration file.

Configure Comet logging¶

Comet has a wide range of configuration options allowing you to enable and disable features in a very granular way.

You can configure the comet_ml Python SDK in three ways:

1. From the .comet.config file: You can directly edit the configuration file, which is automatically created for you when running login() as detailed in the section above.
   This is the recommended approach.
2. With Comet environment variables: You can define the Comet configuration as environment variables from terminal or in your Python code directly with the os functionalities.
   Consider this approach when it is not convenient to create and store a configuration file.
3. In your Python code: You can specify the configuration when creating a Comet Experiment through the comet_ml.start method.
   Consider this approach when wanting to enable or disable features in-place for the single Experiment only.

From the .comet.config file¶

The ~/.comet.config configuration file follows the format:

[section_name]
config_name=value

So if you wanted to add your API key to your configuration file, you could set it using:

[comet]
api_key="your_api_key"

Find the list of Comet configuration names in the Explore the configuration options section.

With Comet environment variables¶

You can set environment variables to update the Comet configuration temporarily for the current session or permanently for all sessions.

For more information and instructions, read more about setting environment variables in Python.

Comet environment variables are capitalized, and follow the format:

COMET_<parameter-name>

For example, you could set the Comet workspace by running export COMET_WORKSPACE="your_workspace".

Find the list of Comet environment parameter names in the Explore the configuration options section.

In your Python code¶

The comet_ml.start function supports a wide set of arguments that allow you to customize the automated logging performed by Comet by setting experiment configuration using ExperimentConfig:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

import comet_ml

comet_ml.start(
    project_name="my_project",
    experiment_config=comet_ml.ExperimentConfig(
        name="my_experiment",
        tags=["my_tag"],
        parse_args=False
    ),
)

Many of the configuration options described in the Explore Comet configuration options section below can be set with this function. Please refer to the linked reference for a complete list of supported configuration options.

Explore Comet configuration options¶

When first setting up Comet for your project / workspace / team, you may find yourself choosing how Comet automatically logs information for you and what information it should log.

The options you are likely to update more frequently are listed at the top and highlighted in bold.

In addition, the following configurations are available only as environment variables: