rldoctor 0.1.0__tar.gz

rldoctor-0.1.0/.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

rldoctor-0.1.0/.github/ISSUE_TEMPLATE/bug.yml

@@ -0,0 +1,21 @@
+name: Bug
+description: Something crashed, or did not run.
+labels: [bug]
+body:
+  - type: textarea
+    id: what
+    attributes:
+      label: What happened
+      description: The command you ran and what it printed. Tracebacks are welcome.
+    validations:
+      required: true
+  - type: input
+    id: version
+    attributes:
+      label: Version
+      placeholder: output of `--version`
+  - type: input
+    id: env
+    attributes:
+      label: Python and OS
+      placeholder: Python 3.11, Ubuntu 22.04

rldoctor-0.1.0/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1 @@
+blank_issues_enabled: true

rldoctor-0.1.0/.github/ISSUE_TEMPLATE/unrecognised_key.yml

@@ -0,0 +1,22 @@
+name: Unrecognised metric key
+description: rldoctor --verbose listed a key from your framework that it should understand.
+labels: [aliases]
+body:
+  - type: input
+    id: key
+    attributes:
+      label: The key, exactly as logged
+      placeholder: actor/entropy_mean
+    validations:
+      required: true
+  - type: input
+    id: meaning
+    attributes:
+      label: What it measures
+    validations:
+      required: true
+  - type: input
+    id: framework
+    attributes:
+      label: Framework and version
+      placeholder: verl 0.6

rldoctor-0.1.0/.github/ISSUE_TEMPLATE/wrong_verdict.yml

@@ -0,0 +1,44 @@
+name: Wrong verdict
+description: rldoctor said something about your run that is not true -- or missed something that is.
+labels: [wrong-verdict]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        This is the most valuable issue you can file. A false positive is treated as a
+        higher-severity bug than a missed detection: a diagnostic that cries wolf gets
+        uninstalled, and then it catches nothing.
+  - type: dropdown
+    id: kind
+    attributes:
+      label: Which way was it wrong?
+      options:
+        - It warned about a run that was fine (false positive)
+        - It missed a problem the run really had (false negative)
+        - The finding was right but the explanation or the fix was wrong
+    validations:
+      required: true
+  - type: input
+    id: detector
+    attributes:
+      label: Which detector
+      placeholder: e.g. entropy_collapse
+  - type: textarea
+    id: truth
+    attributes:
+      label: What was actually going on in the run
+      description: How you know -- held-out results, rollouts you read, what you changed.
+    validations:
+      required: true
+  - type: textarea
+    id: log
+    attributes:
+      label: The log
+      description: |
+        A link to a public W&B run or trainer_state.json, or an attached CSV of the
+        relevant series. The full log is not needed -- the columns the detector reads are.
+  - type: input
+    id: framework
+    attributes:
+      label: Framework and version
+      placeholder: verl 0.6 / TRL 1.2 / custom

