aigroup-workflow 2.2.0 → 2.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (645) hide show
  1. package/.claude/commands/fix-build.md +10 -5
  2. package/.claude/commands/init-project.md +13 -8
  3. package/.claude/commands/plan.md +15 -8
  4. package/.claude/commands/review.md +12 -6
  5. package/.claude/commands/tdd.md +11 -5
  6. package/.claude/commands/workflow-start.md +20 -11
  7. package/.claude/settings.json +28 -0
  8. package/.codex/agents/architect.toml +207 -0
  9. package/.codex/agents/build-error-resolver.toml +110 -0
  10. package/.codex/agents/code-reviewer.toml +233 -0
  11. package/.codex/agents/doc-updater.toml +103 -0
  12. package/.codex/agents/e2e-runner.toml +103 -0
  13. package/.codex/agents/get-current-datetime.toml +23 -0
  14. package/.codex/agents/init-architect.toml +181 -0
  15. package/.codex/agents/planner.toml +208 -0
  16. package/.codex/agents/refactor-cleaner.toml +81 -0
  17. package/.codex/agents/rust-reviewer.toml +90 -0
  18. package/.codex/agents/security-reviewer.toml +104 -0
  19. package/.codex/agents/tdd-guide.toml +87 -0
  20. package/AGENTS.md +2 -2
  21. package/CLAUDE.md +23 -1
  22. package/LICENSE +20 -20
  23. package/README.md +333 -333
  24. package/agents/a11y-architect.md +141 -141
  25. package/agents/architect.md +211 -211
  26. package/agents/build-error-resolver.md +114 -114
  27. package/agents/chief-of-staff.md +151 -151
  28. package/agents/code-architect.md +71 -71
  29. package/agents/code-explorer.md +69 -69
  30. package/agents/code-reviewer.md +237 -237
  31. package/agents/code-simplifier.md +47 -47
  32. package/agents/comment-analyzer.md +45 -45
  33. package/agents/conversation-analyzer.md +52 -52
  34. package/agents/cpp-build-resolver.md +90 -90
  35. package/agents/cpp-reviewer.md +72 -72
  36. package/agents/csharp-reviewer.md +101 -101
  37. package/agents/dart-build-resolver.md +201 -201
  38. package/agents/database-reviewer.md +91 -91
  39. package/agents/doc-updater.md +107 -107
  40. package/agents/docs-lookup.md +68 -68
  41. package/agents/e2e-runner.md +107 -107
  42. package/agents/flutter-reviewer.md +243 -243
  43. package/agents/gan-evaluator.md +209 -209
  44. package/agents/gan-generator.md +131 -131
  45. package/agents/gan-planner.md +99 -99
  46. package/agents/get-current-datetime.md +26 -26
  47. package/agents/go-build-resolver.md +94 -94
  48. package/agents/go-reviewer.md +76 -76
  49. package/agents/harness-optimizer.md +35 -35
  50. package/agents/healthcare-reviewer.md +83 -83
  51. package/agents/java-build-resolver.md +153 -153
  52. package/agents/java-reviewer.md +92 -92
  53. package/agents/kotlin-build-resolver.md +118 -118
  54. package/agents/kotlin-reviewer.md +159 -159
  55. package/agents/loop-operator.md +36 -36
  56. package/agents/opensource-forker.md +198 -198
  57. package/agents/opensource-packager.md +249 -249
  58. package/agents/opensource-sanitizer.md +188 -188
  59. package/agents/performance-optimizer.md +446 -446
  60. package/agents/planner.md +212 -212
  61. package/agents/pr-test-analyzer.md +45 -45
  62. package/agents/python-reviewer.md +98 -98
  63. package/agents/pytorch-build-resolver.md +120 -120
  64. package/agents/refactor-cleaner.md +85 -85
  65. package/agents/rust-build-resolver.md +148 -148
  66. package/agents/rust-reviewer.md +94 -94
  67. package/agents/security-reviewer.md +108 -108
  68. package/agents/seo-specialist.md +59 -59
  69. package/agents/silent-failure-hunter.md +50 -50
  70. package/agents/tdd-guide.md +91 -91
  71. package/agents/type-design-analyzer.md +41 -41
  72. package/agents/typescript-reviewer.md +112 -112
  73. package/cli/commands/update.mjs +1 -1
  74. package/cli/utils/scaffold.mjs +53 -0
  75. package/docs/rules/agents.md +166 -50
  76. package/docs/rules/cpp/coding-style.md +44 -44
  77. package/docs/rules/cpp/hooks.md +39 -39
  78. package/docs/rules/cpp/patterns.md +51 -51
  79. package/docs/rules/cpp/security.md +51 -51
  80. package/docs/rules/cpp/testing.md +44 -44
  81. package/docs/rules/csharp/coding-style.md +72 -72
  82. package/docs/rules/csharp/hooks.md +25 -25
  83. package/docs/rules/csharp/patterns.md +50 -50
  84. package/docs/rules/csharp/security.md +58 -58
  85. package/docs/rules/csharp/testing.md +46 -46
  86. package/docs/rules/dart/coding-style.md +159 -159
  87. package/docs/rules/dart/hooks.md +66 -66
  88. package/docs/rules/dart/patterns.md +261 -261
  89. package/docs/rules/dart/security.md +135 -135
  90. package/docs/rules/dart/testing.md +215 -215
  91. package/docs/rules/golang/coding-style.md +32 -32
  92. package/docs/rules/golang/hooks.md +17 -17
  93. package/docs/rules/golang/patterns.md +45 -45
  94. package/docs/rules/golang/security.md +34 -34
  95. package/docs/rules/golang/testing.md +31 -31
  96. package/docs/rules/java/coding-style.md +114 -114
  97. package/docs/rules/java/hooks.md +18 -18
  98. package/docs/rules/java/patterns.md +146 -146
  99. package/docs/rules/java/security.md +100 -100
  100. package/docs/rules/java/testing.md +131 -131
  101. package/docs/rules/kotlin/coding-style.md +86 -86
  102. package/docs/rules/kotlin/hooks.md +17 -17
  103. package/docs/rules/kotlin/patterns.md +146 -146
  104. package/docs/rules/kotlin/security.md +82 -82
  105. package/docs/rules/kotlin/testing.md +128 -128
  106. package/docs/rules/perl/coding-style.md +46 -46
  107. package/docs/rules/perl/hooks.md +22 -22
  108. package/docs/rules/perl/patterns.md +76 -76
  109. package/docs/rules/perl/security.md +69 -69
  110. package/docs/rules/perl/testing.md +54 -54
  111. package/docs/rules/php/coding-style.md +40 -40
  112. package/docs/rules/php/hooks.md +24 -24
  113. package/docs/rules/php/patterns.md +33 -33
  114. package/docs/rules/php/security.md +37 -37
  115. package/docs/rules/php/testing.md +39 -39
  116. package/docs/rules/python/coding-style.md +42 -42
  117. package/docs/rules/python/hooks.md +19 -19
  118. package/docs/rules/python/patterns.md +39 -39
  119. package/docs/rules/python/security.md +30 -30
  120. package/docs/rules/python/testing.md +38 -38
  121. package/docs/rules/rust/coding-style.md +151 -151
  122. package/docs/rules/rust/hooks.md +16 -16
  123. package/docs/rules/rust/patterns.md +168 -168
  124. package/docs/rules/rust/security.md +141 -141
  125. package/docs/rules/rust/testing.md +154 -154
  126. package/docs/rules/swift/coding-style.md +47 -47
  127. package/docs/rules/swift/hooks.md +20 -20
  128. package/docs/rules/swift/patterns.md +66 -66
  129. package/docs/rules/swift/security.md +33 -33
  130. package/docs/rules/swift/testing.md +45 -45
  131. package/docs/rules/typescript/coding-style.md +199 -199
  132. package/docs/rules/typescript/hooks.md +22 -22
  133. package/docs/rules/typescript/patterns.md +52 -52
  134. package/docs/rules/typescript/security.md +28 -28
  135. package/docs/rules/typescript/testing.md +18 -18
  136. package/docs/rules/web/coding-style.md +96 -96
  137. package/docs/rules/web/design-quality.md +62 -62
  138. package/docs/rules/web/hooks.md +120 -120
  139. package/docs/rules/web/patterns.md +79 -79
  140. package/docs/rules/web/performance.md +64 -64
  141. package/docs/rules/web/security.md +57 -57
  142. package/docs/rules/web/testing.md +55 -55
  143. package/docs/templates/README.md +36 -36
  144. package/docs/templates/ai-project-final.md +124 -124
  145. package/docs/templates/ai-project.md +105 -105
  146. package/docs/templates/api.md +157 -157
  147. package/docs/templates/bug.md +62 -62
  148. package/docs/templates/code-review.md +87 -87
  149. package/docs/templates/generic.md +116 -116
  150. package/docs/templates/implementation-plan.md +1 -1
  151. package/docs/templates/meeting.md +68 -68
  152. package/docs/templates/prd.md +98 -98
  153. package/docs/templates/ui.md +134 -134
  154. package/docs/workflow-pipeline.md +11 -10
  155. package/package.json +40 -39
  156. package/scripts/hooks/checks/orchestration-artifacts.cjs +28 -23
  157. package/scripts/hooks/checks/workflow-state.cjs +4 -5
  158. package/scripts/orchestration/lib/orchestrator.cjs +344 -117
  159. package/scripts/orchestration/lib/validate.cjs +145 -0
  160. package/scripts/orchestration/session.cjs +88 -44
  161. package/skills/SUPERPOWERS-LICENSE +21 -21
  162. package/skills/ai-ml/fine-tuning-expert/SKILL.md +162 -162
  163. package/skills/ai-ml/fine-tuning-expert/references/dataset-preparation.md +540 -540
  164. package/skills/ai-ml/fine-tuning-expert/references/deployment-optimization.md +673 -673
  165. package/skills/ai-ml/fine-tuning-expert/references/evaluation-metrics.md +597 -597
  166. package/skills/ai-ml/fine-tuning-expert/references/hyperparameter-tuning.md +565 -565
  167. package/skills/ai-ml/fine-tuning-expert/references/lora-peft.md +347 -347
  168. package/skills/ai-ml/ml-pipeline/SKILL.md +159 -159
  169. package/skills/ai-ml/ml-pipeline/references/experiment-tracking.md +833 -833
  170. package/skills/ai-ml/ml-pipeline/references/feature-engineering.md +631 -631
  171. package/skills/ai-ml/ml-pipeline/references/model-validation.md +978 -978
  172. package/skills/ai-ml/ml-pipeline/references/pipeline-orchestration.md +907 -907
  173. package/skills/ai-ml/ml-pipeline/references/training-pipelines.md +782 -782
  174. package/skills/ai-ml/rag-architect/SKILL.md +194 -194
  175. package/skills/ai-ml/rag-architect/references/chunking-strategies.md +878 -878
  176. package/skills/ai-ml/rag-architect/references/embedding-models.md +561 -561
  177. package/skills/ai-ml/rag-architect/references/rag-evaluation.md +833 -833
  178. package/skills/ai-ml/rag-architect/references/retrieval-optimization.md +795 -795
  179. package/skills/ai-ml/rag-architect/references/vector-databases.md +589 -589
  180. package/skills/ai-ml/spark-engineer/SKILL.md +148 -148
  181. package/skills/ai-ml/spark-engineer/references/partitioning-caching.md +543 -543
  182. package/skills/ai-ml/spark-engineer/references/performance-tuning.md +544 -544
  183. package/skills/ai-ml/spark-engineer/references/rdd-operations.md +599 -599
  184. package/skills/ai-ml/spark-engineer/references/spark-sql-dataframes.md +474 -474
  185. package/skills/ai-ml/spark-engineer/references/streaming-patterns.md +786 -786
  186. package/skills/backend/api-designer/SKILL.md +217 -217
  187. package/skills/backend/api-designer/references/error-handling.md +541 -541
  188. package/skills/backend/api-designer/references/openapi.md +824 -824
  189. package/skills/backend/api-designer/references/pagination.md +494 -494
  190. package/skills/backend/api-designer/references/rest-patterns.md +335 -335
  191. package/skills/backend/api-designer/references/versioning.md +391 -391
  192. package/skills/backend/architecture-designer/SKILL.md +117 -117
  193. package/skills/backend/architecture-designer/references/adr-template.md +116 -116
  194. package/skills/backend/architecture-designer/references/architecture-patterns.md +111 -111
  195. package/skills/backend/architecture-designer/references/database-selection.md +102 -102
  196. package/skills/backend/architecture-designer/references/nfr-checklist.md +112 -112
  197. package/skills/backend/architecture-designer/references/system-design.md +100 -100
  198. package/skills/backend/code-documenter/SKILL.md +147 -147
  199. package/skills/backend/code-documenter/references/api-docs-fastapi-django.md +166 -166
  200. package/skills/backend/code-documenter/references/api-docs-nestjs-express.md +220 -220
  201. package/skills/backend/code-documenter/references/coverage-reports.md +125 -125
  202. package/skills/backend/code-documenter/references/documentation-systems.md +333 -333
  203. package/skills/backend/code-documenter/references/interactive-api-docs.md +531 -531
  204. package/skills/backend/code-documenter/references/python-docstrings.md +121 -121
  205. package/skills/backend/code-documenter/references/typescript-jsdoc.md +145 -145
  206. package/skills/backend/code-documenter/references/user-guides-tutorials.md +530 -530
  207. package/skills/backend/debugging-wizard/SKILL.md +105 -105
  208. package/skills/backend/debugging-wizard/references/common-patterns.md +132 -132
  209. package/skills/backend/debugging-wizard/references/debugging-tools.md +140 -140
  210. package/skills/backend/debugging-wizard/references/quick-fixes.md +177 -177
  211. package/skills/backend/debugging-wizard/references/strategies.md +142 -142
  212. package/skills/backend/debugging-wizard/references/systematic-debugging.md +367 -367
  213. package/skills/backend/feature-forge/SKILL.md +98 -98
  214. package/skills/backend/feature-forge/references/acceptance-criteria.md +104 -104
  215. package/skills/backend/feature-forge/references/ears-syntax.md +99 -99
  216. package/skills/backend/feature-forge/references/interview-questions.md +150 -150
  217. package/skills/backend/feature-forge/references/pre-discovery-subagents.md +54 -54
  218. package/skills/backend/feature-forge/references/specification-template.md +103 -103
  219. package/skills/backend/fullstack-guardian/SKILL.md +105 -105
  220. package/skills/backend/fullstack-guardian/references/api-design-standards.md +307 -307
  221. package/skills/backend/fullstack-guardian/references/architecture-decisions.md +350 -350
  222. package/skills/backend/fullstack-guardian/references/backend-patterns.md +237 -237
  223. package/skills/backend/fullstack-guardian/references/common-patterns.md +134 -134
  224. package/skills/backend/fullstack-guardian/references/deliverables-checklist.md +354 -354
  225. package/skills/backend/fullstack-guardian/references/design-template.md +91 -91
  226. package/skills/backend/fullstack-guardian/references/error-handling.md +135 -135
  227. package/skills/backend/fullstack-guardian/references/frontend-patterns.md +340 -340
  228. package/skills/backend/fullstack-guardian/references/integration-patterns.md +333 -333
  229. package/skills/backend/fullstack-guardian/references/security-checklist.md +106 -106
  230. package/skills/backend/graphql-architect/SKILL.md +146 -146
  231. package/skills/backend/graphql-architect/references/federation.md +418 -418
  232. package/skills/backend/graphql-architect/references/migration-from-rest.md +1141 -1141
  233. package/skills/backend/graphql-architect/references/resolvers.md +425 -425
  234. package/skills/backend/graphql-architect/references/schema-design.md +393 -393
  235. package/skills/backend/graphql-architect/references/security.md +569 -569
  236. package/skills/backend/graphql-architect/references/subscriptions.md +510 -510
  237. package/skills/backend/legacy-modernizer/SKILL.md +137 -137
  238. package/skills/backend/legacy-modernizer/references/legacy-testing.md +381 -381
  239. package/skills/backend/legacy-modernizer/references/migration-strategies.md +423 -423
  240. package/skills/backend/legacy-modernizer/references/refactoring-patterns.md +395 -395
  241. package/skills/backend/legacy-modernizer/references/strangler-fig-pattern.md +281 -281
  242. package/skills/backend/legacy-modernizer/references/system-assessment.md +487 -487
  243. package/skills/backend/microservices-architect/SKILL.md +164 -164
  244. package/skills/backend/microservices-architect/references/communication.md +499 -499
  245. package/skills/backend/microservices-architect/references/data.md +721 -721
  246. package/skills/backend/microservices-architect/references/decomposition.md +344 -344
  247. package/skills/backend/microservices-architect/references/observability.md +805 -805
  248. package/skills/backend/microservices-architect/references/patterns.md +603 -603
  249. package/skills/database/database-optimizer/SKILL.md +147 -147
  250. package/skills/database/database-optimizer/references/index-strategies.md +331 -331
  251. package/skills/database/database-optimizer/references/monitoring-analysis.md +501 -501
  252. package/skills/database/database-optimizer/references/mysql-tuning.md +452 -452
  253. package/skills/database/database-optimizer/references/postgresql-tuning.md +413 -413
  254. package/skills/database/database-optimizer/references/query-optimization.md +251 -251
  255. package/skills/database/postgres-pro/SKILL.md +152 -152
  256. package/skills/database/postgres-pro/references/extensions.md +404 -404
  257. package/skills/database/postgres-pro/references/jsonb.md +321 -321
  258. package/skills/database/postgres-pro/references/maintenance.md +481 -481
  259. package/skills/database/postgres-pro/references/performance.md +265 -265
  260. package/skills/database/postgres-pro/references/replication.md +446 -446
  261. package/skills/database/sql-pro/SKILL.md +129 -129
  262. package/skills/database/sql-pro/references/database-design.md +402 -402
  263. package/skills/database/sql-pro/references/dialect-differences.md +419 -419
  264. package/skills/database/sql-pro/references/optimization.md +384 -384
  265. package/skills/database/sql-pro/references/query-patterns.md +285 -285
  266. package/skills/database/sql-pro/references/window-functions.md +328 -328
  267. package/skills/dotnet/csharp-developer/SKILL.md +125 -125
  268. package/skills/dotnet/csharp-developer/references/aspnet-core.md +394 -394
  269. package/skills/dotnet/csharp-developer/references/blazor.md +553 -553
  270. package/skills/dotnet/csharp-developer/references/entity-framework.md +409 -409
  271. package/skills/dotnet/csharp-developer/references/modern-csharp.md +248 -248
  272. package/skills/dotnet/csharp-developer/references/performance.md +498 -498
  273. package/skills/dotnet/dotnet-core-expert/SKILL.md +138 -138
  274. package/skills/dotnet/dotnet-core-expert/references/authentication.md +546 -546
  275. package/skills/dotnet/dotnet-core-expert/references/clean-architecture.md +455 -455
  276. package/skills/dotnet/dotnet-core-expert/references/cloud-native.md +548 -548
  277. package/skills/dotnet/dotnet-core-expert/references/entity-framework.md +440 -440
  278. package/skills/dotnet/dotnet-core-expert/references/minimal-apis.md +319 -319
  279. package/skills/frontend/angular-architect/SKILL.md +152 -152
  280. package/skills/frontend/angular-architect/references/components.md +297 -297
  281. package/skills/frontend/angular-architect/references/ngrx.md +401 -401
  282. package/skills/frontend/angular-architect/references/routing.md +361 -361
  283. package/skills/frontend/angular-architect/references/rxjs.md +319 -319
  284. package/skills/frontend/angular-architect/references/testing.md +405 -405
  285. package/skills/frontend/design-commands/design.md +91 -91
  286. package/skills/frontend/design-commands/handoff.md +97 -97
  287. package/skills/frontend/design-commands/prototype.md +120 -120
  288. package/skills/frontend/design-commands/spec.md +160 -160
  289. package/skills/frontend/design-commands/style.md +78 -78
  290. package/skills/frontend/flutter-expert/SKILL.md +138 -138
  291. package/skills/frontend/flutter-expert/references/bloc-state.md +259 -259
  292. package/skills/frontend/flutter-expert/references/gorouter-navigation.md +119 -119
  293. package/skills/frontend/flutter-expert/references/performance.md +99 -99
  294. package/skills/frontend/flutter-expert/references/project-structure.md +118 -118
  295. package/skills/frontend/flutter-expert/references/riverpod-state.md +130 -130
  296. package/skills/frontend/flutter-expert/references/widget-patterns.md +123 -123
  297. package/skills/frontend/nextjs-developer/SKILL.md +143 -143
  298. package/skills/frontend/nextjs-developer/references/app-router.md +311 -311
  299. package/skills/frontend/nextjs-developer/references/data-fetching.md +482 -482
  300. package/skills/frontend/nextjs-developer/references/deployment.md +545 -545
  301. package/skills/frontend/nextjs-developer/references/server-actions.md +462 -462
  302. package/skills/frontend/nextjs-developer/references/server-components.md +384 -384
  303. package/skills/frontend/react-expert/SKILL.md +149 -149
  304. package/skills/frontend/react-expert/references/hooks-patterns.md +162 -162
  305. package/skills/frontend/react-expert/references/migration-class-to-modern.md +1119 -1119
  306. package/skills/frontend/react-expert/references/performance.md +168 -168
  307. package/skills/frontend/react-expert/references/react-19-features.md +174 -174
  308. package/skills/frontend/react-expert/references/server-components.md +143 -143
  309. package/skills/frontend/react-expert/references/state-management.md +171 -171
  310. package/skills/frontend/react-expert/references/testing-react.md +174 -174
  311. package/skills/frontend/react-native-expert/SKILL.md +185 -185
  312. package/skills/frontend/react-native-expert/references/expo-router.md +187 -187
  313. package/skills/frontend/react-native-expert/references/list-optimization.md +204 -204
  314. package/skills/frontend/react-native-expert/references/platform-handling.md +188 -188
  315. package/skills/frontend/react-native-expert/references/project-structure.md +171 -171
  316. package/skills/frontend/react-native-expert/references/storage-hooks.md +173 -173
  317. package/skills/frontend/senior-frontend/SKILL.md +477 -477
  318. package/skills/frontend/senior-frontend/references/frontend_best_practices.md +806 -806
  319. package/skills/frontend/senior-frontend/references/nextjs_optimization_guide.md +724 -724
  320. package/skills/frontend/senior-frontend/references/react_patterns.md +746 -746
  321. package/skills/frontend/senior-frontend/scripts/bundle_analyzer.py +407 -407
  322. package/skills/frontend/senior-frontend/scripts/component_generator.py +329 -329
  323. package/skills/frontend/senior-frontend/scripts/frontend_scaffolder.py +1005 -1005
  324. package/skills/frontend/ui-ux-pro-max/SKILL.md +386 -386
  325. package/skills/frontend/ui-ux-pro-max/data/charts.csv +26 -26
  326. package/skills/frontend/ui-ux-pro-max/data/colors.csv +97 -97
  327. package/skills/frontend/ui-ux-pro-max/data/icons.csv +101 -101
  328. package/skills/frontend/ui-ux-pro-max/data/landing.csv +31 -31
  329. package/skills/frontend/ui-ux-pro-max/data/products.csv +96 -96
  330. package/skills/frontend/ui-ux-pro-max/data/react-performance.csv +45 -45
  331. package/skills/frontend/ui-ux-pro-max/data/stacks/astro.csv +54 -54
  332. package/skills/frontend/ui-ux-pro-max/data/stacks/flutter.csv +53 -53
  333. package/skills/frontend/ui-ux-pro-max/data/stacks/html-tailwind.csv +56 -56
  334. package/skills/frontend/ui-ux-pro-max/data/stacks/jetpack-compose.csv +53 -53
  335. package/skills/frontend/ui-ux-pro-max/data/stacks/nextjs.csv +53 -53
  336. package/skills/frontend/ui-ux-pro-max/data/stacks/nuxt-ui.csv +51 -51
  337. package/skills/frontend/ui-ux-pro-max/data/stacks/nuxtjs.csv +59 -59
  338. package/skills/frontend/ui-ux-pro-max/data/stacks/react-native.csv +52 -52
  339. package/skills/frontend/ui-ux-pro-max/data/stacks/react.csv +54 -54
  340. package/skills/frontend/ui-ux-pro-max/data/stacks/shadcn.csv +61 -61
  341. package/skills/frontend/ui-ux-pro-max/data/stacks/svelte.csv +54 -54
  342. package/skills/frontend/ui-ux-pro-max/data/stacks/swiftui.csv +51 -51
  343. package/skills/frontend/ui-ux-pro-max/data/stacks/vue.csv +50 -50
  344. package/skills/frontend/ui-ux-pro-max/data/styles.csv +68 -68
  345. package/skills/frontend/ui-ux-pro-max/data/typography.csv +57 -57
  346. package/skills/frontend/ui-ux-pro-max/data/ui-reasoning.csv +101 -101
  347. package/skills/frontend/ui-ux-pro-max/data/ux-guidelines.csv +99 -99
  348. package/skills/frontend/ui-ux-pro-max/data/web-interface.csv +31 -31
  349. package/skills/frontend/ui-ux-pro-max/scripts/core.py +253 -253
  350. package/skills/frontend/ui-ux-pro-max/scripts/design_system.py +1067 -1067
  351. package/skills/frontend/ui-ux-pro-max/scripts/search.py +114 -114
  352. package/skills/frontend/vue-expert/SKILL.md +98 -98
  353. package/skills/frontend/vue-expert/references/build-tooling.md +480 -480
  354. package/skills/frontend/vue-expert/references/components.md +448 -448
  355. package/skills/frontend/vue-expert/references/composition-api.md +299 -299
  356. package/skills/frontend/vue-expert/references/mobile-hybrid.md +636 -636
  357. package/skills/frontend/vue-expert/references/nuxt.md +669 -669
  358. package/skills/frontend/vue-expert/references/state-management.md +449 -449
  359. package/skills/frontend/vue-expert/references/typescript.md +584 -584
  360. package/skills/frontend/vue-expert-js/SKILL.md +167 -167
  361. package/skills/frontend/vue-expert-js/references/component-architecture.md +219 -219
  362. package/skills/frontend/vue-expert-js/references/composables-patterns.md +183 -183
  363. package/skills/frontend/vue-expert-js/references/jsdoc-typing.md +535 -535
  364. package/skills/frontend/vue-expert-js/references/state-management.md +249 -249
  365. package/skills/frontend/vue-expert-js/references/testing-patterns.md +237 -237
  366. package/skills/go-rust-cpp/cpp-pro/SKILL.md +115 -115
  367. package/skills/go-rust-cpp/cpp-pro/references/build-tooling.md +440 -440
  368. package/skills/go-rust-cpp/cpp-pro/references/concurrency.md +437 -437
  369. package/skills/go-rust-cpp/cpp-pro/references/memory-performance.md +397 -397
  370. package/skills/go-rust-cpp/cpp-pro/references/modern-cpp.md +304 -304
  371. package/skills/go-rust-cpp/cpp-pro/references/templates.md +357 -357
  372. package/skills/go-rust-cpp/golang-pro/SKILL.md +122 -122
  373. package/skills/go-rust-cpp/golang-pro/references/concurrency.md +329 -329
  374. package/skills/go-rust-cpp/golang-pro/references/generics.md +442 -442
  375. package/skills/go-rust-cpp/golang-pro/references/interfaces.md +432 -432
  376. package/skills/go-rust-cpp/golang-pro/references/project-structure.md +477 -477
  377. package/skills/go-rust-cpp/golang-pro/references/testing.md +451 -451
  378. package/skills/go-rust-cpp/rust-engineer/SKILL.md +167 -167
  379. package/skills/go-rust-cpp/rust-engineer/references/async.md +458 -458
  380. package/skills/go-rust-cpp/rust-engineer/references/error-handling.md +334 -334
  381. package/skills/go-rust-cpp/rust-engineer/references/ownership.md +278 -278
  382. package/skills/go-rust-cpp/rust-engineer/references/testing.md +470 -470
  383. package/skills/go-rust-cpp/rust-engineer/references/traits.md +413 -413
  384. package/skills/infra/cli-developer/SKILL.md +113 -113
  385. package/skills/infra/cli-developer/references/design-patterns.md +221 -221
  386. package/skills/infra/cli-developer/references/go-cli.md +540 -540
  387. package/skills/infra/cli-developer/references/node-cli.md +383 -383
  388. package/skills/infra/cli-developer/references/python-cli.md +422 -422
  389. package/skills/infra/cli-developer/references/ux-patterns.md +448 -448
  390. package/skills/infra/cloud-architect/SKILL.md +216 -216
  391. package/skills/infra/cloud-architect/references/aws.md +394 -394
  392. package/skills/infra/cloud-architect/references/azure.md +562 -562
  393. package/skills/infra/cloud-architect/references/cost.md +582 -582
  394. package/skills/infra/cloud-architect/references/gcp.md +633 -633
  395. package/skills/infra/cloud-architect/references/multi-cloud.md +483 -483
  396. package/skills/infra/devops-engineer/SKILL.md +144 -144
  397. package/skills/infra/devops-engineer/references/deployment-strategies.md +241 -241
  398. package/skills/infra/devops-engineer/references/docker-patterns.md +113 -113
  399. package/skills/infra/devops-engineer/references/github-actions.md +139 -139
  400. package/skills/infra/devops-engineer/references/incident-response.md +331 -331
  401. package/skills/infra/devops-engineer/references/kubernetes.md +154 -154
  402. package/skills/infra/devops-engineer/references/platform-engineering.md +417 -417
  403. package/skills/infra/devops-engineer/references/release-automation.md +527 -527
  404. package/skills/infra/devops-engineer/references/terraform-iac.md +141 -141
  405. package/skills/infra/kubernetes-specialist/SKILL.md +241 -241
  406. package/skills/infra/kubernetes-specialist/references/configuration.md +452 -452
  407. package/skills/infra/kubernetes-specialist/references/cost-optimization.md +458 -458
  408. package/skills/infra/kubernetes-specialist/references/custom-operators.md +563 -563
  409. package/skills/infra/kubernetes-specialist/references/gitops.md +530 -530
  410. package/skills/infra/kubernetes-specialist/references/helm-charts.md +912 -912
  411. package/skills/infra/kubernetes-specialist/references/multi-cluster.md +507 -507
  412. package/skills/infra/kubernetes-specialist/references/networking.md +447 -447
  413. package/skills/infra/kubernetes-specialist/references/service-mesh.md +459 -459
  414. package/skills/infra/kubernetes-specialist/references/storage.md +535 -535
  415. package/skills/infra/kubernetes-specialist/references/troubleshooting.md +414 -414
  416. package/skills/infra/kubernetes-specialist/references/workloads.md +377 -377
  417. package/skills/infra/mcp-developer/SKILL.md +143 -143
  418. package/skills/infra/mcp-developer/references/protocol.md +244 -244
  419. package/skills/infra/mcp-developer/references/python-sdk.md +367 -367
  420. package/skills/infra/mcp-developer/references/resources.md +554 -554
  421. package/skills/infra/mcp-developer/references/tools.md +480 -480
  422. package/skills/infra/mcp-developer/references/typescript-sdk.md +350 -350
  423. package/skills/infra/monitoring-expert/SKILL.md +176 -176
  424. package/skills/infra/monitoring-expert/references/alerting-rules.md +141 -141
  425. package/skills/infra/monitoring-expert/references/application-profiling.md +331 -331
  426. package/skills/infra/monitoring-expert/references/capacity-planning.md +344 -344
  427. package/skills/infra/monitoring-expert/references/dashboards.md +126 -126
  428. package/skills/infra/monitoring-expert/references/opentelemetry.md +123 -123
  429. package/skills/infra/monitoring-expert/references/performance-testing.md +269 -269
  430. package/skills/infra/monitoring-expert/references/prometheus-metrics.md +136 -136
  431. package/skills/infra/monitoring-expert/references/structured-logging.md +142 -142
  432. package/skills/infra/sre-engineer/SKILL.md +181 -181
  433. package/skills/infra/sre-engineer/references/automation-toil.md +492 -492
  434. package/skills/infra/sre-engineer/references/error-budget-policy.md +334 -334
  435. package/skills/infra/sre-engineer/references/incident-chaos.md +576 -576
  436. package/skills/infra/sre-engineer/references/monitoring-alerting.md +424 -424
  437. package/skills/infra/sre-engineer/references/slo-sli-management.md +238 -238
  438. package/skills/infra/terraform-engineer/SKILL.md +143 -143
  439. package/skills/infra/terraform-engineer/references/best-practices.md +583 -583
  440. package/skills/infra/terraform-engineer/references/module-patterns.md +297 -297
  441. package/skills/infra/terraform-engineer/references/providers.md +452 -452
  442. package/skills/infra/terraform-engineer/references/state-management.md +371 -371
  443. package/skills/infra/terraform-engineer/references/testing.md +486 -486
  444. package/skills/infra/websocket-engineer/SKILL.md +168 -168
  445. package/skills/infra/websocket-engineer/references/alternatives.md +391 -391
  446. package/skills/infra/websocket-engineer/references/patterns.md +400 -400
  447. package/skills/infra/websocket-engineer/references/protocol.md +195 -195
  448. package/skills/infra/websocket-engineer/references/scaling.md +333 -333
  449. package/skills/infra/websocket-engineer/references/security.md +474 -474
  450. package/skills/java/java-architect/SKILL.md +132 -132
  451. package/skills/java/java-architect/references/jpa-optimization.md +393 -393
  452. package/skills/java/java-architect/references/reactive-webflux.md +356 -356
  453. package/skills/java/java-architect/references/spring-boot-setup.md +269 -269
  454. package/skills/java/java-architect/references/spring-security.md +445 -445
  455. package/skills/java/java-architect/references/testing-patterns.md +500 -500
  456. package/skills/java/kotlin-specialist/SKILL.md +147 -147
  457. package/skills/java/kotlin-specialist/references/android-compose.md +419 -419
  458. package/skills/java/kotlin-specialist/references/coroutines-flow.md +276 -276
  459. package/skills/java/kotlin-specialist/references/dsl-idioms.md +421 -421
  460. package/skills/java/kotlin-specialist/references/ktor-server.md +426 -426
  461. package/skills/java/kotlin-specialist/references/multiplatform-kmp.md +380 -380
  462. package/skills/java/spring-boot-engineer/SKILL.md +195 -195
  463. package/skills/java/spring-boot-engineer/references/cloud.md +498 -498
  464. package/skills/java/spring-boot-engineer/references/data.md +381 -381
  465. package/skills/java/spring-boot-engineer/references/security.md +459 -459
  466. package/skills/java/spring-boot-engineer/references/testing.md +545 -545
  467. package/skills/java/spring-boot-engineer/references/web.md +295 -295
  468. package/skills/javascript/javascript-pro/SKILL.md +132 -132
  469. package/skills/javascript/javascript-pro/references/async-patterns.md +334 -334
  470. package/skills/javascript/javascript-pro/references/browser-apis.md +398 -398
  471. package/skills/javascript/javascript-pro/references/modern-syntax.md +272 -272
  472. package/skills/javascript/javascript-pro/references/modules.md +357 -357
  473. package/skills/javascript/javascript-pro/references/node-essentials.md +471 -471
  474. package/skills/javascript/nestjs-expert/SKILL.md +206 -206
  475. package/skills/javascript/nestjs-expert/references/authentication.md +166 -166
  476. package/skills/javascript/nestjs-expert/references/controllers-routing.md +111 -111
  477. package/skills/javascript/nestjs-expert/references/dtos-validation.md +153 -153
  478. package/skills/javascript/nestjs-expert/references/migration-from-express.md +1237 -1237
  479. package/skills/javascript/nestjs-expert/references/services-di.md +140 -140
  480. package/skills/javascript/nestjs-expert/references/testing-patterns.md +186 -186
  481. package/skills/javascript/typescript-pro/SKILL.md +145 -145
  482. package/skills/javascript/typescript-pro/references/advanced-types.md +259 -259
  483. package/skills/javascript/typescript-pro/references/configuration.md +445 -445
  484. package/skills/javascript/typescript-pro/references/patterns.md +484 -484
  485. package/skills/javascript/typescript-pro/references/type-guards.md +352 -352
  486. package/skills/javascript/typescript-pro/references/utility-types.md +329 -329
  487. package/skills/php/laravel-specialist/SKILL.md +262 -262
  488. package/skills/php/laravel-specialist/references/eloquent.md +351 -351
  489. package/skills/php/laravel-specialist/references/livewire.md +512 -512
  490. package/skills/php/laravel-specialist/references/queues.md +423 -423
  491. package/skills/php/laravel-specialist/references/routing.md +362 -362
  492. package/skills/php/laravel-specialist/references/testing.md +522 -522
  493. package/skills/php/php-pro/SKILL.md +206 -206
  494. package/skills/php/php-pro/references/async-patterns.md +412 -412
  495. package/skills/php/php-pro/references/laravel-patterns.md +377 -377
  496. package/skills/php/php-pro/references/modern-php-features.md +323 -323
  497. package/skills/php/php-pro/references/symfony-patterns.md +466 -466
  498. package/skills/php/php-pro/references/testing-quality.md +466 -466
  499. package/skills/product/competitive-analysis/SKILL.md +257 -257
  500. package/skills/product/meeting-notes/SKILL.md +266 -266
  501. package/skills/product/prd-template/SKILL.md +150 -150
  502. package/skills/product/stakeholder-update/SKILL.md +225 -225
  503. package/skills/product/user-research-synthesis/SKILL.md +235 -235
  504. package/skills/python/django-expert/SKILL.md +162 -162
  505. package/skills/python/django-expert/references/authentication.md +145 -145
  506. package/skills/python/django-expert/references/drf-serializers.md +148 -148
  507. package/skills/python/django-expert/references/models-orm.md +151 -151
  508. package/skills/python/django-expert/references/testing-django.md +204 -204
  509. package/skills/python/django-expert/references/viewsets-views.md +153 -153
  510. package/skills/python/fastapi-expert/SKILL.md +185 -185
  511. package/skills/python/fastapi-expert/references/async-sqlalchemy.md +146 -146
  512. package/skills/python/fastapi-expert/references/authentication.md +159 -159
  513. package/skills/python/fastapi-expert/references/endpoints-routing.md +142 -142
  514. package/skills/python/fastapi-expert/references/migration-from-django.md +996 -996
  515. package/skills/python/fastapi-expert/references/pydantic-v2.md +135 -135
  516. package/skills/python/fastapi-expert/references/testing-async.md +159 -159
  517. package/skills/python/pandas-pro/SKILL.md +178 -178
  518. package/skills/python/pandas-pro/references/aggregation-groupby.md +545 -545
  519. package/skills/python/pandas-pro/references/data-cleaning.md +500 -500
  520. package/skills/python/pandas-pro/references/dataframe-operations.md +420 -420
  521. package/skills/python/pandas-pro/references/merging-joining.md +596 -596
  522. package/skills/python/pandas-pro/references/performance-optimization.md +597 -597
  523. package/skills/python/python-pro/SKILL.md +177 -177
  524. package/skills/python/python-pro/references/async-patterns.md +356 -356
  525. package/skills/python/python-pro/references/packaging.md +460 -460
  526. package/skills/python/python-pro/references/standard-library.md +378 -378
  527. package/skills/python/python-pro/references/testing.md +404 -404
  528. package/skills/python/python-pro/references/type-system.md +290 -290
  529. package/skills/quality/chaos-engineer/SKILL.md +182 -182
  530. package/skills/quality/chaos-engineer/references/chaos-tools.md +511 -511
  531. package/skills/quality/chaos-engineer/references/experiment-design.md +229 -229
  532. package/skills/quality/chaos-engineer/references/game-days.md +434 -434
  533. package/skills/quality/chaos-engineer/references/infrastructure-chaos.md +348 -348
  534. package/skills/quality/chaos-engineer/references/kubernetes-chaos.md +432 -432
  535. package/skills/quality/code-reviewer/SKILL.md +119 -119
  536. package/skills/quality/code-reviewer/references/common-issues.md +142 -142
  537. package/skills/quality/code-reviewer/references/feedback-examples.md +144 -144
  538. package/skills/quality/code-reviewer/references/receiving-feedback.md +238 -238
  539. package/skills/quality/code-reviewer/references/report-template.md +109 -109
  540. package/skills/quality/code-reviewer/references/review-checklist.md +88 -88
  541. package/skills/quality/code-reviewer/references/spec-compliance-review.md +258 -258
  542. package/skills/quality/playwright-expert/SKILL.md +169 -169
  543. package/skills/quality/playwright-expert/references/api-mocking.md +140 -140
  544. package/skills/quality/playwright-expert/references/configuration.md +155 -155
  545. package/skills/quality/playwright-expert/references/debugging-flaky.md +150 -150
  546. package/skills/quality/playwright-expert/references/page-object-model.md +152 -152
  547. package/skills/quality/playwright-expert/references/selectors-locators.md +119 -119
  548. package/skills/quality/secure-code-guardian/SKILL.md +191 -191
  549. package/skills/quality/secure-code-guardian/references/authentication.md +136 -136
  550. package/skills/quality/secure-code-guardian/references/input-validation.md +146 -146
  551. package/skills/quality/secure-code-guardian/references/owasp-prevention.md +135 -135
  552. package/skills/quality/secure-code-guardian/references/security-headers.md +133 -133
  553. package/skills/quality/secure-code-guardian/references/xss-csrf.md +157 -157
  554. package/skills/quality/security-reviewer/SKILL.md +103 -103
  555. package/skills/quality/security-reviewer/references/infrastructure-security.md +268 -268
  556. package/skills/quality/security-reviewer/references/penetration-testing.md +268 -268
  557. package/skills/quality/security-reviewer/references/report-template.md +170 -170
  558. package/skills/quality/security-reviewer/references/sast-tools.md +117 -117
  559. package/skills/quality/security-reviewer/references/secret-scanning.md +125 -125
  560. package/skills/quality/security-reviewer/references/vulnerability-patterns.md +152 -152
  561. package/skills/quality/senior-qa/README.md +196 -196
  562. package/skills/quality/senior-qa/SKILL.md +399 -399
  563. package/skills/quality/senior-qa/references/qa_best_practices.md +964 -964
  564. package/skills/quality/senior-qa/references/test_automation_patterns.md +1009 -1009
  565. package/skills/quality/senior-qa/references/testing_strategies.md +649 -649
  566. package/skills/quality/senior-qa/scripts/coverage_analyzer.py +836 -836
  567. package/skills/quality/senior-qa/scripts/e2e_test_scaffolder.py +820 -820
  568. package/skills/quality/senior-qa/scripts/test_suite_generator.py +605 -605
  569. package/skills/quality/tdd-guide/HOW_TO_USE.md +313 -313
  570. package/skills/quality/tdd-guide/README.md +680 -680
  571. package/skills/quality/tdd-guide/SKILL.md +122 -122
  572. package/skills/quality/tdd-guide/assets/expected_output.json +77 -77
  573. package/skills/quality/tdd-guide/assets/sample_input_python.json +39 -39
  574. package/skills/quality/tdd-guide/assets/sample_input_typescript.json +36 -36
  575. package/skills/quality/tdd-guide/references/ci-integration.md +195 -195
  576. package/skills/quality/tdd-guide/references/framework-guide.md +206 -206
  577. package/skills/quality/tdd-guide/references/tdd-best-practices.md +128 -128
  578. package/skills/quality/tdd-guide/scripts/coverage_analyzer.py +434 -434
  579. package/skills/quality/tdd-guide/scripts/fixture_generator.py +440 -440
  580. package/skills/quality/tdd-guide/scripts/format_detector.py +384 -384
  581. package/skills/quality/tdd-guide/scripts/framework_adapter.py +428 -428
  582. package/skills/quality/tdd-guide/scripts/metrics_calculator.py +456 -456
  583. package/skills/quality/tdd-guide/scripts/output_formatter.py +354 -354
  584. package/skills/quality/tdd-guide/scripts/tdd_workflow.py +474 -474
  585. package/skills/quality/tdd-guide/scripts/test_generator.py +438 -438
  586. package/skills/quality/test-master/SKILL.md +94 -94
  587. package/skills/quality/test-master/references/automation-frameworks.md +294 -294
  588. package/skills/quality/test-master/references/e2e-testing.md +128 -128
  589. package/skills/quality/test-master/references/integration-testing.md +120 -120
  590. package/skills/quality/test-master/references/performance-testing.md +118 -118
  591. package/skills/quality/test-master/references/qa-methodology.md +247 -247
  592. package/skills/quality/test-master/references/security-testing.md +127 -127
  593. package/skills/quality/test-master/references/tdd-iron-laws.md +174 -174
  594. package/skills/quality/test-master/references/test-reports.md +104 -104
  595. package/skills/quality/test-master/references/testing-anti-patterns.md +231 -231
  596. package/skills/quality/test-master/references/unit-testing.md +113 -113
  597. package/skills/ruby/rails-expert/SKILL.md +154 -154
  598. package/skills/ruby/rails-expert/references/active-record.md +244 -244
  599. package/skills/ruby/rails-expert/references/api-development.md +401 -401
  600. package/skills/ruby/rails-expert/references/background-jobs.md +272 -272
  601. package/skills/ruby/rails-expert/references/hotwire-turbo.md +228 -228
  602. package/skills/ruby/rails-expert/references/rspec-testing.md +367 -367
  603. package/skills/swift/swift-expert/SKILL.md +163 -163
  604. package/skills/swift/swift-expert/references/async-concurrency.md +360 -360
  605. package/skills/swift/swift-expert/references/memory-performance.md +377 -377
  606. package/skills/swift/swift-expert/references/protocol-oriented.md +354 -354
  607. package/skills/swift/swift-expert/references/swiftui-patterns.md +291 -291
  608. package/skills/swift/swift-expert/references/testing-patterns.md +399 -399
  609. package/skills/workflow/brainstorming/SKILL.md +164 -164
  610. package/skills/workflow/brainstorming/scripts/frame-template.html +214 -214
  611. package/skills/workflow/brainstorming/scripts/helper.js +88 -88
  612. package/skills/workflow/brainstorming/scripts/server.cjs +354 -354
  613. package/skills/workflow/brainstorming/scripts/start-server.sh +148 -148
  614. package/skills/workflow/brainstorming/scripts/stop-server.sh +56 -56
  615. package/skills/workflow/brainstorming/spec-document-reviewer-prompt.md +49 -49
  616. package/skills/workflow/brainstorming/visual-companion.md +287 -287
  617. package/skills/workflow/documentation/SKILL.md +45 -45
  618. package/skills/workflow/entropy-management/SKILL.md +115 -115
  619. package/skills/workflow/executing-plans/SKILL.md +70 -70
  620. package/skills/workflow/finishing-a-development-branch/SKILL.md +200 -200
  621. package/skills/workflow/receiving-code-review/SKILL.md +213 -213
  622. package/skills/workflow/requesting-code-review/SKILL.md +105 -105
  623. package/skills/workflow/requesting-code-review/code-reviewer.md +146 -146
  624. package/skills/workflow/requirement-engineering/SKILL.md +111 -111
  625. package/skills/workflow/systematic-debugging/CREATION-LOG.md +119 -119
  626. package/skills/workflow/systematic-debugging/SKILL.md +296 -296
  627. package/skills/workflow/systematic-debugging/condition-based-waiting-example.ts +158 -158
  628. package/skills/workflow/systematic-debugging/condition-based-waiting.md +115 -115
  629. package/skills/workflow/systematic-debugging/defense-in-depth.md +122 -122
  630. package/skills/workflow/systematic-debugging/find-polluter.sh +63 -63
  631. package/skills/workflow/systematic-debugging/root-cause-tracing.md +169 -169
  632. package/skills/workflow/systematic-debugging/test-academic.md +14 -14
  633. package/skills/workflow/systematic-debugging/test-pressure-1.md +58 -58
  634. package/skills/workflow/systematic-debugging/test-pressure-2.md +68 -68
  635. package/skills/workflow/systematic-debugging/test-pressure-3.md +69 -69
  636. package/skills/workflow/using-git-worktrees/SKILL.md +218 -218
  637. package/skills/workflow/verification-before-completion/SKILL.md +139 -139
  638. package/skills/workflow/writing-plans/SKILL.md +151 -151
  639. package/skills/workflow/writing-plans/plan-document-reviewer-prompt.md +49 -49
  640. package/skills/workflow/writing-skills/SKILL.md +655 -655
  641. package/skills/workflow/writing-skills/anthropic-best-practices.md +1150 -1150
  642. package/skills/workflow/writing-skills/examples/CLAUDE_MD_TESTING.md +189 -189
  643. package/skills/workflow/writing-skills/persuasion-principles.md +187 -187
  644. package/skills/workflow/writing-skills/render-graphs.js +168 -168
  645. package/skills/workflow/writing-skills/testing-skills-with-subagents.md +384 -384
