Adding spellcheck to CI, and fixing docs along the way

.circleci/config.yml

@@ -19,6 +19,17 @@ commands:
               circleci step halt
             fi
 
+  abort_for_spelling:
+    steps:
+      - run:
+          name: Avoid tests for things marked spelling
+          command: |
+            if [[ $CIRCLE_BRANCH == *spelling ]]; then
+              echo "Identifies as spelling PR, no testing required"
+              circleci step halt
+            fi
+
+
   abort_for_noci:
     steps:
       - run:
@@ -121,6 +132,7 @@ commands:
         type: string
     steps:
       - abort_for_docs
+      - abort_for_spelling
       - abort_for_noci
       - checkout-all
       - restore_cache:
@@ -173,6 +185,7 @@ commands:
         default: "CLUSTER=0 AOF=0"
     steps:
       - abort_for_docs
+      - abort_for_spelling
       - abort_for_noci
       - checkout-all
       - restore_cache:
@@ -203,6 +216,7 @@ commands:
   build-and-test-gpu-steps:
     steps:
       - abort_for_docs
+      - abort_for_spelling
       - abort_for_noci
       - checkout-all
       - restore_cache:
@@ -241,6 +255,7 @@ jobs:
       - image: redisfab/rmbuilder:6.2.5-x64-bullseye
     steps:
       - abort_for_docs
+      - abort_for_spelling
       - abort_for_noci
       - checkout-all
       - setup-build-system
@@ -269,6 +284,7 @@ jobs:
         default: "CPU=1"
     steps:
       - abort_for_docs
+      - abort_for_spelling
       - abort_for_noci
       - early_return_for_forked_pull_requests
       - setup_remote_docker
@@ -306,6 +322,7 @@ jobs:
         default: "GPU=1"
     steps:
       - abort_for_docs
+      - abort_for_spelling
       - abort_for_noci
       - early_return_for_forked_pull_requests
       - checkout-all
@@ -332,6 +349,7 @@ jobs:
       - image: redisfab/rmbuilder:6.2.5-x64-bullseye
     steps:
       - abort_for_docs
+      - abort_for_spelling
       - abort_for_noci
       - checkout-all
       - restore_cache:
@@ -369,6 +387,7 @@ jobs:
       - image: redisfab/rmbuilder:6.2.5-x64-bullseye
     steps:
       - abort_for_docs
+      - abort_for_spelling
       - abort_for_noci
       - checkout-all
       - restore_cache:
@@ -439,6 +458,7 @@ jobs:
       - image: redisfab/rmbuilder:6.2.5-x64-bullseye
     steps:
       - abort_for_docs
+      - abort_for_spelling
       - abort_for_noci
       - early_return_for_forked_pull_requests
       - attach_workspace:
@@ -457,6 +477,7 @@ jobs:
       - image: redisfab/rmbuilder:6.2.5-x64-bullseye
     steps:
       - abort_for_docs
+      - abort_for_spelling
       - abort_for_noci
       - early_return_for_forked_pull_requests
       - attach_workspace:
@@ -474,6 +495,7 @@ jobs:
       - image: redisfab/rmbuilder:6.2.5-x64-bullseye
     steps:
       - abort_for_docs
+      - abort_for_spelling
       - abort_for_noci
       - early_return_for_forked_pull_requests
       - attach_workspace:

.github/spellcheck-settings.yml

@@ -0,0 +1,27 @@
+matrix:
+- name: Markdown
+  expect_match: false
+  apsell:
+    lang: en
+    d: en_US
+  dictionary:
+    wordlists:
+    - .github/wordlist.txt
+    output: wordlist.dic
+  pipeline:
+  - pyspelling.filters.markdown:
+      markdown_extensions:
+      - markdown.extensions.extra:
+  - pyspelling.filters.html:
+      comments: false
+      attributes:
+      - alt
+      ignores:
+      - ':matches(code, pre)'
+      - code
+      - pre
+      - blockquote
+      - img
+  sources:
+  - '*.md'
+  - 'docs/*.md'

.github/wordlist.txt

@@ -0,0 +1,184 @@
+acyclic
+addtwo
+ai
+AIBench
+aibench
+allocator
+AnimalRecognitionDemo
+anonymized
+AOF
+APIs
+ARGS
+args
+BACKEND
+Backend
+backend
+Backends
+backends
+BACKENDSPATH
+bandwith
+BATCHSIZE
+benchmarked
+benchmarking
+bert
+bmatrix
+bool
+casted
+chatbot
+ChatBotDemo
+cli
+CMake
+cmake
+color
+Configurability
+configurability
+cpu
+CPUs
+creditcard
+ctionary
+CUDA
+cuDF
+cuDNN
+cuPy
+DAGEXECUTE
+DAGRUN
+Dani
+dengliming
+Dependancy
+DGL
+DL
+dlpack
+dockerfile
+durations
+eco
+EdgeRealtimeVideoAnalytics
+enqueuing
+erver
+exmaple
+Fortran
+gaussian
+Github
+github
+GPUs
+Gunicorn
+https
+hyperloglogs
+INITIALIZERS
+INTRA
+io
+iss
+Javascript
+jinja
+JRedisAI
+js
+Kaggle
+Keras
+keyspace
+latencies
+lcov
+libtensorflow
+libtorch
+linux
+LOADBACKEND
+loopback
+Memcache
+memtier
+metodology
+MINBATCHSIZE
+MINBATCHTIMEOUT
+Misspelled words:
+mnist
+MobileNet
+MODELDEL
+MODELEXECUTE
+MODELGET
+MODELRUN
+MODELSCAN
+MODELSET
+MODELSTORE
+mul
+MxNet
+mymodel
+myscript
+mytensor
+netperf
+Netron
+NoSQL
+Nvidia
+nvidia
+ONNX
+onnx
+ONNXRuntime
+Onnxruntime
+onnxruntime
+OSS
+pb
+performant
+persistency
+pipelining
+pre
+prediciting
+prepending
+Protobuf
+protobuf
+py
+pytest
+Quickstart
+RAI
+RDB
+Realtime
+redisai
+RedisAI
+RedisAI's
+RedisTimeSeries
+RESETSTAT
+ResNet
+RLTest
+RO
+SCRIPTDEL
+SCRIPTEXECUTE
+SCRIPTGET
+SCRIPTRUN
+SCRIPTSCAN
+SCRIPTSET
+scripts's
+SCRIPTSTORE
+sdk
+smartredis
+stdout
+str
+submodules
+tA
+tB
+TCP
+templating
+Tensorflow
+tensorflow
+TENSORGET
+TensorRT
+tensor's
+TENSORSET
+Tensorwerk
+testbed
+TF
+tf
+TFLITE
+TFLite
+TGL
+th
+tModel
+tmpl
+TorchScript
+TorchServe
+TPUs
+Tseitlin
+TypeScript
+ubuntu
+usr
+utf
+variadic
+venv
+virtualenv
+wget
+WSGI
+xyz

.github/workflows/spellcheck.yml

@@ -0,0 +1,16 @@
+name: Spellcheck
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+jobs:
+  spellcheck:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Spellcheck
+        uses: rojopolis/[email protected]
+        with:
+          config_path: .github/spellcheck-settings.yml
+          task_name: Markdown

.gitignore

@@ -15,8 +15,9 @@ venv*/
 *.tgz
 *.tar.gz
 /VARIANT
+wordlist.dic
 
-# Docs API reference 
+# Docs API reference
 docs/api_reference.md
 
 ### Cmake auto tools