rldoctor-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,78 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  workflow_dispatch:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    name: py${{ matrix.python }} on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        python: ["3.10", "3.11", "3.12", "3.13", "3.14"]
+        include:
+          # The terminal report has an ASCII fallback specifically for Windows
+          # consoles on a legacy code page, so it needs to actually run there.
+          - os: windows-latest
+            python: "3.12"
+          - os: macos-latest
+            python: "3.12"
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python }}
+          cache: pip
+      - run: python -m pip install --upgrade pip
+      - run: pip install -e ".[dev]"
+      - name: Tests
+        run: pytest -q --cov=rldoctor --cov-report=term-missing
+      - name: Detection matrix
+        run: rldoctor selftest
+      - name: CLI smoke test
+        run: |
+          rldoctor --version
+          rldoctor detectors
+          rldoctor fields
+          rldoctor demo healthy --format json > /dev/null
+        shell: bash
+
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+          cache: pip
+      - run: pip install ruff mypy
+      - run: ruff check src tests
+      - run: ruff format --check src tests
+        continue-on-error: true
+      - run: mypy src/rldoctor
+        continue-on-error: true
+
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: pip install build twine
+      - run: python -m build
+      - run: twine check dist/*
+      - name: Install the wheel in a clean environment
+        run: |
+          python -m venv /tmp/clean
+          /tmp/clean/bin/pip install dist/*.whl
+          /tmp/clean/bin/rldoctor selftest

rldoctor-0.1.0/.github/workflows/release.yml

@@ -0,0 +1,68 @@
+name: Release
+
+# Publishes to PyPI when a version tag is pushed, using PyPI trusted publishing:
+# no API token is stored anywhere. One-time setup on pypi.org, under
+# "Your projects -> Publishing -> Add a new pending publisher":
+#   PyPI project name: rldoctor
+#   Owner:             junglezke
+#   Repository:        rldoctor
+#   Workflow:          release.yml
+#   Environment:       pypi
+# Then:  git tag v0.1.0 && git push origin v0.1.0
+
+on:
+  push:
+    tags: ["v*"]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Check the tag matches the package version
+        run: |
+          version=$(python -c "import tomllib; print(tomllib.load(open('pyproject.toml','rb'))['project']['version'])")
+          test "v$version" = "${GITHUB_REF_NAME}" || { echo "tag ${GITHUB_REF_NAME} != version v$version"; exit 1; }
+      - run: pip install build twine
+      - run: python -m build
+      - run: twine check dist/*
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/project/rldoctor/
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1
+
+  github-release:
+    needs: publish
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - name: Create the GitHub release from the changelog
+        env:
+          GH_TOKEN: ${{ github.token }}
+        run: |
+          notes=$(awk '/^## \[/{n++} n==1' CHANGELOG.md | tail -n +2)
+          gh release create "${GITHUB_REF_NAME}" dist/* --title "${GITHUB_REF_NAME}" --notes "$notes"

rldoctor-0.1.0/.github/workflows/validation.yml

@@ -0,0 +1,42 @@
+name: Real-run validation
+
+# Re-diagnoses the public training logs in validation/runs.json and fails if any
+# verdict changed. Runs when the code that decides verdicts changes, and weekly
+# so an upstream log disappearing is noticed.
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - "src/rldoctor/detectors/**"
+      - "src/rldoctor/stats.py"
+      - "src/rldoctor/aliases.py"
+      - "src/rldoctor/ingest/**"
+      - "validation/**"
+  pull_request:
+    paths:
+      - "src/rldoctor/detectors/**"
+      - "src/rldoctor/stats.py"
+      - "src/rldoctor/aliases.py"
+      - "src/rldoctor/ingest/**"
+      - "validation/**"
+  schedule:
+    - cron: "0 6 * * 1"
+  workflow_dispatch:
+
+jobs:
+  validate:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+          cache: pip
+      - run: pip install -e .
+      - uses: actions/cache@v4
+        with:
+          path: validation/.cache
+          key: validation-${{ hashFiles('validation/runs.json') }}
+      - run: python validation/fetch.py
+      - run: python validation/run.py --check

rldoctor-0.1.0/.gitignore

@@ -0,0 +1,17 @@
+__pycache__/
+*.py[cod]
+*.egg-info/
+build/
+dist/
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+.coverage
+htmlcov/
+.venv/
+venv/
+*.html
+!docs/**/*.html
+
+# Public training logs used for validation: other people's data, fetched on demand.
+validation/.cache/

rldoctor-0.1.0/CHANGELOG.md

