Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mmarcinkiewicz authored Sep 9, 2024
1 parent 3966c5e commit 47d7cbc
Showing 1 changed file with 19 additions and 23 deletions.
42 changes: 19 additions & 23 deletions mlperf_logging/compliance_checker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,9 @@ To check a log file for compliance:

python -m mlperf_logging.compliance_checker [--config YAML] [--usage training/hpc] [--ruleset MLPERF_EDITION] FILENAME

By default, 3.1.0 training edition rules are used and the default config is set to `3.1.0/common.yaml`.
By default, 3.1.0 training edition rules are used and the default config is set to `4.1.0/common.yaml`.
This config will check all common keys and enqueue benchmark specific config to be checked as well.
Old training editions, still supported are 3.0.0, 2.1.0, 2.0.0, 1.1.0, 1.0.0, 0.7.0 and 0.6.0
Old training editions, still supported are 4.0.0, 3.1.0, 3.0.0, 2.1.0, 2.0.0, 1.1.0, 1.0.0, 0.7.0 and 0.6.0

To check hpc compliance rules (only 1.0.0 ruleset is supported), set --usage hpc --ruleset 1.0.0.

Expand All @@ -22,27 +22,23 @@ As log examples use [NVIDIA's training logs](https://github.com/mlperf/training_

### Existing config files for training submissions

3.1.0/common.yaml - currently the default config file, checks common fields complience and equeues benchmark-specific config file
3.1.0/closed_common.yaml - the common rules file for closed submissions. These rules apply to all benchmarks
3.1.0/open_common.yaml - the common rules file for open submissions. These rules apply to all benchmarks
3.1.0/closed_resnet.yaml - Per-benchmark rules, closed submissions.
3.1.0/closed_ssd.yaml
3.1.0/closed_maskrcnn.yaml
3.1.0/closed_rnnt.yaml
3.1.0/closed_unet3d.yaml
3.1.0/closed_bert.yaml
3.1.0/closed_dlrm_dcnv2.yaml
3.1.0/closed_gpt3.yaml
3.1.0/closed_stable_diffusion.yaml
3.1.0/open_resnet.yaml - Per-benchmark rules, closed submissions.
3.1.0/open_ssd.yaml
3.1.0/open_maskrcnn.yaml
3.1.0/open_rnnt.yaml
3.1.0/open_unet3d.yaml
3.1.0/open_bert.yaml
3.1.0/open_dlrm_dcnv2.yaml
3.1.0/open_gpt3.yaml
3.1.0/open_stable_diffusion.yaml
4.1.0/common.yaml - currently the default config file, checks common fields complience and equeues benchmark-specific config file
4.1.0/closed_common.yaml - the common rules file for closed submissions. These rules apply to all benchmarks
4.1.0/open_common.yaml - the common rules file for open submissions. These rules apply to all benchmarks
4.1.0/closed_ssd.yaml - Per-benchmark rules, closed submissions.
4.1.0/closed_bert.yaml
4.1.0/closed_dlrm_dcnv2.yaml
4.1.0/closed_gpt3.yaml
4.1.0/closed_gnn.yaml
4.1.0/closed_llama2_70b_lora.yaml
4.1.0/closed_stable_diffusion.yaml
4.1.0/open_ssd.yaml - Per-benchmark rules, closed submissions.
4.1.0/open_bert.yaml
4.1.0/open_dlrm_dcnv2.yaml
4.1.0/open_gpt3.yaml
4.1.0/open_gnn.yaml
4.1.0/open_llama2_70b_lora.yaml
4.1.0/open_stable_diffusion.yaml

### Existing config files for HPC submissions

Expand Down

0 comments on commit 47d7cbc

Please sign in to comment.