[CodeStyle][Typos] ✏️ Typos 工具引入 (original) (raw)

Description

背景 (Background)

为了进一步提升 PaddlePaddle 官方文档的专业性和准确性，我们计划引入自动化拼写检查工具 typos。文档中的拼写错误会影响用户的阅读体验，甚至可能导致对技术细节的误解。引入自动化检查工具可以在代码合并前发现并修复这些问题，是保障文档质量的有效手段。

对齐主仓库实践 (Alignment with Main Repository)

typos 工具已经在 Paddle 主仓库中成功引入并得到了良好实践，有效保障了代码注释和文档字符串的质量。这证明了该工具的价值和可行性。
相关的实践和讨论可以参考下面几个 issue：

在 docs 仓库中引入 typos，是我们将代码质量保障的最佳实践扩展到文档生态、保持项目整体一致性的重要一步。

任务目标 (Task Goals)

引入配置文件：在 docs 仓库根目录添加 typos 的配置文件 (_typos.toml)。需要根据文档的特性和常用术语，定制化词典，避免误报。
集成至 pre-commit 和 CI 中：确保所有新的 Pull Request 在合并前都会经过拼写检查，并且本地 commit 的时候就可发现 typo。
修复存量问题：在引入配置文件时，会给所有认为是 typo 单词都加入定制化词典，我们需要确认是否为 typo，对于 typo 我们需要手动修改它们

任务列表

🎉 A-List

任务 ID 正确拼写 错误拼写 认领人 Github id PR 链接
✅A-1 Accuracy, Actuary Accuray ✅@Ricardo-shuo-liu #7600
✅A-2 Advantages Adventages ✅@Ricardo-shuo-liu #7595
✅A-3 Architecture Archetecture ✅@Ricardo-shuo-liu #7595
✅A-4 Asynchronous Asynchoronous ✅@Ricardo-shuo-liu #7595
✅A-5 Attribute Attrbute , Attribtue ✅@Ricardo-shuo-liu #7595
✅A-6 acceptance accpetance ✅@akgamerz790 #7601
✅A-7 according accordding ✅@akgamerz790 #7601
✅A-8 accuracy accracy ✅@ooooo-create #7545
✅A-9 acoustic accoustic ✅@ooooo-create #7602
✅A-10 actual acutal ✅@ooooo-create #7545
✅A-11 approach apporach ✅@ooooo-create #7545
✅A-12 approaches apporaches ✅@ooooo-create #7545
✅A-13 arguments arguements , arguemnts ✅@ooooo-create #7545
✅A-14 assign assgin ✅@ooooo-create #7545
✅A-15 assignment assginment ✅@ooooo-create #7545
✅A-16 auxiliary auxilary ✅@ooooo-create #7545
✅A-17 available avaiable ✅@ooooo-create #7545

🎉 B-List

任务 ID 正确拼写 错误拼写 认领人 Github id PR 链接
✅B-1 Boundary Bounary ✅@Liyulingyue #7559
✅B-2 basic baisc , basci ✅@Liyulingyue #7559
✅B-3 because beacuse ✅@Liyulingyue #7559
✅B-4 benchmark bechmark , benckmark ✅@Liyulingyue #7559
✅B-5 broadcast boradcast , brodcast ✅@Liyulingyue #7559

🎉 C-List

任务 ID 正确拼写 错误拼写 认领人 Github id PR 链接
✅C-1 Classification Classfication ✅@Ricardo-shuo-liu #7573
✅C-2 Comparison Comparision ✅@Ricardo-shuo-liu #7573
✅C-3 Contracting, Constructing Contructing ✅@Ricardo-shuo-liu #7573
✅C-4 calculate caculate ✅@Ricardo-shuo-liu #7573
✅C-5 chosen choosen ✅@Ricardo-shuo-liu #7573
✅C-6 classification classfication ✅@Ricardo-shuo-liu #7610
✅C-7 classify classfy ✅@Ricardo-shuo-liu #7610
✅C-8 clipping cliping ✅@Ricardo-shuo-liu #7595
✅C-9 columns colunms ✅@Ricardo-shuo-liu #7595
✅C-10 commit commmit ✅@xxiu1 #7586
✅C-11 compile, complice, complied complie ✅@xxiu1 #7586
✅C-12 conditional condtional ✅@xxiu1 #7586
✅C-13 conjunction conjuction ✅@xxiu1 #7586
✅C-14 construct contruct ✅@xxiu1 #7586
✅C-15 constructed contructed ✅@xxiu1 #7586
✅C-16 construction contruction ✅@Ricardo-shuo-liu #7595
✅C-17 containing containg ✅@Ricardo-shuo-liu #7595
✅C-18 contains cantains ✅@Ricardo-shuo-liu #7595
✅C-19 context contxt ✅@Ricardo-shuo-liu #7607
✅C-20 convenience convinience ✅@Ricardo-shuo-liu #7607
✅C-21 conversion convertion ✅@Ricardo-shuo-liu #7607
✅C-22 corresponding correponding , corresonding , correspoinding ✅@Ricardo-shuo-liu #7607
✅C-23 could, should, sold sould ✅@Ricardo-shuo-liu #7607
✅C-24 creates creats ✅@Ricardo-shuo-liu #7610
✅C-25 creation creatation ✅@Ricardo-shuo-liu #7610
✅C-26 cross, course corss ✅@Ricardo-shuo-liu #7610

