Skip to content

What you can log and display#

Neptune supports logging of various types of metadata.

The display options in the Neptune app depend on a couple of things:

  1. The data type and format
  2. The method you use for logging it to Neptune

Model-building metadata#

Artifacts and data versioning#

You can generally log metadata about any file with the track_files() method. This is the handiest way to track and version artifacts that you store elsewhere, such as datasets and model files.

You should only use upload() for files that you specifically want to view and interact with in Neptune.

Data Version Control (DVC)#

To display DVC files in Neptune, specify which DVC files you would like to log when creating a run.

For example, to log all the DVC files from your working directory and all subdirectories, pass **/*.dvc to the source_files argument:

run = neptune.init_run(source_files=["**/*.dvc"])

Files#

Related

Uploading files – how to generally upload any files from disk.

You can upload and display a variety of file formats.

For details, see:

Source code#

The following is automatically logged in the source_code namespace:

  • entrypoint: filename of the script you executed, like main.py
  • files: the content of the script you executed

For details, see Source code logging.

See example in Neptune 

Notebook snapshots#

Neptune supports notebook snapshotting for JupyterLab and Jupyter Notebook with the help of an extension.

For setup instructions, see Working with Jupyter.

If you're running a Jupyter notebook locally – for example, in Visual Studio Code – you can capture the notebook contents by passing the path of the notebook to the source_code argument of the init_run() method.

Note

Netpune can't snapshot the code you execute in cloud environments, such as Google Colab.

For details, see Logging source code: Jupyter notebooks.

Git information#

If you have Git initialized in your project directory, Neptune extracts some information from the .git directory and logs it under the source_code/git namespace.

For details, see What is logged automatically: Git information.

See example in Neptune 

System metrics#

Neptune logs certain system metrics, such as hardware consumption, automatically.

For details, see System metrics.