nbox.lmao.exp

NimbleBox LMAO is our general purpose observability tool for any kind of computation you might have.

Classes

(project_name:str,project_id:str,experiment_id:str,metadata:Dict[str, Any],save_to_relic:bool,enable_system_monitoring:bool,store_git_details:bool)

Parameters

project_name -
The name of the project. Defaults to "".
project_id -
The id of the project. Defaults to "".
experiment_id -
The id of the experiment. Defaults to "".
metadata -
Any metadata that you want to store. Defaults to {}.
save_to_relic -
Whether to save the data to the relic. Defaults to False.
enable_system_monitoring -
Whether to enable system monitoring. Defaults to False.
store_git_details -
Whether to store git details. Defaults to True.

Lmao is the client library for using NimbleBox Monitoring. It talks to your monitoring instance running on your build and stores the information in the project_name or project_id. This object inherently doesn't care what you are actually logging and rather concerns itself with ensuring storage.

Note: All arguments are optional, if the _lmaoConfig.kv is set.

Get the underlying Relic for more advanced usage patterns.

Log a single level dictionary to the platform at any given step. This function does not really care about the information that is being logged, it just logs it to the platform.

End the run to declare it complete. This is more of a convinience function than anything else. For example when you are monitoring a live API you may never know when the experiment is complete. This function locks the experiment name so it can't be modified.

(files:None)

Parameters

files -
The list of files to save. This can be a list of files or a list of folders. If a folder is passed, all the files in the folder will be uploaded.