Skip to content

Commit e1f744e

Browse files
committed
chore: update vale rules from RedHat
* Added `NVIDIA` to case-sensitive terms. * Normalized `dotNet` casing. * Included various AI/ML acronyms and technical terms in definition exceptions. * Added numerous AI/ML model and project names to PascalCase/CamelCase exceptions. * Removed `NVidia` from PascalCase/CamelCase and spelling exceptions. * Included URLs and `CI/CD` in slash exceptions. * Added many AI/ML-related repository patterns to slash exceptions. * Added various AI/ML specific spelling exceptions such as `finetune`, `multimodal`, `quantizable`, `smoothquant`, `sparsification`, and `tokenizers`. * Refined the `env` rule to suggest `environment` more accurately. * Refined the `builtin` rule. * Improved the `k8s` suggestion rule to prevent false positives. Signed-off-by: Chmouel Boudjnah <chmouel@redhat.com>
1 parent ef502fb commit e1f744e

File tree

7 files changed

+173
-18
lines changed

7 files changed

+173
-18
lines changed

.vale/styles/RedHat/CaseSensitiveTerms.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ swap:
3232
'(?<!JBoss )EAP|(?<!Red Hat )JBoss(?!\sCommunity|\sBroker|\sClients|\sConsole|\sAMQ|\sData\sGrid|\sBRMS|\sBPMS|\sEnterprise\sApplication\sPlatform|\.org|\sInterconnect|\sEAP|\sBPM\sSuite)': JBoss EAP
3333
'(?<!Realtime )Decision\sServer': Realtime Decision Server
3434
'[nN]odejs|[nN]ode\.JS|node\.js': Node.js
35-
'dotNet': .NET
35+
'\b(NVidia|N-Vidia|Nvidia|nVIDIA|nvidia[^\/])\b': NVIDIA
3636
'A-MQ(?!\sBroker|\sClient|\sConsole|\sInterconnect)': AMQ
3737
'A-MQ\sBroker': AMQ Broker
3838
'A-MQ\sClients': AMQ Clients
@@ -42,6 +42,7 @@ swap:
4242
'ActiveMQ\sArtemis|ActiveMQ(?!\sArtemis)': built-in messaging|JBoss EAP built-in messaging|JBoss EAP messaging
4343
'Admin\sPortal|webadmin\sportal|webadmin|Administrator\sPortal|Administration\sportal': Administration Portal
4444
'BRMS\sengine': inference engine
45+
'dotNet': .NET
4546
'GUI\seditor|Business\sCentral\seditor': guided editor
4647
'JBoss\.org': JBoss Community
4748
'JBoss\sAMQ': AMQ

.vale/styles/RedHat/Definitions.yml

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ exceptions:
1515
- 'CVEs?'
1616
- 'DVDs?'
1717
- 'GIDs?'
18+
- 'GPUs?'
19+
- 'LLMs?'
1820
- 'NULL'
1921
- 'PIDs?'
2022
- 'ROMs?'
@@ -23,10 +25,12 @@ exceptions:
2325
- 'URIs?'
2426
- 'URLs?'
2527
- ACPI
28+
- AIDC
2629
- AIX
2730
- ARM
2831
- ASCII
2932
- ASP
33+
- AWQ
3034
- AWS
3135
- BIND
3236
- BIOS
@@ -60,14 +64,16 @@ exceptions:
6064
- GCJ
6165
- GDB
6266
- GET
67+
- GGUF
6368
- GIF
6469
- GIMP
6570
- GNOME
6671
- GNU
6772
- GNUPro
6873
- GPL
69-
- GPU
74+
- GPTQ
7075
- GRUB
76+
- GSAI
7177
- GTK+
7278
- GUI
7379
- GUID
@@ -94,6 +100,7 @@ exceptions:
94100
- LAN
95101
- LDAP
96102
- LESS
103+
- LGAI
97104
- LLDB
98105
- LPAR
99106
- LUKS
@@ -102,12 +109,15 @@ exceptions:
102109
- MB
103110
- MBR
104111
- MDS
112+
- MLP
113+
- MLX
105114
- mTLS
106115
- NAT
107116
- NET
108117
- NFS
109118
- NGINX
110119
- NIC
120+
- NLP
111121
- NOTE
112122
- NTP
113123
- NVDA
@@ -149,6 +159,7 @@ exceptions:
149159
- SCSI
150160
- SCSS
151161
- SDK
162+
- SEED
152163
- SFTP
153164
- SHA
154165
- SOCKS

