MLPerf Logging

MLPerf Compliance Logging Utilities and Helper Functions

Installation

Use one of the following ways to install.

For development, you may download the latest version and install from local path:

git clone https://github.com/mlperf/logging.git mlperf-logging
pip install -e mlperf-logging

Install from github at a specific commit (Replace TAG_OR_COMMIT_HASH with actual tag or commit hash):
```
pip install "git+https://github.com/mlperf/logging.git@TAG_OR_COMMIT_HASH"
```

Uninstall:

pip uninstall mlperf-logging

mllog: MLPerf logging library
compliance checker: utility checking compliance of MLPerf log
system_desc_checker: utility checking compliance of system description json file
rcp_checker: utility running convergence checks in submission directories
package_checker: top-level checker for a package, it calls compliance checker, system desc checker, and rcp checker
result_summarizer: utility that parses package and prints out result summary

A submission needs to pass the package checker and run the result summarizer. For submission 1.0 you can do that with

./verify_for_v1.0_training.sh <submission_directory>

If you want to run the individual utilities/checker, please check the README files in the respective subdirectories.