Skip to content

Commit

Permalink
Config spellchecker
Browse files Browse the repository at this point in the history
  • Loading branch information
@szmazurek
szmazurek committed Sep 16, 2024
1 parent 94e73e8 commit b98d76d
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions .github/workflows/spellchecker.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -123,6 +123,11 @@ jobs:
cspell:css/dict/css.txt
cspell:npm/dict/npm.txt
cspell:latex/dict/latex.txt
cspell:latex/samples/sample-words.txt
cspell:html-symbol-entities/entities.txt
cspell:html/dict/html.txt
cspell:cpp/src/ecosystem.txt
cspell:mnemonics/src/mnemonics.txt

comment-push:
name: Report (Push)
Expand Down

1 comment on commit b98d76d

@github-actions
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@check-spelling-bot Report

🔴 Please review

See the 📜action log or 📝 job summary for details.

Unrecognized words (637) 
Abhishek
Abousamra
acsconv
adadelta
adagrad
adamax
adamw
addcdiv
addcmul
addgroup
addoption
ademamix
agc
agni
Aimilia
aimiliag
albumentations
allclose
allcontributors
allsigned
amsgrad
Anirban
anomymizer
anonymization
applyaugs
apptainer
Aqubvel
arange
archs
arcname
argmax
argwhere
Arnout
arxiv
asarray
astype
atleast
augs
auroc
autobuild
autocast
autodetermined
auxilary
avgs
awaa
Babak
bacf
backprop
backpropagate
backpropagation
Baheti
Baid
Bakas
Bashyam
batchnorm
bdfc
beggining
bfda
bgr
Bhalerao
biggeest
bincount
biomedicalimaging
Bjoern
blabla
brahim
brainage
Brox
btw
Buildx
BVpye
capsys
cbica
cbig
cca
CCE
cel
cencoder
centercrop
cff
Chitalia
christos
Chunrui
Chv
cla
classif
classitk
codacy
codecov
CODEOWNERS
codeql
codereview
codespace
Colab
colorconv
colorjitter
colorlog
commandline
configfile
configgenerator
convs
cooldown
cosineannealing
cosineannealinglr
cosinesimilarity
croporpad
cropzero
ctc
CUBLAS
cudnn
cycliclr
datacenter
dataframe
dataprep
datestampnow
Davatzikos
dcbca
dcce
dclog
dcm
dcmtk
ddce
deac
deadsnakes
DEBIAN
deconv
deepresunet
Deepthi
deepunet
denseblock
denselayer
densenet
depthconv
Despina
despinak
devcontainer
dfu
dicelog
dicom
dicomanonymizer
digestpath
discussioncomment
DLF
DNN
dockerfiles
dockerized
dockertag
doi
Dokania
dotnet
downsamp
downsample
downsampling
doxygen
dpn
dqbm
dropna
dtype
dynunet
edac
edt
edu
eep
efc
efficientnet
efficientnetb
effiency
elementwise
embeddings
Emre
ener
entrypoints
Ethem
excepthook
exctype
exponentiallr
fcn
Fdocker
fepegar
figsize
filenaming
filereader
fillna
finetuned
flaim
fnull
frgfm
fromarray
fromiter
Fsegmentation
Fulcio
Fworkflows
gandlf
Gastounioti
gbp
gcam
gcampp
GDCM
gdown
gelu
geometricanirban
Getka
getoption
getsizeof
ggcam
ghc
gle
glx
Gonz
Gotkowski
gpu
Grenko
gridaggregator
gridsampler
groundtruth
Guley
gumbel
Haghighi
Hamamc
Hamamci
hausdorff
healper
heatmaps
hexops
histo
histopath
holocron
hookwrapper
HOUNSFIELD
hpc
hstack
HTR
hyperparameters
idxs
ihc
iloc
imagenet
imbalanced
imread
imsave
imshow
imwrite
indeces
inlinehilite
inp
inputdata
instancenorm
interp
ISBI
issn
itcr
iterrows
itk
itkimage
itksnap
jaccard
JAX
JBHI
JDu
JSTARS
Junwen
jupyter
Jupyterlab
kaiming
kakumarabhishek
Karargyris
Karkada
keepdim
keleshev
kenshohara
KFold
kickstart
kld
Kontos
ksel
kspace
Kullback
Kurc
labelsample
labelsampler
lambd
layerchange
leakyrelu
Leibler
levelname
levelno
libgl
libjpeg
libpython
libsm
libvips
libxext
lightresunet
lightunet
linalg
linenums
lineplot
linspace
linting
lly
logit
logpt
logsoftmax
logvar
longreprtext
lps
lrelu
LROn
lstsq
lucidrains
macenko
mainrun
makereport
mathews
matplotlib
matthews
maxpool
mbergman
mcc
mcclog
MCD
mcr
MCT
mde
mdmc
medcam
medmnist
medperf
medpy
Megh
mencoder
menze
metr
miccai
missingprediction
misspled
mkdocs
mlcommons
mlcube
mlcubedir
mlp
modelbase
modeldir
modelio
monai
Mouchtaris
moveaxis
mpp
mps
mri
msa
mscadocs
msdnet
mse
msle
Mukhopadhyay
multiclass
multidim
multilabel
mytagname
nadam
nans
naveenk
ncbi
ncc
ndarray
ndexbio
ndim
ndimage
NDLF
nesterov
neuroimage
nfnets
nibabel
nicl
NIf
nifti
nih
nii
nlabel
nmae
nnf
nonroot
normtype
notsigned
novograd
nsd
nuitka
numel
numlay
nvidia
octicons
offis
ohif
onefile
onlatest
onnx
openfl
openslide
opensource
openvino
opm
opset
Orhun
ossar
outconv
outputdir
outputfile
palletsprojects
Panchumarthy
pathmnist
pati
pbar
pchs
Pdocker
pearson
Phenomics
pkl
plt
pmwiki
pnas
Prashant
prcomment
predics
predmask
preds
probs
Prunner
psnr
psutil
pth
PTk
pubmed
purelib
pwadry
pydantic
pydicom
pyinstaller
pymdownx
pypa
pyplot
pytorch
pyversion
qsub
qubvel
radam
Radeon
radiomics
radxtools
ramework
randomaffine
randomanisotropy
randombiasfield
randomblur
randomelasticdeformation
randomflip
randommotion
randomnoise
randomswap
reco
recoverconfig
reducelronplateau
reduceonplateau
reencoded
refernce
Rekor
relativized
relu
rensen
Reparameterization
reparameterize
rescaler
residualunet
resnet
resunet
rgbatorgb
rgbtorgba
rigourous
rmsprop
rocm
rocmdocs
Ronneberger
rowvar
ruifrok
runnning
runtest
Saltz
samplewise
Sarthak
sarthakpati
savefig
sbakas
sbia
scikit
scipy
screenshots
scse
sdata
sdnet
seaborn
sebastianffx
securefederatedai
segmap
segmask
segmentor
Sens
sessionstart
setbiasranges
setcutoffrange
setsigmaranges
Sezgin
sge
Shahira
shubham
siddhesh
sigstore
silu
Simonyan
simpleitk
sitk
skimage
sklearn
slurm
smi
socio
Soham
Sotirios
sparseadam
spellchecker
spellckecker
Sprop
Spyridon
ssim
stackexchange
stainextract
stainlib
steplr
stepsize
sterr
subjectid
subommands
sume
superfences
sustainability
swapaxes
Tahsin
tcia
tempconvs
tgz
thresholded
thresholding
Thu
tiatoolbox
tiffslide
timepoints
timm
tio
tioq
tiosd
tmi
TOOLSDIRECTORY
torchaudio
torchinfo
torchio
torchmetrics
torchvision
towardsdatascience
TPAMI
tqdm
traininginference
transunet
triaged
tryfirst
tsaftaris
TUDA
tversky
uanced
uinc
Ujjwal
Umeton
unet
unetr
uniformsample
uniformsampler
unittests
unitwise
unsqueeze
upenn
upsample
upsampled
upsampling
utm
uzh
vahadane
validing
valuetopredict
vgg
Vinayak
vios
visualstudiomagazine
vmem
voxel
VRAM
vtk
vvv
WACV
warmupcosineschedule
wcs
weightedsample
weightedsampler
whl
WORKDIR
wsi
wsl
xavier
xdim
XDl
XEI
xkq
xlabel
xlim
xnat
XResolution
XTools
yamlchecker
yamlvalidator
ydim
ylabel
YResolution
Yrv
Yuemeng
zarr
Zeroplanes
zicat
znorm
ZNormalization
Zou
Some files were automatically ignored 🙈

