Skip to content

Overview

This page provides steps for installing Comet's Python SDK and describes the main objects and tools it provides.

Install the SDK

There are several ways to install the Comet Python SDK in your system. The easiest way is using pip.

pip install comet_ml
conda install -c anaconda -c conda-forge -c comet_ml comet_ml
%pip install comet_ml

See further instructions for getting started.

Experiment

Experiment is the core class of Comet. An Experiment represents a unit of measurable research that defines a single execution of code with some associated data for example training a model on a single set of hyperparameters.

Learn more about Experiment and related objects in Experiment objects.

Artifact

Artifact objects live in a Comet Workspace and are identified by their name. Each artifact can have multiple versions, identified by their version string numbers. Typical artifact types could be dataset, image, training-data, validation-data, testing-data, and so on.

Learn more in the Artifact Overview.

Optimizer

The Comet Optimizer is used to dynamically find the best set of hyperparameter values that will minimize or maximize a particular metric. Optimizer provides many benefits over traditional hyperparameter optimizer search services because of its integration with Comet's Experiments. In addition, Comet's hyperparameter search has a powerful architecture for customizing your search or sweep. You can easily switch search algorithms, or perform phased searches.

Learn more in the Optimizer Overview.

Command-line utilities

The Comet installation package contains a collection of CLI utilities:

UtilityFunction
comet uploadFor uploading offline experiments
comet optimizeFor easy running of Optimizer scripts in parallel or serial
comet pythonFor injecting import comet_ml into your scripts
comet offlineFor exploring offline experiment ZIP files
comet checkFor checking and debugging your environment
comet modelsFor listing and downloading Registered Models
comet initFor creating example scripts from cookiecutter recipes

Learn more in Command-line utilities.

Extras

  • Troubleshooting addresses errors and warnings you may see while working with the SDK.
  • Comet Python SDK Releases lists all public-facing additions, changes, and deprecations of released comet_ml versions.
Jun. 16, 2022