Skip to content

Commit

Permalink
Add spellcheck workflow (#6)
Browse files Browse the repository at this point in the history
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.
  • Loading branch information
dbarbuzzi authored Jul 24, 2024
1 parent daa8fd8 commit 3a7911a
Show file tree
Hide file tree
Showing 5 changed files with 57 additions and 6 deletions.
11 changes: 11 additions & 0 deletions .github/config/custom-wordlist.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
CUDA
neuralmagic
Neuralmagic
Neuralmagic's
nm
OpenAI
pre
premade
PyPI
vllm
vLLM
17 changes: 17 additions & 0 deletions .github/config/spellcheck.yml
Original file line number Diff line number Diff line change
@@ -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'
22 changes: 22 additions & 0 deletions .github/workflows/spellcheck.yaml
Original file line number Diff line number Diff line change
@@ -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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
venv
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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)

0 comments on commit 3a7911a

Please sign in to comment.