mlperf-sysinfo 1.0.0a1__tar.gz

mlperf_sysinfo-1.0.0a1/.gitignore

@@ -0,0 +1,14 @@
+__pycache__/
+*.py[cod]
+.venv/
+venv/
+dist/
+build/
+*.egg-info/
+.pytest_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+.DS_Store
+uv.lock
+site/

mlperf_sysinfo-1.0.0a1/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

mlperf_sysinfo-1.0.0a1/PKG-INFO

@@ -0,0 +1,316 @@
+Metadata-Version: 2.5
+Name: mlperf-sysinfo
+Version: 1.0.0a1
+Summary: Capture MLPerf system descriptions: one config format, one CLI, per-working-group profiles.
+Project-URL: Homepage, https://github.com/anandhu-eng/mlperf-sysinfo
+Project-URL: Repository, https://github.com/anandhu-eng/mlperf-sysinfo
+Project-URL: Documentation, https://anandhu-eng.github.io/mlperf-sysinfo/
+Project-URL: Issues, https://github.com/anandhu-eng/mlperf-sysinfo/issues
+Author: MLCommons contributors
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: benchmark,mlcommons,mlperf,submission,system-info
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: System :: Benchmark
+Requires-Python: >=3.10
+Requires-Dist: cyclopts>=3.0
+Requires-Dist: mlc-scripts==1.2.0a1
+Requires-Dist: pydantic>=2.7
+Requires-Dist: pyyaml>=6.0
+Provides-Extra: dev
+Requires-Dist: pytest-cov>=5.0; extra == 'dev'
+Requires-Dist: pytest>=8.0; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: mkdocs-material<10,>=9.5; extra == 'docs'
+Requires-Dist: mkdocs<2,>=1.6; extra == 'docs'
+Description-Content-Type: text/markdown
+
+# mlperf-sysinfo
+
+A tool that automatically captures the system description of a benchmarking
+machine, built on top of the
+[mlc-scripts](https://github.com/mlcommons/mlperf-automations) and
+[mlcflow](https://github.com/mlcommons/mlcflow) automation.
+
+**Documentation: <https://anandhu-eng.github.io/mlperf-sysinfo/>**
+
+```bash
+pip install mlperf-sysinfo
+```
+
+## Quick Run
+
+The steps below capture a system description for a CPU-only system, using
+only the machine you run them on. No other node is contacted.
+
+**Step 1 -- create a starter config**
+
+```bash
+mlperf-sysinfo init endpoints
+```
+
+<details>
+<summary>Sample output</summary>
+
+```console
+$ mlperf-sysinfo init endpoints
+
+  Written template sysinfo.yaml to path: /home/user/sysinfo.yaml
+
+  profile: endpoints
+
+  Edit the template sysinfo.yaml before running the actual capture command.
+```
+
+</details>
+
+**Step 2 -- edit `sysinfo.yaml`**
+
+Fill in a system name, your organisation, a contact email, and the model
+being served. `nodes.include_local` is already `true` with an empty `ssh`
+list, so leave that section alone. For a CPU-only capture, set
+`accelerator: none` and drop the `serving:` block entirely -- both fields
+are optional here, and skipping them is a warning, not an error.
+
+```yaml
+profile: endpoints
+
+output:
+  dir: results/sysinfo
+
+system:
+  name: devbox1
+  category: datacenter
+  availability: available
+  accelerator: none
+
+nodes:
+  include_local: true
+  ssh: []
+
+submission:
+  submitter: MyOrg
+  contact: mlperf@myorg.example
+  division: standardized
+  model:
+    name: Llama-3.1-8B-Instruct
+```
+
+**Step 3 -- check the config**
+
+```bash
+mlperf-sysinfo check -c sysinfo.yaml
+```
+
+<details>
+<summary>Sample output</summary>
+
+```console
+$ mlperf-sysinfo check -c sysinfo.yaml
+
+  profile    endpoints (v6.0 rules)
+  output     results/sysinfo/system_desc.json
+
+NODES
+  ✓ this machine   included
+
+REQUIRED BY PROFILE 'ENDPOINTS'
+  ✓ 7 fields set
+
+WORTH FILLING IN
+  ! serving.url                  empty   Enables framework and version detection from the live endpoint
+  ! serving.node                 empty   Enables parallelism and batch settings to be read from the startup log
+  ! submission.model.precision   empty   Reviewers ask for this almost every round
+  ! submission.dataset.name      empty   Identifies what the system was serving
+
+  Ready to capture.
+```
+
+</details>
+
+The warnings above are expected for a config with no live endpoint -- they
+don't block anything. `capture` always runs this check first, with no flag
+to skip it; a missing *required* field or an unreachable node is what would
+stop the run.
+
+**Step 4 -- capture**
+
+```bash
+mlperf-sysinfo capture -c sysinfo.yaml
+```
+
+<details>
+<summary>Sample output</summary>
+
+```console
+$ mlperf-sysinfo capture -c sysinfo.yaml
+
+  ✓ pre-flight check     passed -- 1 node(s), profile endpoints (v6.0 rules)
+  ✓ collection           1 of 1 node(s) returned hardware
+
+  1 node(s) - profile endpoints
+
+  Written  results/sysinfo/system_desc.json
+
+  Next: mlperf-sysinfo show results/sysinfo/system_desc.json
+```
+
+</details>
+
+**Step 5 -- validate**
+
+```bash
+mlperf-sysinfo validate results/sysinfo/system_desc.json
+```
+
+<details>
+<summary>Sample output</summary>
+
+```console
+$ mlperf-sysinfo validate results/sysinfo/system_desc.json
+
+  file       results/sysinfo/system_desc.json
+  profile    endpoints (v6.0 rules)
+
+  Valid. 7 required field(s) present.
+```
+
+</details>
+
+## The config
+
+Grouped by who owns the answer, not by which environment variable it sets.
+
+```yaml
+profile: endpoints
+
+output:
+  dir: results/h100_run1
+
+system:
+  name: H100x8_vLLM
+  category: datacenter
+  availability: available
+  accelerator: cuda
+
+nodes:
+  include_local: false
+  ssh:
+    - root@node1
+    - root@node2:2222
+
+serving:
+  url: http://node1:8000
+  node: root@node1
+  log: /tmp/serving.log
+
+submission:
+  submitter: MyOrg
+  contact: mlperf@myorg.example
+  division: standardized
+  model:
+    name: Llama-3.1-8B-Instruct
+    precision: fp8
+```
+
+Three rules worth knowing:
+
+- **Anything detectable is never a config field.** CPU, memory, accelerators,
+  node counts and framework version are probed. If they appear here at all,
+  they are overrides.
+- **`${VAR}` reads from the environment.** BMC and API credentials are
+  referenced, never written down.
+- **The same file works embedded.** Drop it under a `system_info:` key in a
+  benchmark config and it validates identically.
+
+Use `extends: ~/.mlperf/org.yaml` to share submitter details across configs.
+
+## Profiles
+
+A profile says which fields are required, which extra collection steps to run,
+and what the output looks like.
+
+| Profile | Output | Notes |
+| --- | --- | --- |
+| `endpoints` | grouped, keeps `node_types` | Probes the endpoint and parses the serving log |
+| `inference` | flat, matches the submission checker | Hardware lifted to the top level |
+
+`mlperf-sysinfo profiles` lists them. All profiles live in this repo and ship
+with the package. A config may also point at a file --
+`profile: ./my-profile.yaml` -- for building one before it is upstreamed.
+
+Profiles always track the current MLPerf round; there is no version to pin. The
+round that applied is stamped into every output file, so a captured file
+records the rules that produced it.
+
+## Embedding
+
+```python
+from mlperf_sysinfo import load_config, capture
+
+config = load_config("sysinfo.yaml")
+result = capture(config)
+
+result.output_path   # where the file landed
+result.nodes         # per-node status
+result.complete      # False if any node did not answer
+```
+
+`capture()` raises `CheckFailed` when pre-flight does not pass. Call
+`mlperf_sysinfo.check(config)` on its own to run the same validation early --
+at the start of a benchmark rather than at the end of one.
+
+## Exit codes
+
+`check` is meant to be scriptable, so the codes are a contract:
+
+| Code | Meaning |
+| --- | --- |
+| 0 | All good |
+| 1 | The run found problems (missing fields, unreachable nodes, invalid file) |
+| 2 | The command or the config was wrong |
+
+## Where files land
+
+The deliverable is the only thing written to `output.dir`. Everything the
+automation produces -- the raw intermediate, per-node files, and its log --
+goes into `output.dir/.mlperf-sysinfo/`. Pass `--verbose` to see the automation
+log on the terminal instead of in that directory.
+
+Two caveats worth knowing:
+
+- **Credentials can be echoed by the collection layer.** Keeping them in
+  `${VAR}` keeps them out of your config file and out of git, but the
+  underlying automation prints its own command lines, so a Redfish password may
+  appear in `automation.log`. Treat that directory as sensitive.
+- **Remote scratch files are not confined.** When collecting over SSH, the
+  automation writes its own temporary files on each remote node (under `$HOME`
+  and `/tmp` there). This package cannot redirect those.
+
+## Partial captures
+
+An unreachable node stops the run. `--allow-partial` proceeds anyway, and the
+output records `complete: false` along with how many nodes answered.
+`validate` then refuses the file, so a partial capture cannot be mistaken for a
+whole one.
+
+## Development
+
+```bash
+uv venv && uv pip install -e ".[dev]"
+uv run pytest
+uv run ruff check .
+```
+
+## License
+
+Apache-2.0