🎉 D-List

任务 ID 正确拼写 错误拼写 认领人 Github id PR 链接
✅D-1 DECLARE DELCARE ✅@dai-junjie #7562
✅D-2 Dataset Dateset ✅@dai-junjie #7562
✅D-3 Description Discription ✅@dai-junjie #7562
✅D-4 Direct Driect ✅@dai-junjie #7562
✅D-5 Distributed Distrbuted ✅@dai-junjie #7562
✅D-6 data datas ✅@Ricardo-shuo-liu #7612
✅D-7 decoder deocder ✅@Ricardo-shuo-liu #7612
✅D-8 default dafault ✅@Ricardo-shuo-liu #7612
✅D-9 describe decribe ✅@Ricardo-shuo-liu #7612
✅D-10 describes decribes ✅@Ricardo-shuo-liu #7612
✅D-11 design desgin ✅@Ricardo-shuo-liu #7614
✅D-12 design, designing desigin ✅@Ricardo-shuo-liu #7614
✅D-13 designated desginated ✅@Ricardo-shuo-liu #7614
✅D-14 determined determinated ✅@Ricardo-shuo-liu #7614
✅D-15 difficult diffcult ✅@Ricardo-shuo-liu #7614
✅D-16 dimension dimention ✅@Ricardo-shuo-liu #7618
✅D-17 dimensions dimentions ✅@Ricardo-shuo-liu #7618
✅D-18 directories dirrectories ✅@Ricardo-shuo-liu #7618
✅D-19 discussion disucssion ✅@Ricardo-shuo-liu #7618

🎉 E-List

任务 ID 正确拼写 错误拼写 认领人 Github id PR 链接
✅E-1 Embedding Embeddding , Embeding ✅@Echo-Nie #7608
✅E-2 English Engish ✅@Echo-Nie #7608
✅E-3 edge egde ✅@Echo-Nie #7608
✅E-4 environment enviornment ✅@Echo-Nie #7608
✅E-5 errors erros ✅@Echo-Nie #7608
✅E-6 evaluate evalute ✅@Echo-Nie #7608
✅E-7 example exmaple ✅@Echo-Nie #7608
✅E-8 examples exampels ✅@Echo-Nie #7608
✅E-9 exclusive exlusive ✅@Echo-Nie #7608
✅E-10 execution, ejection, election, exertion exection ✅@Echo-Nie #7608
✅E-11 exists, exist exsits ✅@Echo-Nie #7608

🎉 F-List

任务 ID 正确拼写 错误拼写 认领人 Github id PR 链接
✅F-1 False Fasle ✅@dai-junjie #7562
✅F-2 False, Flake, Flame, Flare, Flash, Flask Flase ✅@dai-junjie #7562
✅F-3 fed feeded ✅@wanglezz #7619
✅F-4 filter, liter ilter ✅@wanglezz #7619
✅F-5 filters fliters ✅@wanglezz #7619
✅F-6 float flaot ✅@wanglezz #7619
✅F-7 following follwing ✅@wanglezz #7619
✅F-8 formatted formated ✅@wanglezz #7619
✅F-9 formatter formater ✅@wanglezz #7619
✅F-10 forward forword , foward ✅@wanglezz #7619
✅F-11 function funtion ✅@wanglezz #7619
✅F-12 functional functinal ✅@wanglezz #7619
✅F-13 fundamental fundemental ✅@wanglezz #7619

🎉 G-List

