Skip to content

Commit

Permalink
Add ability to run spellcheck locally
Browse files Browse the repository at this point in the history
Signed-off-by: Nathan Weinberg <nweinber@redhat.com>
  • Loading branch information
nathan-weinberg committed Apr 29, 2024
1 parent db8375f commit aa3e7c2
Show file tree
Hide file tree
Showing 4 changed files with 52 additions and 2 deletions.
17 changes: 17 additions & 0 deletions .spellcheck-en-custom.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ arge
arXiv
backend
backends
benchmarking
Bhandwaldar
CLI
cli
Expand All @@ -18,15 +19,18 @@ cpp
cuBLAS
CUDA
dataset
DCO
dev
ditaa
dr
Dropdown
env
Eval
Excalidraw
Finetuning
GFX
GGUF
GGUFs
GiB
Gmail
gpu
Expand All @@ -48,7 +52,10 @@ LLM
llms
LLVM
lora
md
Mergify
Merlinite
mimimum
Miniforge
Mixtral
MLX
Expand All @@ -60,9 +67,11 @@ ots
Pareja
PEFT
PlantUML
PNG
Podman
pre
preprint
PR's
pyenv
PyPI
PyTorch
Expand All @@ -72,15 +81,18 @@ Quantizing
Radeon
RDNA
README
rebase
repo
ROCm
RTX
RX
safetensors
Salawu
SDG
sexualized
SHA
Shivchander
Signoff
Srivastava
subdirectory
Sudalairaj
Expand All @@ -92,9 +104,14 @@ th
th
tl
tox
triager
Triagers
triager's
triagers
unquantized
USM
venv
watsonx
wikisql
WSL
xcode
Expand Down
29 changes: 29 additions & 0 deletions .spellcheck.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@

# SPDX-License-Identifier: Apache-2.0

matrix:
- name: markdown
aspell:
lang: en
d: en_US
camel-case: true
mode: markdown
sources:
- "**/*.md|!REVIEWERS.md|!build/**|!.tox/**"
dictionary:
wordlists:
- .spellcheck-en-custom.txt
pipeline:
- pyspelling.filters.context:
context_visible_first: true
escapes: '\\[\\`~]'
delimiters:
# Ignore multiline content between fences (fences can have 3 or more back ticks)
# ```language
# content
# ```
- open: '(?s)^(?P<open> *`{3,}).*?$'
close: '^(?P=open)$'
# Ignore text between inline back ticks
- open: '(?P<open>`+)'
close: '(?P=open)'
4 changes: 4 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@
help:
@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n make \033[36m<target>\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
spellcheck: .spellcheck.yml
pyspelling --config $<

.PHONY: spellcheck-sort
spellcheck-sort: .spellcheck-en-custom.txt
sort -d -f -o $< $<
Expand Down
4 changes: 2 additions & 2 deletions docs/huggingface-publish-strategy.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@ We will be publishing two different kinds of model families - Merlinite and Gran

The Merlinite model family is based off the [Mistral](https://mistral.ai/) model family and uses the [Large-scale Alignment for chatBots (LAB)](https://arxiv.org/abs/2403.01081) alignment. You can read more about it [here](https://huggingface.co/instructlab/merlinite-7b-lab).

The InstructLab organzation will be publishing a community version of the Merlinite 7B size model, in both unquantized and 4-bit quantized GGUF form.
The InstructLab organization will be publishing a community version of the Merlinite 7B size model, in both unquantized and 4-bit quantized GGUF form.

## Granite

The Granite model family is the [foundational model family](https://www.ibm.com/downloads/cas/X9W4O6BM) for the IBM watsonx AI platform, designed for usage in a business environment. You can read more about it [here](https://huggingface.co/instructlab/granite-7b-lab).

The InstructLab organzation will be publishing a community version of the Granite 7B size model using the [Large-scale Alignment for chatBots (LAB)](https://arxiv.org/abs/2403.01081) alignment, in both unquantized and 4-bit quantized GGUF form.
The InstructLab organization will be publishing a community version of the Granite 7B size model using the [Large-scale Alignment for chatBots (LAB)](https://arxiv.org/abs/2403.01081) alignment, in both unquantized and 4-bit quantized GGUF form.

## Naming Scheme

Expand Down

0 comments on commit aa3e7c2

Please sign in to comment.