User Guide

  • 2021.4
  • 10/01/2021
  • Public Content

Run a Specific Set of Checks

You can adjust the set of launched checks by using the –filter option. Pass the required Tag to run a group of checks or the name of the desired check to run a single check. Use the “all” keyword to run all checks.

Run all checks

python3 diagnostics.py --filter all
Example output
Checks results: ============================================================================================================================================================================================================= Check name: debugger_sys_check Description : System check for debugger found in /opt/intel/oneapi/debugger/latest/sys_check/sys_check.sh Result status: PASS ============================================================================================================================================================================================================= ============================================================================================================================================================================================================= Check name: inspector_sys_check Description : System check for inspector found in /opt/intel/oneapi/inspector/latest/sys_check/sys_check.sh Result status: PASS ============================================================================================================================================================================================================= ============================================================================================================================================================================================================= Check name: advisor_sys_check Description : System check for advisor found in /opt/intel/oneapi/advisor/latest/sys_check/sys_check.sh Result status: PASS ============================================================================================================================================================================================================= ============================================================================================================================================================================================================= Check name: compiler_sys_check Description : System check for compiler found in /opt/intel/oneapi/compiler/latest/sys_check/sys_check.sh Result status: PASS ============================================================================================================================================================================================================= ============================================================================================================================================================================================================= Check name: vtune_sys_check Description : System check for vtune found in /opt/intel/oneapi/vtune/latest/sys_check/sys_check.sh Result status: PASS ============================================================================================================================================================================================================= ============================================================================================================================================================================================================= Check name: intelpython_sys_check Description : System check for intelpython found in /opt/intel/oneapi/intelpython/latest/sys_check/sys_check.sh Result status: PASS ============================================================================================================================================================================================================= ============================================================================================================================================================================================================= Check name: dpcpp-ct_sys_check Description : System check for dpcpp-ct found in /opt/intel/oneapi/dpcpp-ct/latest/sys_check/sys_check.sh Result status: PASS ============================================================================================================================================================================================================= ============================================================================================================================================================================================================= Check name: tbb_sys_check Description : System check for tbb found in /opt/intel/oneapi/tbb/latest/sys_check/sys_check.sh Result status: PASS ============================================================================================================================================================================================================= ============================================================================================================================================================================================================= Check name: oneapi_app_check Description : This is a module for gettings oneAPI product information. Result status: PASS ============================================================================================================================================================================================================= ============================================================================================================================================================================================================= Check name: gpu_backend_check Description : This is a module for getting GPU information. Result status: PASS ============================================================================================================================================================================================================= ============================================================================================================================================================================================================= Check name: vtune_check Description : Check system set up for GPU analysis. Result status: PASS ============================================================================================================================================================================================================= ============================================================================================================================================================================================================= Check name: gcc_version_check Description : Contains information about GCC compiler version. Result status: PASS ============================================================================================================================================================================================================= ============================================================================================================================================================================================================= Check name: intel_gpu_detector_check Description : Detect which Intel GPU is on the system. Result status: PASS ============================================================================================================================================================================================================= ============================================================================================================================================================================================================= Check name: base_system_check Description : Contains information about hostname, CPU, BIOS and operating system. Result status: PASS ============================================================================================================================================================================================================= ============================================================================================================================================================================================================= Check name: hangcheck_check Description : Check that GPU hangcheck is disabled to allow long-running jobs. Result status: PASS ============================================================================================================================================================================================================= ============================================================================================================================================================================================================= Check name: user_group_check Description : Check that the current user is in the same group as the GPU(s). Result status: PASS ============================================================================================================================================================================================================= ============================================================================================================================================================================================================= Check name: kernel_boot_options_check Description : Contains kernel boot options. Result status: PASS ============================================================================================================================================================================================================= ============================================================================================================================================================================================================= Check name: gpu_metrics_check Description : Check that GPU metrics are good. Result status: PASS ============================================================================================================================================================================================================= ============================================================================================================================================================================================================= Check name: oneapi_gpu_check Description : Contains information about the readiness to run GPU workloads. Result status: PASS ============================================================================================================================================================================================================= ============================================================================================================================================================================================================= Check name: advisor_check Description : Check is setting up an environment to analyze GPU kernels. Result status: PASS ============================================================================================================================================================================================================= ============================================================================================================================================================================================================= Check name: user_resources_limits_check Description : Contains information about user resources limits Result status: PASS ============================================================================================================================================================================================================= 21 CHECKS, 21 PASSED, 0 FAILED, 0 WARNING, 0 ERROR Console output file: /home/test/intel/diagnostics/diagnostics_nnladtldev-01_20210831-141425.txt JSON output file: /home/test/intel/diagnostics/diagnostics_nnladtldev-01_20210831-141425.json

