Documentation for Env Module

check_environment()

Logs the current environment configuration for the NEBULA platform.

This function gathers and logs information about the operating system, hardware, Python version, PyTorch version (if installed), CPU configuration, and GPU configuration (if applicable). It provides insights into the system's capabilities and current usage statistics.

Returns:

Type	Description
	None

Notes

• The function logs the NEBULA platform version using the __version__ variable.
• It checks the system's CPU load, available memory, and detailed GPU statistics using the pynvml library if running on Windows or Linux.
• If any of the libraries required for gathering information (like torch, psutil, or pynvml) are not installed, appropriate log messages will be generated indicating the absence of that information.
• If any unexpected error occurs during execution, it will be logged as an exception.

Source code in nebula/addons/env.py

def check_environment():
    """
    Logs the current environment configuration for the NEBULA platform.

    This function gathers and logs information about the operating system, hardware, Python version,
    PyTorch version (if installed), CPU configuration, and GPU configuration (if applicable). It provides
    insights into the system's capabilities and current usage statistics.

    Returns:
        None

    Notes:
        - The function logs the NEBULA platform version using the `__version__` variable.
        - It checks the system's CPU load, available memory, and detailed GPU statistics using the `pynvml`
          library if running on Windows or Linux.
        - If any of the libraries required for gathering information (like `torch`, `psutil`, or `pynvml`)
          are not installed, appropriate log messages will be generated indicating the absence of that information.
        - If any unexpected error occurs during execution, it will be logged as an exception.
    """
    logging.info(f"NEBULA Platform version: {__version__}")
    # check_version()

    logging.info("======== Running Environment ========")
    logging.info("OS: " + platform.platform())
    logging.info("Hardware: " + platform.machine())
    logging.info("Python version: " + sys.version)

    try:
        import torch

        logging.info("PyTorch version: " + torch.__version__)
    except ImportError:
        logging.info("PyTorch is not installed properly")
    except Exception:  # noqa: S110
        pass

    logging.info("======== CPU Configuration ========")
    try:
        import psutil

        load1, load5, load15 = psutil.getloadavg()
        cpu_usage = (load15 / os.cpu_count()) * 100

        logging.info(f"The CPU usage is : {cpu_usage:.0f}%")
        logging.info(
            f"Available CPU Memory: {psutil.virtual_memory().available / 1024 / 1024 / 1024:.1f} G / {psutil.virtual_memory().total / 1024 / 1024 / 1024}G"
        )
    except ImportError:
        logging.info("No CPU information available")
    except Exception:  # noqa: S110
        pass

    if sys.platform == "win32" or sys.platform == "linux":
        logging.info("======== GPU Configuration ========")
        try:
            import pynvml

            pynvml.nvmlInit()
            devices = pynvml.nvmlDeviceGetCount()
            for i in range(devices):
                handle = pynvml.nvmlDeviceGetHandleByIndex(i)
                gpu_percent = pynvml.nvmlDeviceGetUtilizationRates(handle).gpu
                gpu_temp = pynvml.nvmlDeviceGetTemperature(handle, pynvml.NVML_TEMPERATURE_GPU)
                gpu_mem = pynvml.nvmlDeviceGetMemoryInfo(handle)
                gpu_mem_percent = gpu_mem.used / gpu_mem.total * 100
                gpu_power = pynvml.nvmlDeviceGetPowerUsage(handle) / 1000.0
                gpu_clocks = pynvml.nvmlDeviceGetClockInfo(handle, pynvml.NVML_CLOCK_SM)
                gpu_memory_clocks = pynvml.nvmlDeviceGetClockInfo(handle, pynvml.NVML_CLOCK_MEM)
                gpu_utilization = pynvml.nvmlDeviceGetUtilizationRates(handle)
                gpu_fan_speed = pynvml.nvmlDeviceGetFanSpeed(handle)
                logging.info(f"GPU{i} percent: {gpu_percent}")
                logging.info(f"GPU{i} temp: {gpu_temp}")
                logging.info(f"GPU{i} mem percent: {gpu_mem_percent}")
                logging.info(f"GPU{i} power: {gpu_power}")
                logging.info(f"GPU{i} clocks: {gpu_clocks}")
                logging.info(f"GPU{i} memory clocks: {gpu_memory_clocks}")
                logging.info(f"GPU{i} utilization: {gpu_utilization.gpu}")
                logging.info(f"GPU{i} fan speed: {gpu_fan_speed}")
        except ImportError:
            logging.info("pynvml module not found, GPU information unavailable")
        except Exception:  # noqa: S110
            pass
    else:
        logging.info("GPU information unavailable")

check_version()

Checks the current version of NEBULA and compares it with the latest version available in the repository.

This function retrieves the latest NEBULA version from the specified GitHub repository and compares it with the version defined in the local NEBULA package. If the versions do not match, it logs a message prompting the user to update to the latest version.

Returns:

Type	Description
	None

Raises:

Type	Description
SystemExit	If the version check fails or an exception occurs during the request.

Notes

• The version information is expected to be defined in the __init__.py file of the NEBULA package using the __version__ variable.
• If the latest version is not the same as the local version, the program will exit after logging the necessary information.
• An exception during the request will be logged, and the program will also exit.

Source code in nebula/addons/env.py

def check_version():
    """
    Checks the current version of NEBULA and compares it with the latest version available in the repository.

    This function retrieves the latest NEBULA version from the specified GitHub repository and compares
    it with the version defined in the local NEBULA package. If the versions do not match, it logs a message
    prompting the user to update to the latest version.

    Returns:
        None

    Raises:
        SystemExit: If the version check fails or an exception occurs during the request.

    Notes:
        - The version information is expected to be defined in the `__init__.py` file of the NEBULA package
          using the `__version__` variable.
        - If the latest version is not the same as the local version, the program will exit after logging
          the necessary information.
        - An exception during the request will be logged, and the program will also exit.
    """
    logging.info("Checking NEBULA version...")
    try:
        r = requests.get("https://raw.githubusercontent.com/CyberDataLab/nebula/main/nebula/__init__.py", timeout=5)
        if r.status_code == 200:
            version = re.search(r'^__version__\s*=\s*[\'"]([^\'"]*)[\'"]', r.text, re.MULTILINE).group(1)
            if version != __version__:
                logging.info(
                    f"Your NEBULA version is {__version__} and the latest version is {version}. Please update your NEBULA version."
                )
                logging.info(
                    "You can update your NEBULA version downloading the latest version from https://github.com/CyberDataLab/nebula"
                )
                sys.exit(0)
            else:
                logging.info(f"Your NEBULA version is {__version__} and it is the latest version.")
    except Exception:
        logging.exception("Error while checking NEBULA version")
        sys.exit(0)