任务 ID 正确拼写 错误拼写 认领人 Github id PR 链接
✅G-1 Generator, Generated, Generates, Generate Generater ✅@ooooo-create #7579
✅G-2 Global Gloabal ✅@ooooo-create #7579
✅G-3 generally generaly ✅@ooooo-create #7579
✅G-4 global gloabl ✅@ooooo-create #7579
✅G-5 guard gard ✅@ooooo-create #7579

🎉 H-List

任务 ID 正确拼写 错误拼写 认领人 Github id PR 链接
✅H-1 height, high heigh ✅@ooooo-create #7579

🎉 I-List

任务 ID 正确拼写 错误拼写 认领人 Github id PR 链接
✅I-1 Improvement Imporvement ✅@ooooo-create #7579
✅I-2 Interface Interfce ✅@ooooo-create #7579
✅I-3 identical indentical ✅@ooooo-create #7579
✅I-4 ignore ingore ✅@ooooo-create #7579
✅I-5 image imge ✅@ooooo-create #7579
✅I-6 implemented implememted ✅@ooooo-create #7579
✅I-7 index indx ✅@ooooo-create #7579
✅I-8 indices indeces , indicies ✅@ooooo-create #7579
✅I-9 inferred infered ✅@ooooo-create #7579
✅I-10 info, inform infor ✅@liangqi520 #7620
✅I-11 initializers intializers ✅@liangqi520 #7620
✅I-12 input intput ✅@liangqi520 #7620
✅I-13 insert instert ✅@liangqi520 #7620
✅I-14 interchangeable interchangable ✅@liangqi520 #7620
✅I-15 interface inferface ✅@liangqi520 #7620
✅I-16 intrinsics instrinsics ✅@liangqi520 #7620

🎉 K-List

任务 ID 正确拼写 错误拼写 认领人 Github id PR 链接
✅K-1 Kernel Kernal ✅@ooooo-create #7579

🎉 L-List

任务 ID 正确拼写 错误拼写 认领人 Github id PR 链接
✅L-1 Learning Learing ✅@Ricardo-shuo-liu✅@ooooo-create #7633#7625
✅L-2 label, ladle, labile, able lable ✅@Ricardo-shuo-liu #7625
✅L-3 learn leran ✅@Ricardo-shuo-liu #7625
✅L-4 learning learing ✅@Ricardo-shuo-liu #7625
✅L-5 length legth , lenth ✅@Ricardo-shuo-liu #7625
✅L-6 lengths lengthes ✅@Qkd004 #7616
✅L-7 library libary 🙋@Qkd004✅@ooooo-create #7633
✅L-8 likely likey ✅@Qkd004 #7616

🎉 M-List

任务 ID 正确拼写 错误拼写 认领人 Github id PR 链接
✅M-1 Mobile Moible ✅@dune0310421 #7627
✅M-2 maintained mantained ✅@dune0310421 #7627
✅M-3 matrix, matrices, metrics matrics ✅@ooooo-create #7633
✅M-4 mechanism mechnism ✅@dune0310421 #7627
✅M-5 memory memeory , memroy ✅@dune0310421 #7627
✅M-6 message messege ✅@dune0310421 #7627
✅M-7 metaphor metaphore ✅@dune0310421 #7627
✅M-8 metrics, matrices metrices ✅@ooooo-create #7633
✅M-9 module mdule ✅@dune0310421 #7627
✅M-10 multiply muliply ✅@dune0310421 #7627
✅M-11 multiplying mulitplying ✅@dune0310421 #7627
✅M-12 mutable mutbale ✅@ooooo-create #7633

🎉 N-List

任务 ID 正确拼写 错误拼写 认领人 Github id PR 链接
✅N-1 Nirvana Nervana ✅@dakelong #7574
✅N-2 Numeric Numberic ✅@dakelong #7574
✅N-3 necessary nessesary ✅@dakelong #7574
✅N-4 needed neeeded ✅@dakelong #7574
✅N-5 numeric numberic ✅@dakelong #7574

🎉 O-List

任务 ID 正确拼写 错误拼写 认领人 Github id PR 链接
✅O-1 Operation Operaton ✅@Echo-Nie #7634
✅O-2 Optimizer Optimzier ✅@Echo-Nie #7634
✅O-3 Optimizing Optimizaing ✅@Echo-Nie #7634
✅O-4 occurrence occurence ✅@Echo-Nie #7634
✅O-5 operator opeartor ✅@Echo-Nie #7634
✅O-6 operators opeartors ✅@Echo-Nie #7634
✅O-7 operators, operates operaters ✅@Echo-Nie #7634
✅O-8 optimization optmization ✅@Echo-Nie #7634
✅O-9 output outpu ✅@Echo-Nie #7634
✅O-10 output, outputs outpus ✅@Echo-Nie #7634
✅O-11 overrode, overridden overrided ✅@Echo-Nie #7634
✅O-12 overwritten, overwrote overwrited ✅@Echo-Nie #7634