Run a Group of Checks Using the Type of Check

To run a group of checks, use the Tag from Description of Checks for the type of check you want to run. For example, to run all checks with the
gpu
Tag:
python3 diagnostics.py --filter gpu
Example output
Checks results: ============================================================================================================================================================================================================= Check name: gpu_backend_check Description : This is a module for getting GPU information. Result status: PASS ============================================================================================================================================================================================================= ============================================================================================================================================================================================================= Check name: vtune_check Description : Check system set up for GPU analysis. Result status: PASS ============================================================================================================================================================================================================= ============================================================================================================================================================================================================= Check name: intel_gpu_detector_check Description : Detect which Intel GPU is on the system. Result status: PASS ============================================================================================================================================================================================================= ============================================================================================================================================================================================================= Check name: hangcheck_check Description : Check that GPU hangcheck is disabled to allow long-running jobs. Result status: PASS ============================================================================================================================================================================================================= ============================================================================================================================================================================================================= Check name: user_group_check Description : Check that the current user is in the same group as the GPU(s). Result status: PASS ============================================================================================================================================================================================================= ============================================================================================================================================================================================================= Check name: gpu_metrics_check Description : Check that GPU metrics are good. Result status: PASS ============================================================================================================================================================================================================= ============================================================================================================================================================================================================= Check name: oneapi_gpu_check Description : Contains information about the readiness to run GPU workloads. Result status: PASS ============================================================================================================================================================================================================= ============================================================================================================================================================================================================= Check name: advisor_check Description : Check is setting up an environment to analyze GPU kernels. Result status: PASS ============================================================================================================================================================================================================= 8 CHECKS, 8 PASSED, 0 FAILED, 0 WARNING, 0 ERROR Console output file: /home/test/intel/diagnostics/diagnostics_nnladtldev-01_20210831-141635.txt JSON output file: /home/test/intel/diagnostics/diagnostics_nnladtldev-01_20210831-141635.json

Run a Specific Check

To run a specific check, use the check name from the Description of Checks table. For example, to run the gcc version check:
python3 diagnostics.py --filter gcc_version_check
Example output
Checks results: ============================================================================================================================================================================================================= Check name: gcc_version_check Description : Contains information about GCC compiler version. Result status: PASS ============================================================================================================================================================================================================= 1 CHECKS, 1 PASSED, 0 FAILED, 0 WARNING, 0 ERROR Console output file: /home/test/intel/diagnostics/diagnostics_nnladtldev-01_20210831-141832.txt JSON output file: /home/test/intel/diagnostics/diagnostics_nnladtldev-01_20210831-141832.json
To view more information about the check, use the verbosity argument (-v):
python3 diagnostics.py --filter gcc_version_check -v
There are six levels of verbosity. To learn more, see Run the Diagnostic Utility with Verbosity.
To run a customized list of checks, see Run a Customized Set of Checks.

Product and Performance Information

1

Performance varies by use, configuration and other factors. Learn more at www.Intel.com/PerformanceIndex.