From 3a7911a4bef12639bacc2522e2ff9c3ace65ee0c Mon Sep 17 00:00:00 2001 From: Domenic Barbuzzi Date: Wed, 24 Jul 2024 14:55:22 -0400 Subject: [PATCH] Add spellcheck workflow (#6) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit SUMMARY: This PR adds a spellcheck workflow with two steps powered by existing GitHub actions: - Step 1 runs `codespell` to look for common misspellings, similar to vLLM itself - Step 2 runs a full-fledged spellcheck powered by `aspell` To get step 2 passing, a custom word list was created, and the README was edited. TEST PLAN: See checks available on this PR/in the repo’s “Actions” tab. --- .github/config/custom-wordlist.txt | 11 +++++++++++ .github/config/spellcheck.yml | 17 +++++++++++++++++ .github/workflows/spellcheck.yaml | 22 ++++++++++++++++++++++ .gitignore | 1 + README.md | 12 ++++++------ 5 files changed, 57 insertions(+), 6 deletions(-) create mode 100644 .github/config/custom-wordlist.txt create mode 100644 .github/config/spellcheck.yml create mode 100644 .github/workflows/spellcheck.yaml create mode 100644 .gitignore diff --git a/.github/config/custom-wordlist.txt b/.github/config/custom-wordlist.txt new file mode 100644 index 0000000..438ff33 --- /dev/null +++ b/.github/config/custom-wordlist.txt @@ -0,0 +1,11 @@ +CUDA +neuralmagic +Neuralmagic +Neuralmagic's +nm +OpenAI +pre +premade +PyPI +vllm +vLLM diff --git a/.github/config/spellcheck.yml b/.github/config/spellcheck.yml new file mode 100644 index 0000000..d773143 --- /dev/null +++ b/.github/config/spellcheck.yml @@ -0,0 +1,17 @@ +matrix: +- name: Markdown + pipeline: + - pyspelling.filters.html: + comments: false + ignores: + - code + - pre + aspell: + lang: en + d: en_US + mode: markdown + dictionary: + wordlists: + - .github/config/custom-wordlist.txt + sources: + - '**/*.md' diff --git a/.github/workflows/spellcheck.yaml b/.github/workflows/spellcheck.yaml new file mode 100644 index 0000000..eb4cb8c --- /dev/null +++ b/.github/workflows/spellcheck.yaml @@ -0,0 +1,22 @@ +name: Spellcheck + +on: push + +jobs: + + SPELLCHECK: + runs-on: ubuntu-latest + steps: + + - uses: actions/checkout@v4 + + - name: Check for common misspellings + uses: codespell-project/actions-codespell@v2 + + - name: Check spelling + uses: rojopolis/spellcheck-github-actions@v0 + if: '!cancelled()' + with: + config_path: .github/config/spellcheck.yml + source_files: README.md + task_name: Markdown diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..5ceb386 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +venv diff --git a/README.md b/README.md index d28141f..0fd3f00 100644 --- a/README.md +++ b/README.md @@ -2,18 +2,18 @@ ## Overview -The `nm-vllm` packages published in this repository are Neuralmagic Enterprise Edition of [vLLM](https://github.com/vllm-project/vllm). Packages are versioned Python wheels and docker images. These are released as "production level" official releases and "beta level" Nightly's. +The `nm-vllm` packages published in this repository are Neuralmagic Enterprise Edition of [vLLM](https://github.com/vllm-project/vllm). Packages are versioned Python wheels and docker images. These are released as "production level" official releases and "beta level" nightly releases. -Official releases are made at the discretion of Neuralmagic, but typically track with `vllm` releases. These wheels are available via "public pypi" as well as ["nm-pypi"](https://pypi.neuralmagic.com). +Official releases are made at the discretion of Neuralmagic, but typically track with `vllm` releases. These wheels are available via the official PyPI as well as [Neuralmagic's PyPI](https://pypi.neuralmagic.com). -Nightly's are released every night given green runs in automation. The wheels are available at ["nm-pypi"](https://pypi.neuralmagic.com). +Nightly builds are released every night given green runs in automation. The wheels are available at [Neuralmagic's PyPI](https://pypi.neuralmagic.com). ## Installation ### PyPI -The [nm-vllm PyPi package](https://pypi.neuralmagic.com/simple/nm-vllm/index.html) includes pre-compiled binaries for CUDA (version 12.1) kernels. For other PyTorch or CUDA versions, please compile the package from source. +The [nm-vllm PyPI package](https://pypi.neuralmagic.com/simple/nm-vllm/index.html) includes pre-compiled binaries for CUDA (version 12.1) kernels. For other PyTorch or CUDA versions, please compile the package from source. Install it using pip: ```bash @@ -40,11 +40,11 @@ docker run --gpus all --shm-size 2g ghcr.io/neuralmagic/nm-vllm-ent:latest --mod ## Benchmarks -Please see our benchmarking results [here]( https://neuralmagic.github.io/nm-vllm-certs/dev/bench/). +Please see our benchmark results [here]( https://neuralmagic.github.io/nm-vllm-certs/dev/bench/). ## Models -Neural Magic maintains a variety of optimized models on our Hugging Face organization profiles: +Neuralmagic maintains a variety of optimized models on our Hugging Face organization profiles: - [neuralmagic](https://huggingface.co/neuralmagic) - [nm-testing](https://huggingface.co/nm-testing)