These sample patterns would exclude them:

^\Q__init__.py\E$
^\QGANDLF/data/patch_miner/__init__.py\E$
^\QGANDLF/data/patch_miner/opm/__init__.py\E$
^\QGANDLF/grad_clipping/__init__.py\E$
^\QGANDLF/models/seg_modules/__init__.py\E$
^\Qtesting/__init__.py\E$

You should consider adding them to:

.github/actions/spelling/excludes.txt

File matching is via Perl regular expressions.

To check these files, more of their words need to be in the dictionary than not. You can use patterns.txt to exclude portions, add items to the dictionary (e.g. by adding them to allow.txt), or fix typos.

To accept these unrecognized words as correct and update file exclusions, you could run the following commands

... in a clone of the [email protected]:mlcommons/GaNDLF.git repository
on the feature/spellchecker branch (ℹ️ how do I use this?):

curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/main/apply.pl' |
perl - 'https://github.com/mlcommons/GaNDLF/actions/runs/10886640156/attempts/1'
Available 📚 dictionaries could cover words not in the 📘 dictionary
Dictionary Entries Covers Uniquely
cspell:java/src/java-terms.txt 920 1 1

Consider adding them (in .github/workflows/spellchecker.yml) for uses: check-spelling/check-spelling@main in its with:

      with:
        extra_dictionaries:
          cspell:java/src/java-terms.txt

