Skip to main content
App version: 3.4.7

neptune-scale environment variables

Environment variables related to the neptune-scale Python package.

NEPTUNE_DEBUG_MODE​

Python package: neptune-scale

Whether to log debug information into neptune.NUMBER.log files. Use for debugging and troubleshooting purposes.

The default value is False.

Append a line with the export command to your .profile or other shell initialization file:

export NEPTUNE_DEBUG_MODE=True

NEPTUNE_DISABLE_COLORS​

Python package: neptune-scale

Whether to remove the coloring of Neptune console output, such as warnings and other messages printed in the terminal.

The default value is False.

Append a line with the export command to your .profile or other shell initialization file:

export NEPTUNE_DISABLE_COLORS=True

NEPTUNE_LOG_DIRECTORY​

Python package: neptune-scale

The base directory where experiment and run metadata is stored:

  • If the path is absolute, it's used as provided.
  • If the path is relative, it's treated as relative to the current working directory.

The default is .neptune in the current working directory.

Append a line with the export command to your .profile or other shell initialization file:

export NEPTUNE_LOG_DIRECTORY=my/custom/datadir/path

NEPTUNE_LOG_FAILURE_ACTION​

Python package: neptune-scale

When Neptune logs data to the local disk, the operation might fail if the disk is full or another internal error occurs. Use this environment variable to control what happens if Neptune is unable to store the data locally:

  • drop → Drop the data and log an error to stdout.
  • raise → Raise the NeptuneUnableToLogData exception.

The default value is drop.

Append a line with the export command to your .profile or other shell initialization file:

export NEPTUNE_LOG_FAILURE_ACTION=raise

NEPTUNE_MODE​

Python package: neptune-scale

The mode to use Neptune in: async, disabled, or offline.

The default value is aync.

Append a line with the export command to your .profile or other shell initialization file:

export NEPTUNE_MODE=offline

NEPTUNE_SKIP_NON_FINITE_METRICS​

Python package: neptune-scale

If you attempt to log non-finite metric values, such as NaN or Inf, Neptune skips such values without erroring. To make Neptune raise an exception instead, set this environment variable to False.

The default value is True.

Append a line with the export command to your .profile or other shell initialization file:

export NEPTUNE_SKIP_NON_FINITE_METRICS=False