@@ -1,565 +1,565 @@
1
- # Hyperparameter Tuning for LLM Fine-Tuning
2
-
3
- ---
4
-
5
- ## Overview
6
-
7
- Hyperparameter selection significantly impacts fine-tuning success. This reference provides practical guidance for learning rates, batch sizes, schedulers, and optimization strategies tailored to LLM fine-tuning.
8
-
9
- ## Learning Rate Selection
10
-
11
- ### Guidelines by Fine-Tuning Method
12
-
13
- | Method | Typical Range | Starting Point | Notes |
14
- |--------|---------------|----------------|-------|
15
- | Full Fine-Tuning | 1e-6 to 5e-5 | 2e-5 | Lower for larger models |
16
- | LoRA | 1e-5 to 3e-4 | 2e-4 | Can use higher LR |
17
- | QLoRA | 1e-5 to 2e-4 | 1e-4 | Similar to LoRA |
18
- | Prefix Tuning | 1e-4 to 1e-2 | 3e-4 | Only training embeddings |
19
-
20
- ### Learning Rate Finder
21
-
22
- ```python
23
- import torch
24
- import matplotlib.pyplot as plt
25
- from transformers import Trainer, TrainingArguments
26
-
27
- def find_learning_rate(
28
- model,
29
- train_dataset,
30
- tokenizer,
31
- min_lr: float = 1e-7,
32
- max_lr: float = 1e-2,
33
- num_steps: int = 100
34
- ) -> tuple[list[float], list[float]]:
35
- """
36
- Find optimal learning rate using LR range test.
37
-
38
- Returns:
39
- Tuple of (learning_rates, losses)
40
- """
41
- # Create temporary training args with linearly increasing LR
42
- training_args = TrainingArguments(
43
- output_dir="./lr_finder",
44
- max_steps=num_steps,
45
- per_device_train_batch_size=4,
46
- gradient_accumulation_steps=4,
47
- learning_rate=max_lr,
48
- warmup_steps=0,
49
- logging_steps=1,
50
- save_strategy="no",
51
- report_to="none"
52
- )
53
-
54
- trainer = Trainer(
55
- model=model,
56
- args=training_args,
57
- train_dataset=train_dataset,
58
- tokenizer=tokenizer
59
- )
60
-
61
- # Custom LR schedule that increases exponentially
62
- lrs = []
63
- losses = []
64
- multiplier = (max_lr / min_lr) ** (1 / num_steps)
65
-
66
- current_lr = min_lr
67
- for step in range(num_steps):
68
- # Set LR
69
- for param_group in trainer.optimizer.param_groups:
70
- param_group['lr'] = current_lr
71
-
72
- # Training step
73
- loss = trainer.training_step(model, next(iter(trainer.get_train_dataloader())))
74
-
75
- lrs.append(current_lr)
76
- losses.append(loss.item())
77
-
78
- current_lr *= multiplier
79
-
80
- # Stop if loss explodes
81
- if loss.item() > losses[0] * 10:
82
- break
83
-
84
- return lrs, losses
85
-
86
- def plot_lr_finder(lrs: list[float], losses: list[float]):
87
- """Plot learning rate finder results."""
88
- plt.figure(figsize=(10, 6))
89
- plt.semilogx(lrs, losses)
90
- plt.xlabel("Learning Rate")
91
- plt.ylabel("Loss")
92
- plt.title("Learning Rate Finder")
93
-
94
- # Find suggested LR (steepest descent)
95
- gradients = [(losses[i+1] - losses[i]) / (lrs[i+1] - lrs[i])
96
- for i in range(len(losses) - 1)]
97
- suggested_idx = gradients.index(min(gradients))
98
- suggested_lr = lrs[suggested_idx]
99
-
100
- plt.axvline(x=suggested_lr, color='r', linestyle='--',
101
- label=f'Suggested LR: {suggested_lr:.2e}')
102
- plt.legend()
103
- plt.savefig("lr_finder.png")
104
- print(f"Suggested learning rate: {suggested_lr:.2e}")
105
-
106
- return suggested_lr
107
- ```
108
-
109
- ## Batch Size Optimization
110
-
111
- ### Effective Batch Size Calculation
112
-
113
- ```python
114
- def calculate_training_config(
115
- target_batch_size: int,
116
- gpu_memory_gb: float,
117
- model_size_b: float,
118
- sequence_length: int = 2048,
119
- method: str = "qlora"
120
- ) -> dict:
121
- """
122
- Calculate optimal batch size and gradient accumulation.
123
-
124
- Args:
125
- target_batch_size: Desired effective batch size
126
- gpu_memory_gb: Available GPU memory
127
- model_size_b: Model size in billions
128
- sequence_length: Maximum sequence length
129
- method: "full", "lora", or "qlora"
130
- """
131
- # Memory estimation (rough heuristics)
132
- memory_per_param = {
133
- "full": 20, # bf16 params + optimizer states + gradients
134
- "lora": 4, # bf16 inference + small trainable
135
- "qlora": 1.5 # 4-bit + small trainable
136
- }
137
-
138
- base_memory_gb = model_size_b * memory_per_param[method]
139
- available_for_batch = gpu_memory_gb - base_memory_gb
140
-
141
- # Memory per sample (rough estimate)
142
- tokens_per_gb = 1000 * (8 / model_size_b) # Rough scaling
143
- max_samples_in_memory = int(available_for_batch * tokens_per_gb / sequence_length)
144
- max_batch_per_device = max(1, max_samples_in_memory)
145
-
146
- # Calculate gradient accumulation
147
- gradient_accumulation = max(1, target_batch_size // max_batch_per_device)
148
- actual_batch_per_device = min(max_batch_per_device, target_batch_size // gradient_accumulation)
149
-
150
- effective_batch_size = actual_batch_per_device * gradient_accumulation
151
-
152
- return {
153
- "per_device_train_batch_size": actual_batch_per_device,
154
- "gradient_accumulation_steps": gradient_accumulation,
155
- "effective_batch_size": effective_batch_size,
156
- "estimated_memory_gb": base_memory_gb + (actual_batch_per_device * sequence_length / tokens_per_gb)
157
- }
158
-
159
- # Example usage
160
- config = calculate_training_config(
161
- target_batch_size=32,
162
- gpu_memory_gb=24, # RTX 4090
163
- model_size_b=8, # Llama 3.1 8B
164
- method="qlora"
165
- )
166
- print(config)
167
- # {'per_device_train_batch_size': 4, 'gradient_accumulation_steps': 8, 'effective_batch_size': 32, ...}
168
- ```
169
-
170
- ### Batch Size Guidelines
171
-
172
- | Dataset Size | Recommended Batch Size | Notes |
173
- |--------------|------------------------|-------|
174
- | < 1,000 | 8-16 | Small batch for more updates |
175
- | 1,000 - 10,000 | 16-32 | Standard batch size |
176
- | 10,000 - 100,000 | 32-64 | Larger batch for stability |
177
- | > 100,000 | 64-128 | Can use larger batches |
178
-
179
- ## Learning Rate Schedulers
180
-
181
- ```python
182
- from transformers import get_scheduler
183
- import torch
184
-
185
- def create_scheduler(
186
- optimizer,
187
- scheduler_type: str,
188
- num_training_steps: int,
189
- warmup_ratio: float = 0.03,
190
- min_lr_ratio: float = 0.1
191
- ):
192
- """
193
- Create learning rate scheduler.
194
-
195
- Args:
196
- scheduler_type: "cosine", "linear", "constant_with_warmup", "cosine_with_restarts"
197
- num_training_steps: Total training steps
198
- warmup_ratio: Fraction of steps for warmup
199
- min_lr_ratio: Minimum LR as fraction of max (for cosine)
200
- """
201
- num_warmup_steps = int(num_training_steps * warmup_ratio)
202
-
203
- if scheduler_type == "cosine":
204
- scheduler = get_scheduler(
205
- "cosine",
206
- optimizer=optimizer,
207
- num_warmup_steps=num_warmup_steps,
208
- num_training_steps=num_training_steps
209
- )
210
- elif scheduler_type == "cosine_with_min_lr":
211
- # Custom cosine with minimum LR
212
- from torch.optim.lr_scheduler import CosineAnnealingLR, SequentialLR, LinearLR
213
-
214
- warmup = LinearLR(
215
- optimizer,
216
- start_factor=0.01,
217
- end_factor=1.0,
218
- total_iters=num_warmup_steps
219
- )
220
- cosine = CosineAnnealingLR(
221
- optimizer,
222
- T_max=num_training_steps - num_warmup_steps,
223
- eta_min=optimizer.defaults['lr'] * min_lr_ratio
224
- )
225
- scheduler = SequentialLR(
226
- optimizer,
227
- schedulers=[warmup, cosine],
228
- milestones=[num_warmup_steps]
229
- )
230
- elif scheduler_type == "constant_with_warmup":
231
- scheduler = get_scheduler(
232
- "constant_with_warmup",
233
- optimizer=optimizer,
234
- num_warmup_steps=num_warmup_steps,
235
- num_training_steps=num_training_steps
236
- )
237
- else:
238
- scheduler = get_scheduler(
239
- scheduler_type,
240
- optimizer=optimizer,
241
- num_warmup_steps=num_warmup_steps,
242
- num_training_steps=num_training_steps
243
- )
244
-
245
- return scheduler
246
-
247
- # Scheduler comparison
248
- SCHEDULER_GUIDE = """
249
- Scheduler Selection:
250
- - cosine: Best for most fine-tuning tasks, smooth decay
251
- - linear: Good for short training runs
252
- - constant_with_warmup: For very short fine-tuning or when LR is already optimal
253
- - cosine_with_restarts: For longer training with periodic exploration
254
- """
255
- ```
256
-
257
- ### Visualizing Schedulers
258
-
259
- ```python
260
- def visualize_schedulers(num_steps: int = 1000, warmup_ratio: float = 0.03):
261
- """Plot different scheduler behaviors."""
262
- import matplotlib.pyplot as plt
263
-
264
- schedulers_to_plot = ["cosine", "linear", "constant_with_warmup"]
265
- base_lr = 2e-4
266
-
267
- plt.figure(figsize=(12, 6))
268
-
269
- for sched_type in schedulers_to_plot:
270
- # Create dummy optimizer
271
- dummy_param = torch.nn.Parameter(torch.zeros(1))
272
- optimizer = torch.optim.AdamW([dummy_param], lr=base_lr)
273
-
274
- scheduler = create_scheduler(
275
- optimizer,
276
- scheduler_type=sched_type,
277
- num_training_steps=num_steps,
278
- warmup_ratio=warmup_ratio
279
- )
280
-
281
- lrs = []
282
- for _ in range(num_steps):
283
- lrs.append(optimizer.param_groups[0]['lr'])
284
- scheduler.step()
285
-
286
- plt.plot(lrs, label=sched_type)
287
-
288
- plt.xlabel("Step")
289
- plt.ylabel("Learning Rate")
290
- plt.title("Learning Rate Schedulers")
291
- plt.legend()
292
- plt.savefig("schedulers.png")
293
- ```
294
-
295
- ## Complete Training Configuration
296
-
297
- ```python
298
- from transformers import TrainingArguments
299
- from dataclasses import dataclass
300
- from typing import Optional
301
-
302
- @dataclass
303
- class FineTuningConfig:
304
- """Complete fine-tuning configuration."""
305
- # Model
306
- model_name: str
307
- method: str = "qlora" # "full", "lora", "qlora"
308
-
309
- # LoRA specific
310
- lora_r: int = 16
311
- lora_alpha: int = 32
312
- lora_dropout: float = 0.05
313
-
314
- # Training
315
- learning_rate: float = 2e-4
316
- num_epochs: int = 3
317
- batch_size: int = 32
318
- max_seq_length: int = 2048
319
-
320
- # Scheduler
321
- scheduler_type: str = "cosine"
322
- warmup_ratio: float = 0.03
323
-
324
- # Optimization
325
- weight_decay: float = 0.01
326
- max_grad_norm: float = 1.0
327
- adam_beta1: float = 0.9
328
- adam_beta2: float = 0.999
329
- adam_epsilon: float = 1e-8
330
-
331
- # Hardware
332
- gradient_checkpointing: bool = True
333
- bf16: bool = True
334
- tf32: bool = True
335
-
336
- # Evaluation
337
- eval_steps: int = 100
338
- save_steps: int = 100
339
- logging_steps: int = 10
340
-
341
- def create_training_args(
342
- config: FineTuningConfig,
343
- output_dir: str,
344
- gpu_memory_gb: float
345
- ) -> TrainingArguments:
346
- """Create TrainingArguments from config."""
347
-
348
- # Calculate batch configuration
349
- batch_config = calculate_training_config(
350
- target_batch_size=config.batch_size,
351
- gpu_memory_gb=gpu_memory_gb,
352
- model_size_b=8, # Estimate or pass as parameter
353
- sequence_length=config.max_seq_length,
354
- method=config.method
355
- )
356
-
357
- return TrainingArguments(
358
- output_dir=output_dir,
359
- num_train_epochs=config.num_epochs,
360
-
361
- # Batch size
362
- per_device_train_batch_size=batch_config["per_device_train_batch_size"],
363
- per_device_eval_batch_size=batch_config["per_device_train_batch_size"],
364
- gradient_accumulation_steps=batch_config["gradient_accumulation_steps"],
365
-
366
- # Learning rate
367
- learning_rate=config.learning_rate,
368
- lr_scheduler_type=config.scheduler_type,
369
- warmup_ratio=config.warmup_ratio,
370
-
371
- # Optimization
372
- weight_decay=config.weight_decay,
373
- max_grad_norm=config.max_grad_norm,
374
- adam_beta1=config.adam_beta1,
375
- adam_beta2=config.adam_beta2,
376
- adam_epsilon=config.adam_epsilon,
377
- optim="paged_adamw_8bit" if config.method == "qlora" else "adamw_torch",
378
-
379
- # Hardware
380
- gradient_checkpointing=config.gradient_checkpointing,
381
- gradient_checkpointing_kwargs={"use_reentrant": False},
382
- bf16=config.bf16,
383
- tf32=config.tf32,
384
-
385
- # Evaluation and saving
386
- eval_strategy="steps",
387
- eval_steps=config.eval_steps,
388
- save_strategy="steps",
389
- save_steps=config.save_steps,
390
- logging_steps=config.logging_steps,
391
- save_total_limit=3,
392
- load_best_model_at_end=True,
393
- metric_for_best_model="eval_loss",
394
- greater_is_better=False,
395
-
396
- # Misc
397
- group_by_length=True,
398
- report_to=["wandb"],
399
- run_name=f"{config.model_name.split('/')[-1]}-{config.method}"
400
- )
401
- ```
402
-
403
- ## Hyperparameter Search
404
-
405
- ```python
406
- from typing import Any
407
- import optuna
408
- from transformers import Trainer
409
-
410
- def hyperparameter_search(
411
- model_init,
412
- train_dataset,
413
- eval_dataset,
414
- tokenizer,
415
- n_trials: int = 20,
416
- direction: str = "minimize"
417
- ) -> dict[str, Any]:
418
- """
419
- Run hyperparameter search using Optuna.
420
-
421
- Args:
422
- model_init: Function that returns initialized model
423
- n_trials: Number of trials to run
424
- direction: "minimize" for loss, "maximize" for accuracy
425
- """
426
- def hp_space(trial: optuna.Trial) -> dict:
427
- return {
428
- "learning_rate": trial.suggest_float("learning_rate", 1e-5, 3e-4, log=True),
429
- "per_device_train_batch_size": trial.suggest_categorical(
430
- "per_device_train_batch_size", [2, 4, 8]
431
- ),
432
- "num_train_epochs": trial.suggest_int("num_train_epochs", 1, 5),
433
- "warmup_ratio": trial.suggest_float("warmup_ratio", 0.0, 0.1),
434
- "weight_decay": trial.suggest_float("weight_decay", 0.0, 0.1),
435
- "lr_scheduler_type": trial.suggest_categorical(
436
- "lr_scheduler_type", ["cosine", "linear", "constant_with_warmup"]
437
- )
438
- }
439
-
440
- training_args = TrainingArguments(
441
- output_dir="./hp_search",
442
- evaluation_strategy="epoch",
443
- save_strategy="no",
444
- report_to="none"
445
- )
446
-
447
- trainer = Trainer(
448
- model_init=model_init,
449
- args=training_args,
450
- train_dataset=train_dataset,
451
- eval_dataset=eval_dataset,
452
- tokenizer=tokenizer
453
- )
454
-
455
- best_trial = trainer.hyperparameter_search(
456
- hp_space=hp_space,
457
- backend="optuna",
458
- n_trials=n_trials,
459
- direction=direction
460
- )
461
-
462
- return best_trial.hyperparameters
463
-
464
- # Usage
465
- # best_params = hyperparameter_search(model_init, train_ds, eval_ds, tokenizer)
466
- ```
467
-
468
- ## Monitoring Training
469
-
470
- ```python
471
- from transformers import TrainerCallback
472
- import wandb
473
-
474
- class FineTuningCallback(TrainerCallback):
475
- """Custom callback for fine-tuning monitoring."""
476
-
477
- def on_log(self, args, state, control, logs=None, **kwargs):
478
- if logs is None:
479
- return
480
-
481
- # Calculate additional metrics
482
- if "loss" in logs and state.global_step > 0:
483
- # Track loss velocity
484
- if hasattr(self, "prev_loss"):
485
- loss_delta = logs["loss"] - self.prev_loss
486
- logs["loss_delta"] = loss_delta
487
- self.prev_loss = logs["loss"]
488
-
489
- def on_evaluate(self, args, state, control, metrics=None, **kwargs):
490
- if metrics is None:
491
- return
492
-
493
- # Log evaluation metrics
494
- train_loss = state.log_history[-1].get("loss", 0) if state.log_history else 0
495
- eval_loss = metrics.get("eval_loss", 0)
496
-
497
- # Warn if overfitting
498
- if train_loss > 0 and eval_loss > train_loss * 1.5:
499
- print(f"Warning: Potential overfitting. Train loss: {train_loss:.4f}, Eval loss: {eval_loss:.4f}")
500
-
501
- # Add to trainer
502
- # trainer.add_callback(FineTuningCallback())
503
- ```
504
-
505
- ## Quick Reference
506
-
507
- ### Recommended Starting Configurations
508
-
509
- **Small Dataset (<1K examples), QLoRA:**
510
- ```python
511
- TrainingArguments(
512
- learning_rate=1e-4,
513
- num_train_epochs=5,
514
- per_device_train_batch_size=2,
515
- gradient_accumulation_steps=8,
516
- lr_scheduler_type="cosine",
517
- warmup_ratio=0.1,
518
- weight_decay=0.05,
519
- max_grad_norm=0.3
520
- )
521
- ```
522
-
523
- **Medium Dataset (1K-10K examples), LoRA:**
524
- ```python
525
- TrainingArguments(
526
- learning_rate=2e-4,
527
- num_train_epochs=3,
528
- per_device_train_batch_size=4,
529
- gradient_accumulation_steps=4,
530
- lr_scheduler_type="cosine",
531
- warmup_ratio=0.03,
532
- weight_decay=0.01,
533
- max_grad_norm=1.0
534
- )
535
- ```
536
-
537
- **Large Dataset (>10K examples), Full Fine-Tuning:**
538
- ```python
539
- TrainingArguments(
540
- learning_rate=2e-5,
541
- num_train_epochs=2,
542
- per_device_train_batch_size=8,
543
- gradient_accumulation_steps=2,
544
- lr_scheduler_type="cosine",
545
- warmup_ratio=0.03,
546
- weight_decay=0.01,
547
- max_grad_norm=1.0
548
- )
549
- ```
550
-
551
- ## Common Issues
552
-
553
- | Issue | Likely Cause | Solution |
554
- |-------|--------------|----------|
555
- | Loss not decreasing | LR too low or too high | Use LR finder, try 10x or 0.1x |
556
- | Loss spikes | LR too high, no warmup | Add warmup, reduce LR |
557
- | Overfitting | Dataset too small, epochs too high | Reduce epochs, increase dropout |
558
- | Underfitting | LR too low, rank too low (LoRA) | Increase LR, increase rank |
559
- | OOM errors | Batch too large | Reduce batch, increase grad accum |
560
-
561
- ## Related References
562
-
563
- - `lora-peft.md` - LoRA rank and alpha selection
564
- - `evaluation-metrics.md` - Tracking training progress
565
- - `dataset-preparation.md` - Dataset size impacts on hyperparameters
1
+ # Hyperparameter Tuning for LLM Fine-Tuning
2
+
3
+ ---
4
+
5
+ ## Overview
6
+
7
+ Hyperparameter selection significantly impacts fine-tuning success. This reference provides practical guidance for learning rates, batch sizes, schedulers, and optimization strategies tailored to LLM fine-tuning.
8
+
9
+ ## Learning Rate Selection
10
+
11
+ ### Guidelines by Fine-Tuning Method
12
+
13
+ | Method | Typical Range | Starting Point | Notes |
14
+ |--------|---------------|----------------|-------|
15
+ | Full Fine-Tuning | 1e-6 to 5e-5 | 2e-5 | Lower for larger models |
16
+ | LoRA | 1e-5 to 3e-4 | 2e-4 | Can use higher LR |
17
+ | QLoRA | 1e-5 to 2e-4 | 1e-4 | Similar to LoRA |
18
+ | Prefix Tuning | 1e-4 to 1e-2 | 3e-4 | Only training embeddings |
19
+
20
+ ### Learning Rate Finder
21
+
22
+ ```python
23
+ import torch
24
+ import matplotlib.pyplot as plt
25
+ from transformers import Trainer, TrainingArguments
26
+
27
+ def find_learning_rate(
28
+ model,
29
+ train_dataset,
30
+ tokenizer,
31
+ min_lr: float = 1e-7,
32
+ max_lr: float = 1e-2,
33
+ num_steps: int = 100
34
+ ) -> tuple[list[float], list[float]]:
35
+ """
36
+ Find optimal learning rate using LR range test.
37
+
38
+ Returns:
39
+ Tuple of (learning_rates, losses)
40
+ """
41
+ # Create temporary training args with linearly increasing LR
42
+ training_args = TrainingArguments(
43
+ output_dir="./lr_finder",
44
+ max_steps=num_steps,
45
+ per_device_train_batch_size=4,
46
+ gradient_accumulation_steps=4,
47
+ learning_rate=max_lr,
48
+ warmup_steps=0,
49
+ logging_steps=1,
50
+ save_strategy="no",
51
+ report_to="none"
52
+ )
53
+
54
+ trainer = Trainer(
55
+ model=model,
56
+ args=training_args,
57
+ train_dataset=train_dataset,
58
+ tokenizer=tokenizer
59
+ )
60
+
61
+ # Custom LR schedule that increases exponentially
62
+ lrs = []
63
+ losses = []
64
+ multiplier = (max_lr / min_lr) ** (1 / num_steps)
65
+
66
+ current_lr = min_lr
67
+ for step in range(num_steps):
68
+ # Set LR
69
+ for param_group in trainer.optimizer.param_groups:
70
+ param_group['lr'] = current_lr
71
+
72
+ # Training step
73
+ loss = trainer.training_step(model, next(iter(trainer.get_train_dataloader())))
74
+
75
+ lrs.append(current_lr)
76
+ losses.append(loss.item())
77
+
78
+ current_lr *= multiplier
79
+
80
+ # Stop if loss explodes
81
+ if loss.item() > losses[0] * 10:
82
+ break
83
+
84
+ return lrs, losses
85
+
86
+ def plot_lr_finder(lrs: list[float], losses: list[float]):
87
+ """Plot learning rate finder results."""
88
+ plt.figure(figsize=(10, 6))
89
+ plt.semilogx(lrs, losses)
90
+ plt.xlabel("Learning Rate")
91
+ plt.ylabel("Loss")
92
+ plt.title("Learning Rate Finder")
93
+
94
+ # Find suggested LR (steepest descent)
95
+ gradients = [(losses[i+1] - losses[i]) / (lrs[i+1] - lrs[i])
96
+ for i in range(len(losses) - 1)]
97
+ suggested_idx = gradients.index(min(gradients))
98
+ suggested_lr = lrs[suggested_idx]
99
+
100
+ plt.axvline(x=suggested_lr, color='r', linestyle='--',
101
+ label=f'Suggested LR: {suggested_lr:.2e}')
102
+ plt.legend()
103
+ plt.savefig("lr_finder.png")
104
+ print(f"Suggested learning rate: {suggested_lr:.2e}")
105
+
106
+ return suggested_lr
107
+ ```
108
+
109
+ ## Batch Size Optimization
110
+
111
+ ### Effective Batch Size Calculation
112
+
113
+ ```python
114
+ def calculate_training_config(
115
+ target_batch_size: int,
116
+ gpu_memory_gb: float,
117
+ model_size_b: float,
118
+ sequence_length: int = 2048,
119
+ method: str = "qlora"
120
+ ) -> dict:
121
+ """
122
+ Calculate optimal batch size and gradient accumulation.
123
+
124
+ Args:
125
+ target_batch_size: Desired effective batch size
126
+ gpu_memory_gb: Available GPU memory
127
+ model_size_b: Model size in billions
128
+ sequence_length: Maximum sequence length
129
+ method: "full", "lora", or "qlora"
130
+ """
131
+ # Memory estimation (rough heuristics)
132
+ memory_per_param = {
133
+ "full": 20, # bf16 params + optimizer states + gradients
134
+ "lora": 4, # bf16 inference + small trainable
135
+ "qlora": 1.5 # 4-bit + small trainable
136
+ }
137
+
138
+ base_memory_gb = model_size_b * memory_per_param[method]
139
+ available_for_batch = gpu_memory_gb - base_memory_gb
140
+
141
+ # Memory per sample (rough estimate)
142
+ tokens_per_gb = 1000 * (8 / model_size_b) # Rough scaling
143
+ max_samples_in_memory = int(available_for_batch * tokens_per_gb / sequence_length)
144
+ max_batch_per_device = max(1, max_samples_in_memory)
145
+
146
+ # Calculate gradient accumulation
147
+ gradient_accumulation = max(1, target_batch_size // max_batch_per_device)
148
+ actual_batch_per_device = min(max_batch_per_device, target_batch_size // gradient_accumulation)
149
+
150
+ effective_batch_size = actual_batch_per_device * gradient_accumulation
151
+
152
+ return {
153
+ "per_device_train_batch_size": actual_batch_per_device,
154
+ "gradient_accumulation_steps": gradient_accumulation,
155
+ "effective_batch_size": effective_batch_size,
156
+ "estimated_memory_gb": base_memory_gb + (actual_batch_per_device * sequence_length / tokens_per_gb)
157
+ }
158
+
159
+ # Example usage
160
+ config = calculate_training_config(
161
+ target_batch_size=32,
162
+ gpu_memory_gb=24, # RTX 4090
163
+ model_size_b=8, # Llama 3.1 8B
164
+ method="qlora"
165
+ )
166
+ print(config)
167
+ # {'per_device_train_batch_size': 4, 'gradient_accumulation_steps': 8, 'effective_batch_size': 32, ...}
168
+ ```
169
+
170
+ ### Batch Size Guidelines
171
+
172
+ | Dataset Size | Recommended Batch Size | Notes |
173
+ |--------------|------------------------|-------|
174
+ | < 1,000 | 8-16 | Small batch for more updates |
175
+ | 1,000 - 10,000 | 16-32 | Standard batch size |
176
+ | 10,000 - 100,000 | 32-64 | Larger batch for stability |
177
+ | > 100,000 | 64-128 | Can use larger batches |
178
+
179
+ ## Learning Rate Schedulers
180
+
181
+ ```python
182
+ from transformers import get_scheduler
183
+ import torch
184
+
185
+ def create_scheduler(
186
+ optimizer,
187
+ scheduler_type: str,
188
+ num_training_steps: int,
189
+ warmup_ratio: float = 0.03,
190
+ min_lr_ratio: float = 0.1
191
+ ):
192
+ """
193
+ Create learning rate scheduler.
194
+
195
+ Args:
196
+ scheduler_type: "cosine", "linear", "constant_with_warmup", "cosine_with_restarts"
197
+ num_training_steps: Total training steps
198
+ warmup_ratio: Fraction of steps for warmup
199
+ min_lr_ratio: Minimum LR as fraction of max (for cosine)
200
+ """
201
+ num_warmup_steps = int(num_training_steps * warmup_ratio)
202
+
203
+ if scheduler_type == "cosine":
204
+ scheduler = get_scheduler(
205
+ "cosine",
206
+ optimizer=optimizer,
207
+ num_warmup_steps=num_warmup_steps,
208
+ num_training_steps=num_training_steps
209
+ )
210
+ elif scheduler_type == "cosine_with_min_lr":
211
+ # Custom cosine with minimum LR
212
+ from torch.optim.lr_scheduler import CosineAnnealingLR, SequentialLR, LinearLR
213
+
214
+ warmup = LinearLR(
215
+ optimizer,
216
+ start_factor=0.01,
217
+ end_factor=1.0,
218
+ total_iters=num_warmup_steps
219
+ )
220
+ cosine = CosineAnnealingLR(
221
+ optimizer,
222
+ T_max=num_training_steps - num_warmup_steps,
223
+ eta_min=optimizer.defaults['lr'] * min_lr_ratio
224
+ )
225
+ scheduler = SequentialLR(
226
+ optimizer,
227
+ schedulers=[warmup, cosine],
228
+ milestones=[num_warmup_steps]
229
+ )
230
+ elif scheduler_type == "constant_with_warmup":
231
+ scheduler = get_scheduler(
232
+ "constant_with_warmup",
233
+ optimizer=optimizer,
234
+ num_warmup_steps=num_warmup_steps,
235
+ num_training_steps=num_training_steps
236
+ )
237
+ else:
238
+ scheduler = get_scheduler(
239
+ scheduler_type,
240
+ optimizer=optimizer,
241
+ num_warmup_steps=num_warmup_steps,
242
+ num_training_steps=num_training_steps
243
+ )
244
+
245
+ return scheduler
246
+
247
+ # Scheduler comparison
248
+ SCHEDULER_GUIDE = """
249
+ Scheduler Selection:
250
+ - cosine: Best for most fine-tuning tasks, smooth decay
251
+ - linear: Good for short training runs
252
+ - constant_with_warmup: For very short fine-tuning or when LR is already optimal
253
+ - cosine_with_restarts: For longer training with periodic exploration
254
+ """
255
+ ```
256
+
257
+ ### Visualizing Schedulers
258
+
259
+ ```python
260
+ def visualize_schedulers(num_steps: int = 1000, warmup_ratio: float = 0.03):
261
+ """Plot different scheduler behaviors."""
262
+ import matplotlib.pyplot as plt
263
+
264
+ schedulers_to_plot = ["cosine", "linear", "constant_with_warmup"]
265
+ base_lr = 2e-4
266
+
267
+ plt.figure(figsize=(12, 6))
268
+
269
+ for sched_type in schedulers_to_plot:
270
+ # Create dummy optimizer
271
+ dummy_param = torch.nn.Parameter(torch.zeros(1))
272
+ optimizer = torch.optim.AdamW([dummy_param], lr=base_lr)
273
+
274
+ scheduler = create_scheduler(
275
+ optimizer,
276
+ scheduler_type=sched_type,
277
+ num_training_steps=num_steps,
278
+ warmup_ratio=warmup_ratio
279
+ )
280
+
281
+ lrs = []
282
+ for _ in range(num_steps):
283
+ lrs.append(optimizer.param_groups[0]['lr'])
284
+ scheduler.step()
285
+
286
+ plt.plot(lrs, label=sched_type)
287
+
288
+ plt.xlabel("Step")
289
+ plt.ylabel("Learning Rate")
290
+ plt.title("Learning Rate Schedulers")
291
+ plt.legend()
292
+ plt.savefig("schedulers.png")
293
+ ```
294
+
295
+ ## Complete Training Configuration
296
+
297
+ ```python
298
+ from transformers import TrainingArguments
299
+ from dataclasses import dataclass
300
+ from typing import Optional
301
+
302
+ @dataclass
303
+ class FineTuningConfig:
304
+ """Complete fine-tuning configuration."""
305
+ # Model
306
+ model_name: str
307
+ method: str = "qlora" # "full", "lora", "qlora"
308
+
309
+ # LoRA specific
310
+ lora_r: int = 16
311
+ lora_alpha: int = 32
312
+ lora_dropout: float = 0.05
313
+
314
+ # Training
315
+ learning_rate: float = 2e-4
316
+ num_epochs: int = 3
317
+ batch_size: int = 32
318
+ max_seq_length: int = 2048
319
+
320
+ # Scheduler
321
+ scheduler_type: str = "cosine"
322
+ warmup_ratio: float = 0.03
323
+
324
+ # Optimization
325
+ weight_decay: float = 0.01
326
+ max_grad_norm: float = 1.0
327
+ adam_beta1: float = 0.9
328
+ adam_beta2: float = 0.999
329
+ adam_epsilon: float = 1e-8
330
+
331
+ # Hardware
332
+ gradient_checkpointing: bool = True
333
+ bf16: bool = True
334
+ tf32: bool = True
335
+
336
+ # Evaluation
337
+ eval_steps: int = 100
338
+ save_steps: int = 100
339
+ logging_steps: int = 10
340
+
341
+ def create_training_args(
342
+ config: FineTuningConfig,
343
+ output_dir: str,
344
+ gpu_memory_gb: float
345
+ ) -> TrainingArguments:
346
+ """Create TrainingArguments from config."""
347
+
348
+ # Calculate batch configuration
349
+ batch_config = calculate_training_config(
350
+ target_batch_size=config.batch_size,
351
+ gpu_memory_gb=gpu_memory_gb,
352
+ model_size_b=8, # Estimate or pass as parameter
353
+ sequence_length=config.max_seq_length,
354
+ method=config.method
355
+ )
356
+
357
+ return TrainingArguments(
358
+ output_dir=output_dir,
359
+ num_train_epochs=config.num_epochs,
360
+
361
+ # Batch size
362
+ per_device_train_batch_size=batch_config["per_device_train_batch_size"],
363
+ per_device_eval_batch_size=batch_config["per_device_train_batch_size"],
364
+ gradient_accumulation_steps=batch_config["gradient_accumulation_steps"],
365
+
366
+ # Learning rate
367
+ learning_rate=config.learning_rate,
368
+ lr_scheduler_type=config.scheduler_type,
369
+ warmup_ratio=config.warmup_ratio,
370
+
371
+ # Optimization
372
+ weight_decay=config.weight_decay,
373
+ max_grad_norm=config.max_grad_norm,
374
+ adam_beta1=config.adam_beta1,
375
+ adam_beta2=config.adam_beta2,
376
+ adam_epsilon=config.adam_epsilon,
377
+ optim="paged_adamw_8bit" if config.method == "qlora" else "adamw_torch",
378
+
379
+ # Hardware
380
+ gradient_checkpointing=config.gradient_checkpointing,
381
+ gradient_checkpointing_kwargs={"use_reentrant": False},
382
+ bf16=config.bf16,
383
+ tf32=config.tf32,
384
+
385
+ # Evaluation and saving
386
+ eval_strategy="steps",
387
+ eval_steps=config.eval_steps,
388
+ save_strategy="steps",
389
+ save_steps=config.save_steps,
390
+ logging_steps=config.logging_steps,
391
+ save_total_limit=3,
392
+ load_best_model_at_end=True,
393
+ metric_for_best_model="eval_loss",
394
+ greater_is_better=False,
395
+
396
+ # Misc
397
+ group_by_length=True,
398
+ report_to=["wandb"],
399
+ run_name=f"{config.model_name.split('/')[-1]}-{config.method}"
400
+ )
401
+ ```
402
+
403
+ ## Hyperparameter Search
404
+
405
+ ```python
406
+ from typing import Any
407
+ import optuna
408
+ from transformers import Trainer
409
+
410
+ def hyperparameter_search(
411
+ model_init,
412
+ train_dataset,
413
+ eval_dataset,
414
+ tokenizer,
415
+ n_trials: int = 20,
416
+ direction: str = "minimize"
417
+ ) -> dict[str, Any]:
418
+ """
419
+ Run hyperparameter search using Optuna.
420
+
421
+ Args:
422
+ model_init: Function that returns initialized model
423
+ n_trials: Number of trials to run
424
+ direction: "minimize" for loss, "maximize" for accuracy
425
+ """
426
+ def hp_space(trial: optuna.Trial) -> dict:
427
+ return {
428
+ "learning_rate": trial.suggest_float("learning_rate", 1e-5, 3e-4, log=True),
429
+ "per_device_train_batch_size": trial.suggest_categorical(
430
+ "per_device_train_batch_size", [2, 4, 8]
431
+ ),
432
+ "num_train_epochs": trial.suggest_int("num_train_epochs", 1, 5),
433
+ "warmup_ratio": trial.suggest_float("warmup_ratio", 0.0, 0.1),
434
+ "weight_decay": trial.suggest_float("weight_decay", 0.0, 0.1),
435
+ "lr_scheduler_type": trial.suggest_categorical(
436
+ "lr_scheduler_type", ["cosine", "linear", "constant_with_warmup"]
437
+ )
438
+ }
439
+
440
+ training_args = TrainingArguments(
441
+ output_dir="./hp_search",
442
+ evaluation_strategy="epoch",
443
+ save_strategy="no",
444
+ report_to="none"
445
+ )
446
+
447
+ trainer = Trainer(
448
+ model_init=model_init,
449
+ args=training_args,
450
+ train_dataset=train_dataset,
451
+ eval_dataset=eval_dataset,
452
+ tokenizer=tokenizer
453
+ )
454
+
455
+ best_trial = trainer.hyperparameter_search(
456
+ hp_space=hp_space,
457
+ backend="optuna",
458
+ n_trials=n_trials,
459
+ direction=direction
460
+ )
461
+
462
+ return best_trial.hyperparameters
463
+
464
+ # Usage
465
+ # best_params = hyperparameter_search(model_init, train_ds, eval_ds, tokenizer)
466
+ ```
467
+
468
+ ## Monitoring Training
469
+
470
+ ```python
471
+ from transformers import TrainerCallback
472
+ import wandb
473
+
474
+ class FineTuningCallback(TrainerCallback):
475
+ """Custom callback for fine-tuning monitoring."""
476
+
477
+ def on_log(self, args, state, control, logs=None, **kwargs):
478
+ if logs is None:
479
+ return
480
+
481
+ # Calculate additional metrics
482
+ if "loss" in logs and state.global_step > 0:
483
+ # Track loss velocity
484
+ if hasattr(self, "prev_loss"):
485
+ loss_delta = logs["loss"] - self.prev_loss
486
+ logs["loss_delta"] = loss_delta
487
+ self.prev_loss = logs["loss"]
488
+
489
+ def on_evaluate(self, args, state, control, metrics=None, **kwargs):
490
+ if metrics is None:
491
+ return
492
+
493
+ # Log evaluation metrics
494
+ train_loss = state.log_history[-1].get("loss", 0) if state.log_history else 0
495
+ eval_loss = metrics.get("eval_loss", 0)
496
+
497
+ # Warn if overfitting
498
+ if train_loss > 0 and eval_loss > train_loss * 1.5:
499
+ print(f"Warning: Potential overfitting. Train loss: {train_loss:.4f}, Eval loss: {eval_loss:.4f}")
500
+
501
+ # Add to trainer
502
+ # trainer.add_callback(FineTuningCallback())
503
+ ```
504
+
505
+ ## Quick Reference
506
+
507
+ ### Recommended Starting Configurations
508
+
509
+ **Small Dataset (<1K examples), QLoRA:**
510
+ ```python
511
+ TrainingArguments(
512
+ learning_rate=1e-4,
513
+ num_train_epochs=5,
514
+ per_device_train_batch_size=2,
515
+ gradient_accumulation_steps=8,
516
+ lr_scheduler_type="cosine",
517
+ warmup_ratio=0.1,
518
+ weight_decay=0.05,
519
+ max_grad_norm=0.3
520
+ )
521
+ ```
522
+
523
+ **Medium Dataset (1K-10K examples), LoRA:**
524
+ ```python
525
+ TrainingArguments(
526
+ learning_rate=2e-4,
527
+ num_train_epochs=3,
528
+ per_device_train_batch_size=4,
529
+ gradient_accumulation_steps=4,
530
+ lr_scheduler_type="cosine",
531
+ warmup_ratio=0.03,
532
+ weight_decay=0.01,
533
+ max_grad_norm=1.0
534
+ )
535
+ ```
536
+
537
+ **Large Dataset (>10K examples), Full Fine-Tuning:**
538
+ ```python
539
+ TrainingArguments(
540
+ learning_rate=2e-5,
541
+ num_train_epochs=2,
542
+ per_device_train_batch_size=8,
543
+ gradient_accumulation_steps=2,
544
+ lr_scheduler_type="cosine",
545
+ warmup_ratio=0.03,
546
+ weight_decay=0.01,
547
+ max_grad_norm=1.0
548
+ )
549
+ ```
550
+
551
+ ## Common Issues
552
+
553
+ | Issue | Likely Cause | Solution |
554
+ |-------|--------------|----------|
555
+ | Loss not decreasing | LR too low or too high | Use LR finder, try 10x or 0.1x |
556
+ | Loss spikes | LR too high, no warmup | Add warmup, reduce LR |
557
+ | Overfitting | Dataset too small, epochs too high | Reduce epochs, increase dropout |
558
+ | Underfitting | LR too low, rank too low (LoRA) | Increase LR, increase rank |
559
+ | OOM errors | Batch too large | Reduce batch, increase grad accum |
560
+
561
+ ## Related References
562
+
563
+ - `lora-peft.md` - LoRA rank and alpha selection
564
+ - `evaluation-metrics.md` - Tracking training progress
565
+ - `dataset-preparation.md` - Dataset size impacts on hyperparameters