To stop checking additional dictionaries, add (in .github/workflows/spellchecker.yml) for uses: check-spelling/check-spelling@main in its with:

check_extra_dictionaries: ''
Pattern suggestions ✂️ (29)

You could add these patterns to .github/actions/spelling/patterns.txt:

# Automatically suggested patterns
# hit-count: 707 file-count: 61
# machine learning (?)
\b(?i)ml(?=[a-z]{2,})

# hit-count: 555 file-count: 102
# https/http/file urls
(?:\b(?:https?|ftp|file)://)[-A-Za-z0-9+&@#/*%?=~_|!:,.;]+[-A-Za-z0-9+&@#/*%=~_|]

# hit-count: 144 file-count: 49
# GitHub SHAs (markdown)
(?:\[`?[0-9a-f]+`?\]\(https:/|)/(?:www\.|)github\.com(?:/[^/\s"]+){2,}(?:/[^/\s")]+)(?:[0-9a-f]+(?:[-0-9a-zA-Z/#.]*|)\b|)

# hit-count: 125 file-count: 52
# python
\b(?i)py(?!gments|gmy|lon|ramid|ro|th)(?=[a-z]{2,})

# hit-count: 40 file-count: 28
# scala imports
^import (?:[\w.]|\{\w*?(?:,\s*(?:\w*|\*))+\})+

# hit-count: 26 file-count: 8
# libraries
(?:\b|_)lib(?:re(?=office)|)(?!era[lt]|ero|erty|rar(?:i(?:an|es)|y))(?=[a-z])

# hit-count: 22 file-count: 13
# Python string prefix / binary prefix
# Note that there's a high false positive rate, remove the `?=` and search for the regex to see if the matches seem like reasonable strings
(?<!['"])\b(?:B|BR|Br|F|FR|Fr|R|RB|RF|Rb|Rf|U|UR|Ur|b|bR|br|f|fR|fr|r|rB|rF|rb|rf|u|uR|ur)['"](?=[A-Z]{3,}|[A-Z][a-z]{2,}|[a-z]{3,})

# hit-count: 16 file-count: 8
# version suffix <word>v#
(?:(?<=[A-Z]{2})V|(?<=[a-z]{2}|[A-Z]{2})v)\d+(?:\b|(?=[a-zA-Z_]))

# hit-count: 14 file-count: 9
# GitHub actions
\buses:\s+[-\w.]+/[-\w./]+@[-\w.]+

# hit-count: 13 file-count: 10
# Compiler flags (Unix, Java/Scala)
# Use if you have things like `-Pdocker` and want to treat them as `docker`
(?:^|[\t ,>"'`=(])-(?:(?:J-|)[DPWXY]|[Llf])(?=[A-Z]{2,}|[A-Z][a-z]|[a-z]{2,})

# hit-count: 12 file-count: 1
# tar arguments
\b(?:\\n|)g?tar(?:\.exe|)(?:(?:\s+--[-a-zA-Z]+|\s+-[a-zA-Z]+|\s[ABGJMOPRSUWZacdfh-pr-xz]+\b)(?:=[^ ]*|))+

# hit-count: 9 file-count: 9
# Compiler flags (Windows / PowerShell)
# This is a subset of the more general compiler flags pattern.
# It avoids matching `-Path` to prevent it from being treated as `ath`
(?:^|[\t ,"'`=(])-(?:[DPL](?=[A-Z]{2,})|[WXYlf](?=[A-Z]{2,}|[A-Z][a-z]|[a-z]{2,}))

# hit-count: 8 file-count: 7
# hex runs
\b[0-9a-fA-F]{16,}\b

# hit-count: 6 file-count: 6
# mailto urls
mailto:[-a-zA-Z=;:/?%&0-9+@._]{3,}

# hit-count: 5 file-count: 3
# URL escaped characters
%[0-9A-F][A-F](?=[A-Za-z])

# hit-count: 4 file-count: 4
# Docker images
^\s*FROM\s+\S+:\S+(?:\s+AS\s+\S+|)

# hit-count: 4 file-count: 1
# shields.io
\bshields\.io/[-\w/%?=&.:+;,]*

# hit-count: 1 file-count: 1
# Google Forms
\bforms\.gle/\w+

# hit-count: 1 file-count: 1
# gist github
\bgist\.github\.com/[^/\s"]+/[0-9a-f]+

# hit-count: 1 file-count: 1
# git.io
\bgit\.io/[0-9a-zA-Z]+

# hit-count: 1 file-count: 1
# Contributor
\[[^\]]+\]\(https://github\.com/[^/\s"]+/?\)

# hit-count: 1 file-count: 1
# vs devops
\bvisualstudio.com(?::443|)/[-\w/?=%&.]*

# hit-count: 1 file-count: 1
# codacy
\bapi\.codacy\.com/project/badge/Grade/[0-9a-f]+

# hit-count: 1 file-count: 1
# stackexchange -- https://stackexchange.com/feeds/sites
\b(?:askubuntu|serverfault|stack(?:exchange|overflow)|superuser).com/(?:questions/\w+/[-\w]+|a/)

# hit-count: 1 file-count: 1
# Wikipedia
\ben\.wikipedia\.org/wiki/[-\w%.#]+

# hit-count: 1 file-count: 1
# uuid:
\b[0-9a-fA-F]{8}-(?:[0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}\b

# hit-count: 1 file-count: 1
# Non-English
[a-zA-Z]*[ÀÁÂÃÄÅÆČÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝßàáâãäåæčçèéêëìíîïðñòóôõöøùúûüýÿĀāŁłŃńŅņŒœŚśŠšŜŝŸŽžź][a-zA-Z]{3}[a-zA-ZÀÁÂÃÄÅÆČÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝßàáâãäåæčçèéêëìíîïðñòóôõöøùúûüýÿĀāŁłŃńŅņŒœŚśŠšŜŝŸŽžź]*|[a-zA-Z]{3,}[ÀÁÂÃÄÅÆČÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝßàáâãäåæčçèéêëìíîïðñòóôõöøùúûüýÿĀāŁłŃńŅņŒœŚśŠšŜŝŸŽžź]|[ÀÁÂÃÄÅÆČÇÈÉÊËÌÍÎÏÐÑÒÓÔÕÖØÙÚÛÜÝßàáâãäåæčçèéêëìíîïðñòóôõöøùúûüýÿĀāŁłŃńŅņŒœŚśŠšŜŝŸŽžź][a-zA-Z]{3,}

# hit-count: 1 file-count: 1
# in [email protected]+, printf markers aren't automatically consumed
# printf markers
(?<!\\)\\[nrt](?=[a-z]{2,})

# hit-count: 1 file-count: 1
# alternate printf markers if you run into latex and friends
(?<!\\)\\[nrt](?=[a-z]{2,})(?=.*['"`])
Errors (4)

See the 📜action log or 📝 job summary for details.

❌ Errors Count
ℹ️ binary-file 6
ℹ️ candidate-pattern 59
❌ check-file-path 299
❌ forbidden-pattern 10

See ❌ Event descriptions for more information.

Please sign in to comment.