🎉 P-List

任务 ID 正确拼写 错误拼写 认领人 Github id PR 链接
✅P-1 Parallel Prallel ✅@Bowie375 #7582
✅P-2 Parameter Paremeter ✅@Bowie375 #7582
✅P-3 Pipeline Pipline ✅@Bowie375 #7582
✅P-4 Program Porgram ✅@Bowie375 #7582
✅P-5 Propagation Propegation , Propogation ✅@Bowie375 #7582
✅P-6 Protocol Protocal ✅@Bowie375 #7582
✅P-7 Python Pyhton ✅@Bowie375 #7582
✅P-8 parameters parammeters ✅@Bowie375 #7582
✅P-9 place, palace palce ✅@Bowie375 #7582
✅P-10 pointer poniter ✅@Bowie375 #7582
✅P-11 process porcess ✅@Ricardo-shuo-liu #7614
✅P-12 processor processer ✅@Ricardo-shuo-liu #7614
✅P-13 prompt, promote promot ✅@Bowie375 #7582
✅P-14 propagation propegation ✅@Bowie375 #7582
✅P-15 provided provicded ✅@Bowie375 #7582

🎉 R-List

任务 ID 正确拼写 错误拼写 认领人 Github id PR 链接
✅R-1 REGISTER REGISTE ✅@enkilee #7589
✅R-2 Request Reuqest ✅@enkilee #7589
✅R-3 Review Reivew ✅@enkilee #7589
✅R-4 received recevied ✅@enkilee #7589
✅R-5 recommend recomment ✅@enkilee #7589
✅R-6 registered, registers registerd ✅@enkilee #7589
✅R-7 registering registring ✅@enkilee #7589
✅R-8 release relase ✅@enkilee #7589
✅R-9 requirements requirments ✅@enkilee #7589
✅R-10 result resut ✅@enkilee #7589
✅R-11 results resuts ✅@enkilee #7589
✅R-12 review reivew ✅@enkilee #7589

S-List

任务 ID 正确拼写 错误拼写 认领人 Github id PR 链接
✅S-1 Screenshot Creenshot ✅@LiaoYFBH #7621
✅S-2 Segment Setment ✅@Echo-Nie #7634
✅S-3 Similarly Similarily ✅@LiaoYFBH #7621
✅S-4 Simple, Smile, Simile Simle ✅@Echo-Nie #7634
✅S-5 Solver Sovler ✅@Echo-Nie #7634
✅S-6 Succeeded, Success, Successful Successed ✅@LiaoYFBH #7621
✅S-7 sample, same samle ✅@Echo-Nie #7634
✅S-8 satisfies satifies ✅@LiaoYFBH #7621
✅S-9 scale, sale, sable sacle ✅@LiaoYFBH #7621
✅S-10 scenarios secenarios ✅@sphcode #7648
✅S-11 schedule schedual ✅@sphcode #7648
✅S-12 semantic sematic ✅@sphcode #7648
✅S-13 separated sperated ✅@sphcode #7648
✅S-14 separator seperator ✅@sphcode #7648
✅S-15 set ser , setted ✅@sphcode #7653
✅S-16 should shoule ✅@sphcode #7653
✅S-17 similarly similary ✅@sphcode #7653
✅S-18 simpler simplier ✅@sphcode #7653
✅S-19 size szie ✅@sphcode #7653
✅S-20 skipped, skyped skiped ✅@Qkd004 #7647
🙋S-21 software softwares 🙋@Qkd004
✅S-22 special specail ✅@Qkd004 #7647
🙋S-23 split splited , splitted 🙋@Qkd004
✅S-24 strategy stradegy ✅@Qkd004 #7647
✅S-25 string stirng ✅@Qkd004 #7647
✅S-26 subtract subract ✅@Qkd004 #7647
✅S-27 success sucess ✅@Qkd004 #7647
✅S-28 successor sucessor ✅@Qkd004 #7647
✅S-29 successors sucessors ✅@Qkd004 #7647

🎉 T-List

