Skip to content

mlcommons/logging

Folders and files

NameName
Last commit message
Last commit date

Latest commit

62cb076 · Sep 28, 2022
Aug 10, 2022
Jan 23, 2021
Sep 28, 2022
Sep 28, 2022
Feb 8, 2021
Feb 12, 2020
Jul 26, 2021
Jul 20, 2021
Sep 7, 2021
May 12, 2022
May 23, 2020
Sep 28, 2022
Apr 27, 2022

Repository files navigation

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

Packages

  • 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
  • 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.0 (latest) you can do that with. For previous versions use the respective verify script.

./scripts/verify_for_v2.0_training.sh <submission_directory>

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