.vale/styles/RedHat/PascalCamelCase.yml

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,21 +34,26 @@ exceptions:
3434
- CheckTree
3535
- ClassLoader
3636
- CloudForms
37+
- CodeLlama
3738
- CodeReady
3839
- ConfigMaps?
3940
- ConnectX
4041
- Convert2RHEL
4142
- CoreOS
4243
- DaemonSet
4344
- DDoS
45+
- DeepSeek
4446
- DevOps
4547
- DevWorkspace
48+
- DialoGPT
4649
- DNSSec
50+
- EleutherAI
4751
- eServer
4852
- eXpress
4953
- eXtenSion
5054
- FaaS
5155
- FCoE
56+
- FFmpeg
5257
- FileStore
5358
- FireWire
5459
- FreeRADIUS
@@ -67,6 +72,7 @@ exceptions:
6772
- HashBase
6873
- HdrHistogram
6974
- Helm
75+
- HyperCLOVAX
7076
- HyperShift
7177
- IaaS
7278
- IBoE
@@ -81,12 +87,14 @@ exceptions:
8187
- IPsec
8288
- IPv
8389
- ISeries
90+
- JackFram
8491
- JavaScript
8592
- JBoss
8693
- JetBrains
8794
- JUnit
8895
- kBps
8996
- KiB
97+
- KTLim
9098
- LangTags
9199
- LGPLv
92100
- libOSMesa
@@ -95,12 +103,15 @@ exceptions:
95103
- LightPulse
96104
- LinuxONE
97105
- LiquidIO
106+
- LLaDA
98107
- ManageIQ
99108
- MariaDB
109+
- MaziyarPanahi
100110
- MBps
101111
- MegaRAID
102112
- MiB
103113
- MicroProfile
114+
- MoE
104115
- MongoDB
105116
- MoreUtils
106117
- MySQL
@@ -112,14 +123,16 @@ exceptions:
112123
- NetXtreme
113124
- NFSv
114125
- NMState
126+
- NousResearch
115127
- NuGet
116-
- NVidia
117128
- NVMe
118129
- OAuth
119130
- objectClass
120131
- OmniSharp
121132
- OneConnect
133+
- OpenELM
122134
- OpenEXR
135+
- OpenHermes
123136
- OpenID
124137
- OpenIPMI
125138
- OpenJDK
@@ -162,13 +175,16 @@ exceptions:
162175
- SmallRye
163176
- SmartNIC
164177
- SmartState
178+
- SmolLM
165179
- SQLite
166180
- StarOffice
167181
- STMicroelectronics
168182
- SuperLU
169183
- SysV
170184
- TBps
185+
- TheBloke
171186
- TiB
187+
- TinyLlama
172188
- TuneD
173189
- TypeScript
174190
- UltraSPARC
@@ -179,6 +195,7 @@ exceptions:
179195
- VMware
180196
- vSphere
181197
- vSwitch
198+
- vLLM
182199
- WebAuthn
183200
- WebSocket
184201
- WireGuard

.vale/styles/RedHat/Slash.yml

