NeMo2.0 llama3 perf scripts #12916
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Isort and Black Formatting; PyLint Docs check | |
| # Incrementally reformat only changed files with black, all files with isort | |
| # | |
| # Replaces pre-commit.ci, since it reformats all the files. | |
| # See issue https://github.com/pre-commit-ci/issues/issues/90 | |
| # | |
| # The action requires a custom token to trigger workflow after pushing reformatted files back to the branch. | |
| # `secrets.GITHUB_TOKEN` can be used instead, but this will result | |
| # in not running necessary checks after reformatting, which is undesirable. | |
| # For details see https://github.com/orgs/community/discussions/25702 | |
| on: | |
| pull_request_target: | |
| paths: | |
| - '**.py' | |
| types: [ opened, synchronize, reopened, labeled, unlabeled ] | |
| defaults: | |
| run: | |
| shell: bash -x -e -u -o pipefail {0} | |
| jobs: | |
| reformat_with_isort_and_black: | |
| runs-on: ubuntu-latest | |
| permissions: | |
| # write permissions required to commit changes | |
| contents: write | |
| steps: | |
| - name: Checkout branch | |
| uses: actions/checkout@v4 | |
| with: | |
| # setup repository and ref for PRs, see | |
| # https://github.com/EndBug/add-and-commit?tab=readme-ov-file#working-with-prs | |
| repository: ${{ github.event.pull_request.head.repo.full_name }} | |
| ref: ${{ github.event.pull_request.head.ref }} | |
| # custom token is required to trigger actions after reformatting + pushing | |
| token: ${{ secrets.NEMO_REFORMAT_TOKEN }} | |
| # https://github.com/tj-actions/changed-files | |
| - name: Get changed files | |
| id: changed-files | |
| uses: tj-actions/changed-files@v44 | |
| with: | |
| files: | | |
| **.py | |
| - name: Setup Python env | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.10" | |
| - name: black | |
| uses: psf/black@stable | |
| if: ${{ steps.changed-files.outputs.any_changed == 'true' }} | |
| with: | |
| options: "--verbose" | |
| # apply only to changed files (pass explicitly the files) | |
| src: "${{ steps.changed-files.outputs.all_changed_files }}" | |
| version: "~= 24.3" | |
| - name: isort | |
| uses: isort/isort-action@v1 | |
| if: ${{ steps.changed-files.outputs.any_changed == 'true' }} | |
| with: | |
| isort-version: "5.13.2" | |
| # reformat all files with isort – safe since the whole repo is already reformatted | |
| configuration: "" | |
| - uses: EndBug/add-and-commit@v9 | |
| # Commit changes. Nothing is committed if no changes. | |
| with: | |
| message: Apply isort and black reformatting | |
| commit: --signoff | |
| check_pylint: | |
| name: "check_pylint (strict-mode: ${{ matrix.strict-mode }})" | |
| runs-on: ubuntu-latest | |
| permissions: | |
| contents: write | |
| pull-requests: write | |
| env: | |
| THRESHOLD: 1730937600 # On this date (2024/11/07) we decided to add Pylint. It shall only run in strict mode for files added past this date. For files prior to this date, we will only add a PR comment with PyLint's stdout. | |
| strategy: | |
| matrix: | |
| strict-mode: ["true", "false"] | |
| steps: | |
| - name: Checkout branch | |
| uses: actions/checkout@v4 | |
| with: | |
| # setup repository and ref for PRs, see | |
| # https://github.com/EndBug/add-and-commit?tab=readme-ov-file#working-with-prs | |
| repository: ${{ github.event.pull_request.head.repo.full_name }} | |
| ref: ${{ github.event.pull_request.head.ref }} | |
| fetch-depth: 0 | |
| # https://github.com/tj-actions/changed-files | |
| - name: Get changed files | |
| id: changed-files | |
| uses: tj-actions/changed-files@v44 | |
| with: | |
| files: | | |
| **.py | |
| - name: Setup Python env | |
| uses: actions/setup-python@v5 | |
| with: | |
| python-version: "3.10" | |
| - name: pylint | |
| if: ${{ steps.changed-files.outputs.any_changed == 'true' && !contains( github.event.pull_request.labels.*.name, 'skip-docs') }} | |
| id: pylint | |
| env: | |
| # only *.py files included | |
| STRICT_MODE: ${{ matrix.strict-mode }} | |
| CHANGED_FILES: "${{ steps.changed-files.outputs.all_changed_files }}" | |
| run: | | |
| pip install pylint | |
| FILTERED=() | |
| for file in $CHANGED_FILES; do | |
| DATE=$(git log --format=%ad --date=unix "$file" | tail -1) | |
| if [[ "$STRICT_MODE" == "true" ]]; then | |
| if [[ "$DATE" -gt "$THRESHOLD" ]]; then | |
| FILTERED+=("$file") | |
| fi | |
| else | |
| if [[ "$DATE" -le "$THRESHOLD" ]]; then | |
| FILTERED+=("$file") | |
| fi | |
| fi | |
| done | |
| if [ ${#FILTERED[@]} -eq 0 ]; then | |
| echo "No files to check." | |
| exit 0 | |
| fi | |
| echo "Will run on these files: | |
| ${FILTERED[@]}" | |
| set +e | |
| LOG=$(pylint ${FILTERED[@]}) | |
| EXIT_CODE=$? | |
| set -e | |
| set +x | |
| echo "OUTPUT<<EOF" >> $GITHUB_ENV | |
| echo "$LOG" >> $GITHUB_ENV | |
| echo "EOF" >> $GITHUB_ENV | |
| echo "log=$LOG" | |
| set -x | |
| echo "exit-code=$EXIT_CODE" | tee -a "$GITHUB_OUTPUT" | |
| if [[ "${{ matrix.strict-mode }}" == "true" ]]; then | |
| HEADER="🚨 The following files must be fixed before merge!" | |
| else | |
| HEADER="🙏 The following files have warnings. In case you are familiar with these, please try helping us to improve the code base." | |
| fi | |
| echo "header=$HEADER" | tee -a "$GITHUB_OUTPUT" | |
| exit $([[ "$EXIT_CODE" -ne 0 && "$STRICT_MODE" == "true" ]] && echo $EXIT_CODE || echo 0) | |
| - name: Find Comment | |
| if: ${{ always() }} | |
| uses: peter-evans/find-comment@v3 | |
| id: fc | |
| with: | |
| issue-number: ${{ github.event.number }} | |
| body-includes: <!-- pylint-output-strict-mode-${{ matrix.strict-mode }} --> | |
| - name: Delete comment | |
| if: ${{ always() && steps.fc.outputs.comment-id != '' }} | |
| env: | |
| GH_TOKEN: ${{ secrets.github_token }} | |
| REPOSITORY: ${{ github.repository }} | |
| COMMENT_ID: ${{ steps.fc.outputs.comment-id }} | |
| run: | | |
| curl -L \ | |
| -X DELETE \ | |
| -H "Accept: application/vnd.github+json" \ | |
| -H "Authorization: Bearer $GH_TOKEN" \ | |
| -H "X-GitHub-Api-Version: 2022-11-28" \ | |
| https://api.github.com/repos/$REPOSITORY/issues/comments/$COMMENT_ID | |
| - name: Add PR comment for PyLint | |
| if: ${{ always() && steps.pylint.outputs.exit-code != '0' }} | |
| uses: peter-evans/create-or-update-comment@v4 | |
| with: | |
| issue-number: ${{ github.event.number }} | |
| body: | | |
| <!-- pylint-output-strict-mode-${{ matrix.strict-mode }} --> | |
| beep boop 🤖: ${{ steps.pylint.outputs.header }} | |
| --- | |
| Your code was analyzed with PyLint. The following annotations have been identified: | |
| ``` | |
| ${{ env.OUTPUT }} | |
| ``` | |
| --- | |
| Mitigation guide: | |
| * Add sensible and useful docstrings to functions and methods | |
| * For trivial methods like getter/setters, consider adding `# pylint: disable=C0116` inside the function itself | |
| * To disable multiple functions/methods at once, put a `# pylint: disable=C0116` before the first and a `# pylint: enable=C0116` after the last. | |
| By applying these rules, we reduce the occurance of this message in future. | |
| Thank you for improving NeMo's documentation! |