任务 ID 正确拼写 错误拼写 认领人 Github id PR 链接
✅T-1 Tensor Tenosr ✅@Ricardo-shuo-liu #7577
✅T-2 The Tthe ✅@Ricardo-shuo-liu #7577
✅T-3 Training Traning ✅@Ricardo-shuo-liu #7577
✅T-4 Transformed Transfomed ✅@Ricardo-shuo-liu #7577
✅T-5 Transformer Tansformer ✅@Ricardo-shuo-liu #7577
✅T-6 True, Pure Ture ✅@Ricardo-shuo-liu #7583
✅T-7 target traget ✅@Ricardo-shuo-liu #7583
✅T-8 temporary tempory ✅@Ricardo-shuo-liu #7583
✅T-9 tensor tenosr ✅@Ricardo-shuo-liu #7583
✅T-10 their thier ✅@Ricardo-shuo-liu #7583
✅T-11 threshold treshold ✅@Ricardo-shuo-liu #7588
✅T-12 train, trial trian ✅@Ricardo-shuo-liu #7588
✅T-13 training traing , trainning , traning ✅@Ricardo-shuo-liu #7588
✅T-14 transferred transfered ✅@Ricardo-shuo-liu #7588
✅T-15 transformed trasformed ✅@Ricardo-shuo-liu #7588

🎉 U-List

任务 ID 正确拼写 错误拼写 认领人 Github id PR 链接
✅U-1 Usage Useage ✅@fsylmxx #7563
✅U-2 unique unqiue ✅@fsylmxx #7563
✅U-3 unsupported unsupport ✅@fsylmxx #7563
✅U-4 until, utils utill ✅@fsylmxx #7563
✅U-5 update updte ✅@fsylmxx #7563

🎉 V-List

任务 ID 正确拼写 错误拼写 认领人 Github id PR 链接
✅V-1 Variable Varialble , Varible ✅@tjujingzong #7561
✅V-2 Variant Varient ✅@tjujingzong #7561
✅V-3 variable varibale ✅@tjujingzong #7561
✅V-4 variables varialbes , varibales ✅@tjujingzong #7561
✅V-5 variance varience ✅@tjujingzong #7561
✅V-6 variant varient ✅@tjujingzong #7561
✅V-7 visiting, listing visting ✅@tjujingzong #7561

🎉 W-List

任务 ID 正确拼写 错误拼写 认领人 Github id PR 链接
✅W-1 Weather, Whether Wether ✅@enkilee #7570
✅W-2 warped, wrapped warpped ✅@enkilee #7570
✅W-3 weather, whether wether ✅@enkilee #7570
✅W-4 with wiht ✅@enkilee #7570
✅W-5 working workign ✅@enkilee #7570
✅W-6 wrapper wraper ✅@enkilee #7570
✅W-7 write wirte ✅@enkilee #7570
✅W-8 writer, written writter ✅@enkilee #7570

任务认领方式

⭐️ 提交 PR 模版 ⭐️：

[CodeStyle][Typos][A-1] Fix typo(`wiht`)

或者多个任务：

[CodeStyle][Typos][A-1,A-2,A-3] Fix typo(`wiht`,...)
[CodeStyle][Typos][A-[1-3]] Fix typo(`wiht`,...)

⭐️ 认领方式 ⭐️：

请大家以 comment 的形式认领任务，如：

提交 PR 模版

PR Category

User Experience

Description

修复如下 typo 问题：

@ooooo-create

状态介绍：
✅：已经完全迁移，所有单测都 OK！
🙋: 报名
🟢：审核完毕待合入，合入之后完成！
🔵：可认领！
🟡：当前阶段不需要人力继续跟进，下阶段推进
🚧：迁移中，单测还没有过，还没有审核完。

大致正常流程为:
🔵 -> 🙋 -> 🚧 -> 🟢 -> ✅

异常流程为:
🔵 -> 🙋 -> 🚧 -> 🟡

看板信息

任务数量 🔵 可认领 🚧 迁移中 🟢 待合入 ✅ 完成 🟡 下阶段推进 🏁 完成率
242 0 0 0 240 0 99.2%

排名不分先后 @Ricardo-shuo-liu(61) @akgamerz790(2) @ooooo-create(31) @Liyulingyue(5) @xxiu1(6) @dai-junjie(7) @Echo-Nie(27) @wanglezz(11) @liangqi520(7) @Qkd004(10) @dune0310421(9) @dakelong(5) @Bowie375(13) @enkilee(20) @LiaoYFBH(5) @sphcode(10) @fsylmxx(5) @tjujingzong(7)