@@ -0,0 +1,40 @@
+# Changelog
+
+All notable changes to this project are documented here. This project follows
+[Semantic Versioning](https://semver.org/).
+
+## [0.1.0] — 2026-10-04
+
+First public release.
+
+### Added
+
+- Nine detectors: `advantage_collapse`, `entropy_collapse`, `reward_hacking`,
+  `length_pathology`, `clip_saturation`, `kl_drift`, `gradient_pathology`,
+  `reward_composition`, `plateau`. Each emits evidence, a prescription and references.
+- Ingest from W&B runs, TensorBoard directories, JSONL, JSON and CSV, plus
+  `run_from_records` for any training loop that can hand over a list of dicts.
+- Three-pass alias resolution (exact, suffix, token-set) across verl and TRL metric
+  names, with unresolved keys surfaced rather than dropped.
+- Robust statistics: Theil–Sen regression, Mann–Kendall with tie correction, Spearman,
+  detrended CUSUM changepoints, and `project_threshold` model-selecting extrapolation.
+- Cost model converting waste into GPU-hours and dollars, combining per-detector waste
+  fractions as independent survival probabilities rather than summing them.
+- Terminal (with ASCII fallback), Markdown, JSON and self-contained HTML reports.
+- `LiveMonitor` and `RLDoctorCallback` for in-training diagnosis.
+- Twelve simulated pathology scenarios, doubling as the test suite's detection matrix
+  and as `rldoctor demo` / `rldoctor selftest`.
+- Native `trainer_state.json` ingestion (every HuggingFace checkpoint ships one) and
+  verl's `file` logger format, including `val-core/<source>/<metric>/mean@N` keys.
+- Exactly-zero gradient steps reported as dead updates, and counted as wasted rollouts.
+- `validation/`: four public GRPO runs with pinned verdicts, re-checked in CI.
+
+### Fixed before release, found on real logs
+
+- `nan` padding from eval rows logged on a different cadence was counted as non-finite
+  gradient norms -- a false "numerically dead" verdict on a healthy run.
+- Statistical outliers only 2x the median were reported as gradient spikes.
+- Truncation was counted as wasted rollout compute, producing an indefensible "99%".
+- TRL's `eval_` prefix was not recognised, so held-out metrics leaked into training series.
+- A KL of exactly 0.0 at every step (a run with no KL term) was read as a pinned policy.
+- A plateau was declared on a run less than half way to `max_steps`.

rldoctor-0.1.0/CITATION.cff

@@ -0,0 +1,25 @@
+cff-version: 1.2.0
+title: "rldoctor: diagnostics for GRPO/RLVR training runs"
+message: "If you use this software, please cite it as below."
+type: software
+authors:
+  - alias: junglezke
+repository-code: "https://github.com/junglezke/rldoctor"
+abstract: >-
+  rldoctor reads the metric log of a reinforcement-learning post-training run and
+  reports which documented failure mode it is exhibiting, what that failure has cost
+  in GPU-hours, and what configuration change addresses it. It covers zero-variance
+  GRPO groups, entropy collapse, reward/eval divergence, length hacking, truncation,
+  clip saturation, KL drift, gradient pathologies, reward-component imbalance and
+  learning plateaus, working from logs produced by verl, TRL, or any training loop,
+  with no instrumentation required.
+keywords:
+  - reinforcement learning
+  - RLHF
+  - RLVR
+  - GRPO
+  - large language models
+  - training diagnostics
+  - reward hacking
+license: Apache-2.0
+version: 0.1.0

rldoctor-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,84 @@
+# Contributing to rldoctor
+
+## The most useful thing you can do
+
+**Tell us about a metric key we do not recognise.** Run:
+
+```bash
+rldoctor diagnose <your run> --verbose
+```
+
+Anything listed under "unrecognised log keys" is a metric we dropped. If one of them is
+something rldoctor should understand, open an issue with the key name, the framework and
+version, and what it measures. That is usually a one-line addition to
+`src/rldoctor/aliases.py` and it makes the tool work for everyone on that stack.
+
+**Second most useful: a run that produced a wrong verdict.** A false positive is a bug of
+the highest severity in this project — a diagnostic that cries wolf gets uninstalled, and
+then it catches nothing. If rldoctor warned about a run that was fine, or stayed quiet on
+a run that was not, please open an issue with the metric log (a CSV of the relevant series
+is plenty) and what actually happened.
+
+## Adding a detector
+
+Three files:
+
+1. **`src/rldoctor/detectors/your_check.py`** — subclass `Detector`, set `name`, `title`,
+   `requires`, `references`, and implement `run(self, run) -> Finding`. The base class
+   validates `requires` before calling you, so the body can assume its inputs exist.
+2. **`src/rldoctor/detectors/__init__.py`** — add the class to `BUILTIN_DETECTORS`.
+3. **`src/rldoctor/simulate.py`** — add a scenario that reproduces the failure, and record
+   the expected detection in `EXPECTED_DETECTIONS`.
+
+That third step is not optional busywork. It is what makes the check trustworthy: it
+proves the detector fires on the failure it claims, and the shared `healthy` scenario
+proves it stays quiet otherwise. `pytest tests/test_detectors.py` runs the whole matrix.
+
+### What a good detector does
+
+- **Returns `SKIPPED` with a named missing field** rather than guessing from absent data.
+- **Puts the numbers it fired on into `evidence`.** A reader must be able to disagree with
+  your threshold rather than with the tool.
+- **Always prescribes.** A finding with no suggested change is a complaint. This is
+  enforced by `test_findings_are_actionable`.
+- **Cites its source.** Thresholds pulled from a paper are defensible; thresholds pulled
+  from nowhere are not.
+- **Checks a second signal before accusing.** Entropy decay means nothing without the
+  reward trend; length growth means nothing without a held-out score. Conditional firing
+  is the single biggest lever on the false-positive rate.
+- **Uses the robust helpers in `stats.py`.** Curves are noisy and heavy-tailed; means and
+  OLS slopes over-react to the handful of catastrophic steps every real run contains.
+
+## Changing a threshold
+
+Run the real-run validation before and after:
+
+```bash
+python validation/fetch.py
+python validation/run.py --check
+```
+
+The simulated scenarios tell you a detector *can* fire. The five public runs in
+`validation/runs.json` tell you whether it fires on runs that exist. If a verdict moves,
+either the new verdict is right -- update `runs.json` and say why in the commit -- or the
+change broke something real. Adding a public run you know the ground truth for is one of
+the most useful contributions there is.
+
+## Development
+
+```bash
+pip install -e ".[dev]"
+pytest
+rldoctor selftest
+ruff check src tests
+```
+
+Please keep the core dependency-free beyond `numpy`. Anything heavier goes behind an
+optional extra with a lazy import, because this tool has to install cleanly next to
+whatever a user's cluster image already pins.
+
+## Code style
+
+Match the surrounding code. Comments explain *why* a threshold or an approach was chosen,
+not what the line does — the constants in this codebase are opinions, and an opinion
+without a reason cannot be argued with or improved.

rldoctor-0.1.0/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.