# License: BSD 3 clause
"""Utility methods to print system info for debugging.
adapted from
:func: `sklearn.show_versions` and `sktime.show_versions`
"""
__all__ = ["show_versions"]
import importlib
import platform
import sys
[docs]
def _get_sys_info():
"""System information.
Return
------
sys_info : dict
system and Python version information
"""
python = sys.version.replace("\n", " ")
blob = [
("python", python),
("executable", sys.executable),
("machine", platform.platform()),
]
return dict(blob)
# dependencies to print versions of, by default
DEFAULT_DEPS_TO_SHOW = [
"pip",
"pytorch-forecasting",
"torch",
"lightning",
"numpy",
"scipy",
"pandas",
"cpflows",
"matplotlib",
"optuna",
"optuna-integration",
"pytorch_optimizer",
"scikit-learn",
"scikit-base",
"statsmodels",
]
[docs]
def _get_deps_info(deps=None, source="distributions"):
"""Overview of the installed version of main dependencies.
Parameters
----------
deps : optional, list of strings with package names
if None, behaves as deps = ["sktime"].
source : str, optional one of "distributions" (default) or "import"
source of version information
* "distributions" - uses importlib.distributions. In this case,
strings in deps are assumed to be PEP 440 package strings,
e.g., scikit-learn, not sklearn.
* "import" - uses the __version__ attribute of the module.
In this case, strings in deps are assumed to be import names,
e.g., sklearn, not scikit-learn.
Returns
-------
deps_info: dict
version information on libraries in `deps`
keys are package names, import names if source is "import",
and PEP 440 package strings if source is "distributions";
values are PEP 440 version strings
of the import as present in the current python environment
"""
if deps is None:
deps = ["pytorch-forecasting"]
if source == "distributions":
from pytorch_forecasting.utils._dependencies import _get_installed_packages
KEY_ALIAS = {"sklearn": "scikit-learn", "skbase": "scikit-base"}
pkgs = _get_installed_packages()
deps_info = {}
for modname in deps:
pkg_name = KEY_ALIAS.get(modname, modname)
deps_info[modname] = pkgs.get(pkg_name, None)
return deps_info
def get_version(module):
return getattr(module, "__version__", None)
deps_info = {}
for modname in deps:
try:
if modname in sys.modules:
mod = sys.modules[modname]
else:
mod = importlib.import_module(modname)
except ImportError:
deps_info[modname] = None
else:
ver = get_version(mod)
deps_info[modname] = ver
return deps_info
[docs]
def show_versions():
"""Print python version, OS version, sktime version, selected dependency versions.
Pretty prints:
* python version of environment
* python executable location
* OS version
* list of import name and version number for selected python dependencies
Developer note:
Python version/executable and OS version are from `_get_sys_info`
Package versions are retrieved by `_get_deps_info`
Selected dependencies are as in the DEFAULT_DEPS_TO_SHOW variable
"""
sys_info = _get_sys_info()
deps_info = _get_deps_info(deps=DEFAULT_DEPS_TO_SHOW)
print("\nSystem:") # noqa: T001, T201
for k, stat in sys_info.items():
print(f"{k:>10}: {stat}") # noqa: T001, T201
print("\nPython dependencies:") # noqa: T001, T201
for k, stat in deps_info.items():
print(f"{k:>13}: {stat}") # noqa: T001, T201
