Skip to main content

MLPerf compliance tools.

Project description

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

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

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

mlperf_logging-3.0.0-py3-none-any.whl (282.9 kB view details)

Uploaded Python 3

File details

Details for the file mlperf_logging-3.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for mlperf_logging-3.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5c0a6f1393df850ec25a2df675149b4ddf0fb88b99a017a3b71a34c4256dd07a
MD5 33bf42a876e9916749a842c2830965de
BLAKE2b-256 e4dfccafd0140c55be0108b0a280366c750e20e95d7d95b00bf3ab29bb41fb36

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page