mlflow.system_metrics

System metrics logging module.

mlflow.system_metrics.disable_system_metrics_logging()

Note

Experimental: This function may change or be removed in a future release without warning.

Disable system metrics logging globally.

Calling this function will disable system metrics logging globally, but users can still opt in system metrics logging for individual runs by mlflow.start_run(log_system_metrics=True).

mlflow.system_metrics.enable_system_metrics_logging()

Note

Experimental: This function may change or be removed in a future release without warning.

Enable system metrics logging globally.

Calling this function will enable system metrics logging globally, but users can still opt out system metrics logging for individual runs by mlflow.start_run(log_system_metrics=False).

mlflow.system_metrics.set_system_metrics_node_id(node_id)

Note

Experimental: This function may change or be removed in a future release without warning.

Set the system metrics node id.

node_id is the identifier of the machine where the metrics are collected. This is useful in multi-node (distributed training) setup.

mlflow.system_metrics.set_system_metrics_samples_before_logging(samples)

Note

Experimental: This function may change or be removed in a future release without warning.

Set the number of samples before logging system metrics.

Every time samples samples have been collected, the system metrics will be logged to mlflow. By default samples=1.

mlflow.system_metrics.set_system_metrics_sampling_interval(interval)

Note

Experimental: This function may change or be removed in a future release without warning.

Set the system metrics sampling interval.

Every interval seconds, the system metrics will be collected. By default interval=10.