https://github.com/mlcommons/logging
MLPerf™ logging library
https://github.com/mlcommons/logging
Last synced: about 2 months ago
JSON representation
MLPerf™ logging library
- Host: GitHub
- URL: https://github.com/mlcommons/logging
- Owner: mlcommons
- License: apache-2.0
- Created: 2020-01-16T01:15:39.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2026-04-30T15:54:12.000Z (about 2 months ago)
- Last Synced: 2026-04-30T16:21:19.235Z (about 2 months ago)
- Language: Python
- Homepage: https://mlcommons.org/en/groups/best-practices-benchmark-infra
- Size: 1.14 MB
- Stars: 41
- Watchers: 19
- Forks: 56
- Open Issues: 42
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# 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:
```sh
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):
```sh
pip install "git+https://github.com/mlperf/logging.git@TAG_OR_COMMIT_HASH"
```
Uninstall:
```sh
pip uninstall mlperf-logging
```
## Packages
- [mllog](mlperf_logging/mllog): MLPerf logging library
- [compliance checker](mlperf_logging/compliance_checker): utility checking compliance of MLPerf log
- [system_desc_checker](mlperf_logging/system_desc_checker): utility checking compliance of system description json file
- [rcp_checker](mlperf_logging/rcp_checker): utility running convergence checks in submission directories
- [package_checker](mlperf_logging/package_checker): top-level checker for a package, it calls compliance checker, system desc checker, and rcp checker
- [result_summarizer](mlperf_logging/result_summarizer): utility that parses package and prints out result summary
- [repo_checker](mlperf_logging/repo_checker): utility that checks source code files for github compliance
## Instructions
A submission needs to pass the package checker and run the result summarizer.
For submission 2.1 (latest) you can do that with. For previous versions use the respective verify script.
```sh
./scripts/verify_for_v2.1_training.sh
```
If you want to run the individual utilities/checker, please check the README files in the respective subdirectories.