Lines changed: 80 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,24 @@
1-
---
21
extends: existence
32
ignorecase: true
43
level: warning
54
link: https://redhat-documentation.github.io/vale-at-red-hat/docs/main/reference-guide/slash/
65
message: "Use either 'or' or 'and' in '%s'"
7-
# source: "IBM - Slashes, p. 68"
86
scope:
97
- sentence
108
- heading
119
tokens:
1210
- '(?<!/)\w+/\w+'
1311
exceptions:
14-
- '\d{1,4}\/\d{1,4}'
12+
# numbers/dates
13+
- '\d{1,4}/\d{1,4}'
14+
# URLs and schemes
15+
- 'https?://\S+'
16+
# common technical terms
1517
- "0/"
1618
- "[Ii]nput/[Oo]utput"
19+
- "[Kk]ey/value"
1720
- "C/C"
21+
- "CI/CD"
1822
- "client/server"
1923
- "I/O"
2024
- "N/A"
@@ -24,4 +28,76 @@ exceptions:
2428
- "upstream/downstream"
2529
- "z/OS"
2630
- "z/OSMF"
27-
- "[Kk]ey/value"
31+
- '.*ai/\w+'
32+
- '.*AI/\w+'
33+
- '.*community/\w+'
34+
- '.*EXAONE/\w+'
35+
- '.*granite/\w+'
36+
- '.*hyperclovax/\w+'
37+
- '.*KTLim/\w+'
38+
- '.*labs/\w+'
39+
- '.*llama/\w+'
40+
- '.*ML/\w+'
41+
- '.*NLP/\w+'
42+
- '.*org/\w+'
43+
- '.*quants/\w+'
44+
- '.*research/\w+'
45+
- '.*spaces/\w+'
46+
- '.*t5/\w+'
47+
- '.*team/\w+'
48+
- '.*testing/\w+'
49+
- 'AIDC-AI/\w+'
50+
- 'Alibaba-NLP/\w+'
51+
- 'apple/\w+'
52+
- 'bartowski/\w+'
53+
- 'bigcode/\w+'
54+
- 'bigscience/\w+'
55+
- 'codellama/\w+'
56+
- 'context-labs/\w+'
57+
- 'deepseek-ai/\w+'
58+
- 'distilbert/\w+'
59+
- 'dphn/\w+'
60+
- 'EleutherAI/\w+'
61+
- 'facebook/\w+'
62+
- 'fxmarty/\w+'
63+
- 'Gensyn/\w+'
64+
- 'ggml-org/\w+'
65+
- 'google-t5/\w+'
66+
- 'google/\w+'
67+
- 'GSAI-ML/\w+'
68+
- 'hugging-quants/\w+'
69+
- 'HuggingFaceH4/\w+'
70+
- 'HuggingFaceM4/\w+'
71+
- 'HuggingFaceTB/\w+'
72+
- 'ibm-granite/\w+'
73+
- 'ibm-research/\w+'
74+
- 'JackFram/\w+'
75+
- 'kaitchup/\w+'
76+
- 'katuni4ka/\w+'
77+
- 'kosbu/\w+'
78+
- 'LGAI-EXAONE/\w+'
79+
- 'liuhaotian/\w+'
80+
- 'llamafactory/\w+'
81+
- 'lmstudio-community/\w+'
82+
- 'lmsys/\w+'
83+
- 'MaziyarPanahi/\w+'
84+
- 'meta-llama/\w+'
85+
- 'microsoft/\w+'
86+
- 'mistralai/\w+'
87+
- 'MLP-KTLim/\w+'
88+
- 'moonshotai/\w+'
89+
- 'naver-hyperclovax/\w+'
90+
- 'NousResearch/\w+'
91+
- 'nvidia/\w+'
92+
- 'openai-community/\w+'
93+
- 'openai/\w+'
94+
- 'openchat/\w+'
95+
- 'petals-team/\w+'
96+
- 'Qwen/\w+'
97+
- 'scb10x/\w+'
98+
- 'state-spaces/\w+'
99+
- 'teknium/\w+'
100+
- 'TheBloke/\w+'
101+
- 'TinyLlama/\w+'
102+
- 'unsloth/\w+'
103+
- 'Vikhrmodels/\w+'

0 commit comments

Comments
 (0)