diff --git a/.github/workflows/spellcheck.yml b/.github/workflows/spellcheck.yml new file mode 100644 index 0000000..3567038 --- /dev/null +++ b/.github/workflows/spellcheck.yml @@ -0,0 +1,22 @@ +# SPDX-License-Identifier: Apache-2.0 + +name: Spellcheck + +on: + pull_request: + branches: [main] + paths: + - '**.md' + +permissions: + contents: read + +jobs: + spellcheck: + name: Spellcheck (en_US) + runs-on: ubuntu-latest + steps: + - name: Checkout Code + uses: actions/checkout@v4 + - name: Spellcheck + uses: rojopolis/spellcheck-github-actions@0.35.0 diff --git a/.gitignore b/.gitignore index e43b0f9..d1d3c59 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,4 @@ .DS_Store + +# Spelling +dictionary.dic diff --git a/.spellcheck-en-custom.txt b/.spellcheck-en-custom.txt new file mode 100644 index 0000000..c561250 --- /dev/null +++ b/.spellcheck-en-custom.txt @@ -0,0 +1,105 @@ +# make spellcheck-sort +# Please keep this file sorted: +Abhishek +Akash +AMDGPU +arge +arXiv +backend +backends +Bhandwaldar +CLI +cli +Colab +compositional +Conda +Containerfile +cpp +cuBLAS +CUDA +dataset +dev +ditaa +dr +Dropdown +env +Eval +Finetuning +GFX +GGUF +GiB +Gmail +gpu +hipBLAS +ilab +impactful +Inferencing +instructlab +ISA +JIT +Jupyter +KAGGLE +Kaggle +Kaggle's +Kai +Kubernetes +lignment +LLM +llms +LLVM +lora +Merlinite +Miniforge +Mixtral +MLX +mlx +NVidia +Nvidia +orchestrator +ots +Pareja +PEFT +PlantUML +Podman +pre +preprint +pyenv +PyPI +PyTorch +qlora +quantized +Quantizing +Radeon +RDNA +README +repo +ROCm +RTX +RX +Salawu +SDG +sexualized +SHA +Shivchander +Srivastava +subdirectory +Sudalairaj +Taj +tatsu +TBD +Tesla +th +th +tl +tox +unquantized +USM +venv +wikisql +WSL +xcode +XNACK +XT +XTX +Xu +YAML diff --git a/Makefile b/Makefile index 82a3aa8..c6a369e 100644 --- a/Makefile +++ b/Makefile @@ -2,6 +2,10 @@ help: @awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n make \033[36m\033[0m\n"} /^[a-zA-Z_0-9-]+:.*?##/ { printf " \033[36m%-18s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST) +.PHONY: spellcheck-sort +spellcheck-sort: .spellcheck-en-custom.txt + sort -d -f -o $< $< + # # If you want to see the full commands, run: # NOISY_BUILD=y make