@mytechtoday/augment-extensions 0.5.0 → 1.2.0

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 (523) hide show
  1. package/AGENTS.md +265 -232
  2. package/README.md +956 -771
  3. package/augment-extensions/coding-standards/bash/README.md +196 -196
  4. package/augment-extensions/coding-standards/bash/module.json +163 -163
  5. package/augment-extensions/coding-standards/bash/rules/naming-conventions.md +336 -336
  6. package/augment-extensions/coding-standards/bash/rules/universal-standards.md +289 -289
  7. package/augment-extensions/coding-standards/css/README.md +40 -40
  8. package/augment-extensions/coding-standards/css/examples/css-examples.css +550 -550
  9. package/augment-extensions/coding-standards/css/module.json +44 -44
  10. package/augment-extensions/coding-standards/css/rules/css-modern-features.md +448 -448
  11. package/augment-extensions/coding-standards/css/rules/css-standards.md +492 -492
  12. package/augment-extensions/coding-standards/html/README.md +40 -40
  13. package/augment-extensions/coding-standards/html/examples/html-examples.html +267 -267
  14. package/augment-extensions/coding-standards/html/examples/responsive-layout.html +505 -505
  15. package/augment-extensions/coding-standards/html/module.json +44 -44
  16. package/augment-extensions/coding-standards/html/rules/html-standards.md +349 -349
  17. package/augment-extensions/coding-standards/html-css-js/README.md +194 -194
  18. package/augment-extensions/coding-standards/html-css-js/examples/async-examples.js +487 -487
  19. package/augment-extensions/coding-standards/html-css-js/examples/css-examples.css +550 -550
  20. package/augment-extensions/coding-standards/html-css-js/examples/dom-examples.js +667 -667
  21. package/augment-extensions/coding-standards/html-css-js/examples/html-examples.html +267 -267
  22. package/augment-extensions/coding-standards/html-css-js/examples/javascript-examples.js +612 -612
  23. package/augment-extensions/coding-standards/html-css-js/examples/responsive-layout.html +505 -505
  24. package/augment-extensions/coding-standards/html-css-js/module.json +48 -48
  25. package/augment-extensions/coding-standards/html-css-js/rules/async-patterns.md +515 -515
  26. package/augment-extensions/coding-standards/html-css-js/rules/css-modern-features.md +448 -448
  27. package/augment-extensions/coding-standards/html-css-js/rules/css-standards.md +492 -492
  28. package/augment-extensions/coding-standards/html-css-js/rules/dom-manipulation.md +439 -439
  29. package/augment-extensions/coding-standards/html-css-js/rules/html-standards.md +349 -349
  30. package/augment-extensions/coding-standards/html-css-js/rules/javascript-standards.md +486 -486
  31. package/augment-extensions/coding-standards/html-css-js/rules/performance.md +463 -463
  32. package/augment-extensions/coding-standards/html-css-js/rules/tooling.md +543 -543
  33. package/augment-extensions/coding-standards/js/README.md +46 -46
  34. package/augment-extensions/coding-standards/js/examples/async-examples.js +487 -487
  35. package/augment-extensions/coding-standards/js/examples/dom-examples.js +667 -667
  36. package/augment-extensions/coding-standards/js/examples/javascript-examples.js +612 -612
  37. package/augment-extensions/coding-standards/js/module.json +49 -49
  38. package/augment-extensions/coding-standards/js/rules/async-patterns.md +515 -515
  39. package/augment-extensions/coding-standards/js/rules/dom-manipulation.md +439 -439
  40. package/augment-extensions/coding-standards/js/rules/javascript-standards.md +486 -486
  41. package/augment-extensions/coding-standards/js/rules/performance.md +463 -463
  42. package/augment-extensions/coding-standards/js/rules/tooling.md +543 -543
  43. package/augment-extensions/coding-standards/php/README.md +248 -248
  44. package/augment-extensions/coding-standards/php/examples/api-endpoint-example.php +204 -204
  45. package/augment-extensions/coding-standards/php/examples/cli-command-example.php +206 -206
  46. package/augment-extensions/coding-standards/php/examples/legacy-refactoring-example.php +234 -234
  47. package/augment-extensions/coding-standards/php/examples/web-application-example.php +211 -211
  48. package/augment-extensions/coding-standards/php/examples/woocommerce-extension-example.php +215 -215
  49. package/augment-extensions/coding-standards/php/examples/wordpress-plugin-example.php +189 -189
  50. package/augment-extensions/coding-standards/php/module.json +166 -166
  51. package/augment-extensions/coding-standards/php/rules/api-development.md +480 -480
  52. package/augment-extensions/coding-standards/php/rules/category-configuration.md +332 -332
  53. package/augment-extensions/coding-standards/php/rules/cli-tools.md +472 -472
  54. package/augment-extensions/coding-standards/php/rules/cms-integration.md +561 -561
  55. package/augment-extensions/coding-standards/php/rules/code-quality.md +402 -402
  56. package/augment-extensions/coding-standards/php/rules/documentation.md +425 -425
  57. package/augment-extensions/coding-standards/php/rules/ecommerce.md +627 -627
  58. package/augment-extensions/coding-standards/php/rules/error-handling.md +336 -336
  59. package/augment-extensions/coding-standards/php/rules/legacy-migration.md +677 -677
  60. package/augment-extensions/coding-standards/php/rules/naming-conventions.md +279 -279
  61. package/augment-extensions/coding-standards/php/rules/performance.md +392 -392
  62. package/augment-extensions/coding-standards/php/rules/psr-standards.md +186 -186
  63. package/augment-extensions/coding-standards/php/rules/security.md +358 -358
  64. package/augment-extensions/coding-standards/php/rules/testing.md +403 -403
  65. package/augment-extensions/coding-standards/php/rules/type-declarations.md +331 -331
  66. package/augment-extensions/coding-standards/php/rules/web-applications.md +426 -426
  67. package/augment-extensions/coding-standards/powershell/README.md +154 -154
  68. package/augment-extensions/coding-standards/powershell/examples/admin-example.ps1 +272 -272
  69. package/augment-extensions/coding-standards/powershell/examples/automation-example.ps1 +173 -173
  70. package/augment-extensions/coding-standards/powershell/examples/cloud-example.ps1 +243 -243
  71. package/augment-extensions/coding-standards/powershell/examples/cross-platform-example.ps1 +297 -297
  72. package/augment-extensions/coding-standards/powershell/examples/dsc-example.ps1 +224 -224
  73. package/augment-extensions/coding-standards/powershell/examples/legacy-migration-example.ps1 +340 -340
  74. package/augment-extensions/coding-standards/powershell/examples/module-example.psm1 +255 -255
  75. package/augment-extensions/coding-standards/powershell/module.json +165 -165
  76. package/augment-extensions/coding-standards/powershell/rules/administrative-tools.md +439 -439
  77. package/augment-extensions/coding-standards/powershell/rules/automation-scripts.md +240 -240
  78. package/augment-extensions/coding-standards/powershell/rules/cloud-orchestration.md +384 -384
  79. package/augment-extensions/coding-standards/powershell/rules/configuration-schema.md +383 -383
  80. package/augment-extensions/coding-standards/powershell/rules/cross-platform-scripts.md +482 -482
  81. package/augment-extensions/coding-standards/powershell/rules/dsc-configurations.md +296 -296
  82. package/augment-extensions/coding-standards/powershell/rules/error-handling.md +314 -314
  83. package/augment-extensions/coding-standards/powershell/rules/legacy-migrations.md +466 -466
  84. package/augment-extensions/coding-standards/powershell/rules/modules-functions.md +244 -244
  85. package/augment-extensions/coding-standards/powershell/rules/naming-conventions.md +266 -266
  86. package/augment-extensions/coding-standards/powershell/rules/performance-optimization.md +209 -209
  87. package/augment-extensions/coding-standards/powershell/rules/security-practices.md +314 -314
  88. package/augment-extensions/coding-standards/powershell/rules/testing-guidelines.md +268 -268
  89. package/augment-extensions/coding-standards/powershell/rules/universal-standards.md +197 -197
  90. package/augment-extensions/coding-standards/python/README.md +48 -48
  91. package/augment-extensions/coding-standards/python/examples/best-practices.py +373 -373
  92. package/augment-extensions/coding-standards/python/module.json +30 -30
  93. package/augment-extensions/coding-standards/python/rules/async-patterns.md +884 -884
  94. package/augment-extensions/coding-standards/python/rules/best-practices.md +232 -232
  95. package/augment-extensions/coding-standards/python/rules/code-organization.md +220 -220
  96. package/augment-extensions/coding-standards/python/rules/documentation.md +831 -831
  97. package/augment-extensions/coding-standards/python/rules/error-handling.md +1008 -1008
  98. package/augment-extensions/coding-standards/python/rules/naming-conventions.md +172 -172
  99. package/augment-extensions/coding-standards/python/rules/testing.md +409 -409
  100. package/augment-extensions/coding-standards/python/rules/tooling.md +446 -446
  101. package/augment-extensions/coding-standards/python/rules/type-hints.md +253 -253
  102. package/augment-extensions/coding-standards/react/README.md +45 -45
  103. package/augment-extensions/coding-standards/react/module.json +27 -27
  104. package/augment-extensions/coding-standards/react/rules/component-patterns.md +214 -214
  105. package/augment-extensions/coding-standards/react/rules/hooks-best-practices.md +235 -235
  106. package/augment-extensions/coding-standards/react/rules/performance.md +300 -300
  107. package/augment-extensions/coding-standards/react/rules/state-management.md +265 -265
  108. package/augment-extensions/coding-standards/react/rules/typescript-react.md +271 -271
  109. package/augment-extensions/coding-standards/typescript/README.md +45 -45
  110. package/augment-extensions/coding-standards/typescript/module.json +27 -27
  111. package/augment-extensions/coding-standards/typescript/rules/naming-conventions.md +225 -225
  112. package/augment-extensions/collections/html-css-js/README.md +82 -82
  113. package/augment-extensions/collections/html-css-js/collection.json +41 -41
  114. package/augment-extensions/domain-rules/api-design/README.md +41 -41
  115. package/augment-extensions/domain-rules/api-design/module.json +27 -27
  116. package/augment-extensions/domain-rules/api-design/rules/authentication.md +263 -263
  117. package/augment-extensions/domain-rules/api-design/rules/documentation.md +395 -395
  118. package/augment-extensions/domain-rules/api-design/rules/error-handling.md +290 -290
  119. package/augment-extensions/domain-rules/api-design/rules/graphql-api.md +313 -313
  120. package/augment-extensions/domain-rules/api-design/rules/rest-api.md +214 -214
  121. package/augment-extensions/domain-rules/api-design/rules/versioning.md +268 -268
  122. package/augment-extensions/domain-rules/database/README.md +161 -161
  123. package/augment-extensions/domain-rules/database/examples/flat-database-example.md +793 -793
  124. package/augment-extensions/domain-rules/database/examples/hybrid-database-example.md +1132 -1132
  125. package/augment-extensions/domain-rules/database/examples/nosql-document-example.md +868 -868
  126. package/augment-extensions/domain-rules/database/examples/nosql-graph-example.md +805 -805
  127. package/augment-extensions/domain-rules/database/examples/relational-schema-example.md +621 -621
  128. package/augment-extensions/domain-rules/database/examples/vector-database-example.md +965 -965
  129. package/augment-extensions/domain-rules/database/module.json +28 -28
  130. package/augment-extensions/domain-rules/database/rules/flat-databases.md +624 -624
  131. package/augment-extensions/domain-rules/database/rules/nosql-databases.md +588 -588
  132. package/augment-extensions/domain-rules/database/rules/nosql-document-stores.md +856 -856
  133. package/augment-extensions/domain-rules/database/rules/nosql-graph-databases.md +778 -778
  134. package/augment-extensions/domain-rules/database/rules/nosql-key-value-stores.md +963 -963
  135. package/augment-extensions/domain-rules/database/rules/performance-optimization.md +1076 -1076
  136. package/augment-extensions/domain-rules/database/rules/relational-databases.md +697 -697
  137. package/augment-extensions/domain-rules/database/rules/relational-indexing.md +671 -671
  138. package/augment-extensions/domain-rules/database/rules/relational-query-optimization.md +607 -607
  139. package/augment-extensions/domain-rules/database/rules/relational-schema-design.md +907 -907
  140. package/augment-extensions/domain-rules/database/rules/relational-transactions.md +783 -783
  141. package/augment-extensions/domain-rules/database/rules/security-standards.md +980 -980
  142. package/augment-extensions/domain-rules/database/rules/universal-best-practices.md +485 -485
  143. package/augment-extensions/domain-rules/database/rules/vector-databases.md +521 -521
  144. package/augment-extensions/domain-rules/database/rules/vector-embeddings.md +858 -858
  145. package/augment-extensions/domain-rules/database/rules/vector-indexing.md +934 -934
  146. package/augment-extensions/domain-rules/design/color/themes/catppuccin-latte/README.md +23 -23
  147. package/augment-extensions/domain-rules/design/color/themes/catppuccin-latte/module.json +26 -26
  148. package/augment-extensions/domain-rules/design/color/themes/catppuccin-mocha/README.md +23 -23
  149. package/augment-extensions/domain-rules/design/color/themes/catppuccin-mocha/module.json +26 -26
  150. package/augment-extensions/domain-rules/design/color/themes/dracula/README.md +23 -23
  151. package/augment-extensions/domain-rules/design/color/themes/dracula/module.json +26 -26
  152. package/augment-extensions/domain-rules/design/color/themes/gruvbox-dark/README.md +23 -23
  153. package/augment-extensions/domain-rules/design/color/themes/gruvbox-dark/module.json +26 -26
  154. package/augment-extensions/domain-rules/design/color/themes/gruvbox-light/README.md +23 -23
  155. package/augment-extensions/domain-rules/design/color/themes/gruvbox-light/module.json +26 -26
  156. package/augment-extensions/domain-rules/design/color/themes/high-contrast/README.md +27 -27
  157. package/augment-extensions/domain-rules/design/color/themes/high-contrast/module.json +26 -26
  158. package/augment-extensions/domain-rules/design/color/themes/monokai/README.md +23 -23
  159. package/augment-extensions/domain-rules/design/color/themes/monokai/module.json +26 -26
  160. package/augment-extensions/domain-rules/design/color/themes/nord/README.md +23 -23
  161. package/augment-extensions/domain-rules/design/color/themes/nord/module.json +26 -26
  162. package/augment-extensions/domain-rules/design/color/themes/one-dark/README.md +23 -23
  163. package/augment-extensions/domain-rules/design/color/themes/one-dark/module.json +26 -26
  164. package/augment-extensions/domain-rules/design/color/themes/one-light/README.md +23 -23
  165. package/augment-extensions/domain-rules/design/color/themes/one-light/module.json +26 -26
  166. package/augment-extensions/domain-rules/design/color/themes/solarized-dark/README.md +23 -23
  167. package/augment-extensions/domain-rules/design/color/themes/solarized-dark/module.json +26 -26
  168. package/augment-extensions/domain-rules/design/color/themes/solarized-light/README.md +23 -23
  169. package/augment-extensions/domain-rules/design/color/themes/solarized-light/module.json +26 -26
  170. package/augment-extensions/domain-rules/design/color/themes/tokyo-night/README.md +23 -23
  171. package/augment-extensions/domain-rules/design/color/themes/tokyo-night/module.json +26 -26
  172. package/augment-extensions/domain-rules/mcp/README.md +150 -150
  173. package/augment-extensions/domain-rules/mcp/examples/compressed-example.md +522 -522
  174. package/augment-extensions/domain-rules/mcp/examples/graph-augmented-example.md +520 -520
  175. package/augment-extensions/domain-rules/mcp/examples/hybrid-example.md +570 -570
  176. package/augment-extensions/domain-rules/mcp/examples/state-based-example.md +427 -427
  177. package/augment-extensions/domain-rules/mcp/examples/token-based-example.md +435 -435
  178. package/augment-extensions/domain-rules/mcp/examples/vector-based-example.md +502 -502
  179. package/augment-extensions/domain-rules/mcp/module.json +49 -49
  180. package/augment-extensions/domain-rules/mcp/rules/compressed-mcp.md +595 -595
  181. package/augment-extensions/domain-rules/mcp/rules/configuration.md +345 -345
  182. package/augment-extensions/domain-rules/mcp/rules/graph-augmented-mcp.md +687 -687
  183. package/augment-extensions/domain-rules/mcp/rules/hybrid-mcp.md +636 -636
  184. package/augment-extensions/domain-rules/mcp/rules/state-based-mcp.md +484 -484
  185. package/augment-extensions/domain-rules/mcp/rules/testing-validation.md +360 -360
  186. package/augment-extensions/domain-rules/mcp/rules/token-based-mcp.md +393 -393
  187. package/augment-extensions/domain-rules/mcp/rules/universal-rules.md +194 -194
  188. package/augment-extensions/domain-rules/mcp/rules/vector-based-mcp.md +625 -625
  189. package/augment-extensions/domain-rules/security/README.md +41 -41
  190. package/augment-extensions/domain-rules/security/module.json +28 -28
  191. package/augment-extensions/domain-rules/security/rules/authentication-security.md +361 -361
  192. package/augment-extensions/domain-rules/security/rules/encryption.md +208 -208
  193. package/augment-extensions/domain-rules/security/rules/input-validation.md +294 -294
  194. package/augment-extensions/domain-rules/security/rules/owasp-top-10.md +339 -339
  195. package/augment-extensions/domain-rules/security/rules/secure-coding.md +293 -293
  196. package/augment-extensions/domain-rules/security/rules/web-security.md +268 -268
  197. package/augment-extensions/domain-rules/seo-sales-marketing/ANNOUNCEMENT.md +143 -0
  198. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/README.md +140 -136
  199. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/SCHEMA-VALIDATION-REPORT.md +216 -216
  200. package/augment-extensions/domain-rules/seo-sales-marketing/TEST-VALIDATION.md +129 -0
  201. package/augment-extensions/domain-rules/seo-sales-marketing/USAGE-GUIDES.md +254 -0
  202. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/brand-kit-example.yaml +292 -292
  203. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/campaign-brief-example.yaml +389 -389
  204. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/content-calendar-example.yaml +643 -643
  205. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/email-newsletter-example.md +376 -376
  206. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/landing-page-example.md +934 -934
  207. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/ppc-ad-copy-example.md +301 -301
  208. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/seo-blog-post-example.md +347 -347
  209. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/examples/social-media-campaign-example.md +606 -606
  210. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/module.json +50 -50
  211. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/affiliate-influencer-marketing.md +593 -593
  212. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/asset-management.md +418 -418
  213. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/brand-consistency.md +210 -210
  214. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/content-marketing.md +337 -337
  215. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/conversion-optimization.md +455 -455
  216. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/direct-sales.md +499 -499
  217. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/email-marketing.md +439 -439
  218. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/legal-compliance.md +227 -227
  219. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/ppc-advertising.md +569 -569
  220. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/seo-optimization.md +470 -470
  221. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/social-media-marketing.md +414 -414
  222. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/rules/universal-marketing.md +177 -177
  223. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/asset-inventory.schema.json +247 -247
  224. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/brand-kit.schema.json +326 -326
  225. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/campaign-brief.schema.json +342 -342
  226. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/color-palette.schema.json +223 -223
  227. package/augment-extensions/domain-rules/{marketing-standards/seo-sales-marketing → seo-sales-marketing}/schemas/content-template.schema.json +383 -383
  228. package/augment-extensions/domain-rules/wordpress/README.md +163 -163
  229. package/augment-extensions/domain-rules/wordpress/module.json +32 -32
  230. package/augment-extensions/domain-rules/wordpress/rules/coding-standards.md +617 -617
  231. package/augment-extensions/domain-rules/wordpress/rules/directory-structure.md +270 -270
  232. package/augment-extensions/domain-rules/wordpress/rules/file-patterns.md +423 -423
  233. package/augment-extensions/domain-rules/wordpress/rules/gutenberg-blocks.md +493 -493
  234. package/augment-extensions/domain-rules/wordpress/rules/performance.md +568 -568
  235. package/augment-extensions/domain-rules/wordpress/rules/plugin-development.md +510 -510
  236. package/augment-extensions/domain-rules/wordpress/rules/project-detection.md +251 -251
  237. package/augment-extensions/domain-rules/wordpress/rules/rest-api.md +501 -501
  238. package/augment-extensions/domain-rules/wordpress/rules/security.md +564 -564
  239. package/augment-extensions/domain-rules/wordpress/rules/theme-development.md +388 -388
  240. package/augment-extensions/domain-rules/wordpress/rules/woocommerce.md +441 -441
  241. package/augment-extensions/domain-rules/wordpress-plugin/README.md +139 -139
  242. package/augment-extensions/domain-rules/wordpress-plugin/examples/ajax-plugin.md +1599 -1599
  243. package/augment-extensions/domain-rules/wordpress-plugin/examples/custom-post-type-plugin.md +1727 -1727
  244. package/augment-extensions/domain-rules/wordpress-plugin/examples/gutenberg-block-plugin.md +428 -428
  245. package/augment-extensions/domain-rules/wordpress-plugin/examples/gutenberg-block.md +422 -422
  246. package/augment-extensions/domain-rules/wordpress-plugin/examples/mvc-plugin.md +1623 -1623
  247. package/augment-extensions/domain-rules/wordpress-plugin/examples/object-oriented-plugin.md +1343 -1343
  248. package/augment-extensions/domain-rules/wordpress-plugin/examples/rest-endpoint.md +734 -734
  249. package/augment-extensions/domain-rules/wordpress-plugin/examples/settings-page-plugin.md +1350 -1350
  250. package/augment-extensions/domain-rules/wordpress-plugin/examples/simple-procedural-plugin.md +503 -503
  251. package/augment-extensions/domain-rules/wordpress-plugin/examples/singleton-plugin.md +971 -971
  252. package/augment-extensions/domain-rules/wordpress-plugin/module.json +53 -53
  253. package/augment-extensions/domain-rules/wordpress-plugin/rules/activation-hooks.md +770 -770
  254. package/augment-extensions/domain-rules/wordpress-plugin/rules/admin-interface.md +874 -874
  255. package/augment-extensions/domain-rules/wordpress-plugin/rules/ajax-handlers.md +629 -629
  256. package/augment-extensions/domain-rules/wordpress-plugin/rules/asset-management.md +559 -559
  257. package/augment-extensions/domain-rules/wordpress-plugin/rules/context-providers.md +709 -709
  258. package/augment-extensions/domain-rules/wordpress-plugin/rules/cron-jobs.md +736 -736
  259. package/augment-extensions/domain-rules/wordpress-plugin/rules/database-management.md +1057 -1057
  260. package/augment-extensions/domain-rules/wordpress-plugin/rules/documentation-standards.md +463 -463
  261. package/augment-extensions/domain-rules/wordpress-plugin/rules/frontend-functionality.md +478 -478
  262. package/augment-extensions/domain-rules/wordpress-plugin/rules/gutenberg-blocks.md +818 -818
  263. package/augment-extensions/domain-rules/wordpress-plugin/rules/internationalization.md +416 -416
  264. package/augment-extensions/domain-rules/wordpress-plugin/rules/migration.md +667 -667
  265. package/augment-extensions/domain-rules/wordpress-plugin/rules/performance-optimization.md +878 -878
  266. package/augment-extensions/domain-rules/wordpress-plugin/rules/plugin-architecture.md +693 -693
  267. package/augment-extensions/domain-rules/wordpress-plugin/rules/plugin-structure.md +352 -352
  268. package/augment-extensions/domain-rules/wordpress-plugin/rules/rest-api.md +818 -818
  269. package/augment-extensions/domain-rules/wordpress-plugin/rules/scaffolding-workflow.md +624 -624
  270. package/augment-extensions/domain-rules/wordpress-plugin/rules/security-best-practices.md +866 -866
  271. package/augment-extensions/domain-rules/wordpress-plugin/rules/testing-patterns.md +1165 -1165
  272. package/augment-extensions/domain-rules/wordpress-plugin/rules/testing.md +414 -414
  273. package/augment-extensions/domain-rules/wordpress-plugin/rules/vscode-integration.md +751 -751
  274. package/augment-extensions/domain-rules/wordpress-plugin/rules/woocommerce-integration.md +949 -949
  275. package/augment-extensions/domain-rules/wordpress-plugin/rules/wordpress-org-submission.md +458 -458
  276. package/augment-extensions/examples/design-patterns/README.md +37 -37
  277. package/augment-extensions/examples/design-patterns/examples/behavioral-patterns.md +370 -370
  278. package/augment-extensions/examples/design-patterns/examples/creational-patterns.md +250 -250
  279. package/augment-extensions/examples/design-patterns/examples/structural-patterns.md +264 -264
  280. package/augment-extensions/examples/design-patterns/module.json +27 -27
  281. package/augment-extensions/examples/gutenberg-block-plugin/README.md +101 -101
  282. package/augment-extensions/examples/gutenberg-block-plugin/examples/testimonial-block.md +428 -428
  283. package/augment-extensions/examples/gutenberg-block-plugin/module.json +40 -40
  284. package/augment-extensions/examples/rest-api-plugin/README.md +98 -98
  285. package/augment-extensions/examples/rest-api-plugin/examples/task-manager-api.md +1299 -1299
  286. package/augment-extensions/examples/rest-api-plugin/module.json +40 -40
  287. package/augment-extensions/examples/woocommerce-extension/README.md +98 -98
  288. package/augment-extensions/examples/woocommerce-extension/examples/product-customizer.md +763 -763
  289. package/augment-extensions/examples/woocommerce-extension/module.json +40 -40
  290. package/augment-extensions/workflows/beads/README.md +135 -135
  291. package/augment-extensions/workflows/beads/examples/complete-workflow-example.md +278 -278
  292. package/augment-extensions/workflows/beads/module.json +55 -55
  293. package/augment-extensions/workflows/beads/rules/best-practices.md +398 -398
  294. package/augment-extensions/workflows/beads/rules/file-format.md +327 -327
  295. package/augment-extensions/workflows/beads/rules/manual-setup.md +315 -315
  296. package/augment-extensions/workflows/beads/rules/workflow.md +326 -326
  297. package/augment-extensions/workflows/beads-integration/IMPLEMENTATION-STATUS.md +145 -145
  298. package/augment-extensions/workflows/beads-integration/README.md +143 -143
  299. package/augment-extensions/workflows/beads-integration/config/defaults.json +32 -32
  300. package/augment-extensions/workflows/beads-integration/config/schema.json +140 -140
  301. package/augment-extensions/workflows/beads-integration/examples/basic-task-generation.md +293 -293
  302. package/augment-extensions/workflows/beads-integration/module.json +75 -75
  303. package/augment-extensions/workflows/beads-integration/rules/core-rules.md +219 -219
  304. package/augment-extensions/workflows/beads-integration/rules/effectiveness-standards.md +256 -256
  305. package/augment-extensions/workflows/beads-integration/rules/task-generation.md +607 -607
  306. package/augment-extensions/workflows/database/README.md +195 -195
  307. package/augment-extensions/workflows/database/ai-prompt-testing.md +295 -295
  308. package/augment-extensions/workflows/database/examples/migration-example.md +498 -498
  309. package/augment-extensions/workflows/database/examples/optimization-example.md +496 -496
  310. package/augment-extensions/workflows/database/examples/schema-design-example.md +444 -444
  311. package/augment-extensions/workflows/database/module.json +42 -42
  312. package/augment-extensions/workflows/database/rules/data-migration.md +249 -249
  313. package/augment-extensions/workflows/database/rules/documentation-standards.md +339 -339
  314. package/augment-extensions/workflows/database/rules/migration-workflow.md +352 -352
  315. package/augment-extensions/workflows/database/rules/optimization-workflow.md +435 -435
  316. package/augment-extensions/workflows/database/rules/schema-design-workflow.md +535 -535
  317. package/augment-extensions/workflows/database/rules/testing-patterns.md +305 -305
  318. package/augment-extensions/workflows/database/rules/workflow.md +458 -458
  319. package/augment-extensions/workflows/wordpress-plugin/README.md +232 -232
  320. package/augment-extensions/workflows/wordpress-plugin/ai-prompts.md +839 -839
  321. package/augment-extensions/workflows/wordpress-plugin/bead-decomposition-patterns.md +854 -854
  322. package/augment-extensions/workflows/wordpress-plugin/examples/complete-plugin-example.md +540 -540
  323. package/augment-extensions/workflows/wordpress-plugin/examples/custom-post-type-example.md +1083 -1083
  324. package/augment-extensions/workflows/wordpress-plugin/examples/feature-addition-workflow.md +669 -669
  325. package/augment-extensions/workflows/wordpress-plugin/examples/plugin-creation-workflow.md +597 -597
  326. package/augment-extensions/workflows/wordpress-plugin/examples/secure-form-handler-example.md +925 -925
  327. package/augment-extensions/workflows/wordpress-plugin/examples/security-audit-workflow.md +752 -752
  328. package/augment-extensions/workflows/wordpress-plugin/examples/wordpress-org-submission-workflow.md +773 -773
  329. package/augment-extensions/workflows/wordpress-plugin/module.json +49 -49
  330. package/augment-extensions/workflows/wordpress-plugin/rules/best-practices.md +942 -942
  331. package/augment-extensions/workflows/wordpress-plugin/rules/development-workflow.md +702 -702
  332. package/augment-extensions/workflows/wordpress-plugin/rules/submission-workflow.md +728 -728
  333. package/augment-extensions/workflows/wordpress-plugin/rules/testing-workflow.md +775 -775
  334. package/augment-extensions/writing-standards/screenplay/README.md +339 -300
  335. package/augment-extensions/writing-standards/screenplay/_templates/README.md +121 -121
  336. package/augment-extensions/writing-standards/screenplay/_templates/genre-template.md +153 -153
  337. package/augment-extensions/writing-standards/screenplay/_templates/style-template.md +243 -243
  338. package/augment-extensions/writing-standards/screenplay/_templates/theme-template.md +213 -213
  339. package/augment-extensions/writing-standards/screenplay/examples/aaa-hollywood-scene.fountain +164 -164
  340. package/augment-extensions/writing-standards/screenplay/examples/beat-sheet-example.yaml +95 -95
  341. package/augment-extensions/writing-standards/screenplay/examples/character-profile-example.yaml +116 -116
  342. package/augment-extensions/writing-standards/screenplay/examples/commercial-30sec.fountain +151 -151
  343. package/augment-extensions/writing-standards/screenplay/examples/independent-monologue.fountain +67 -67
  344. package/augment-extensions/writing-standards/screenplay/examples/news-segment.fountain +142 -142
  345. package/augment-extensions/writing-standards/screenplay/examples/plot-outline-example.yaml +184 -184
  346. package/augment-extensions/writing-standards/screenplay/examples/tv-episode-teaser.fountain +204 -204
  347. package/augment-extensions/writing-standards/screenplay/genres/README.md +181 -181
  348. package/augment-extensions/writing-standards/screenplay/genres/examples/.gitkeep +2 -2
  349. package/augment-extensions/writing-standards/screenplay/genres/module.json +70 -70
  350. package/augment-extensions/writing-standards/screenplay/genres/rules/.gitkeep +2 -2
  351. package/augment-extensions/writing-standards/screenplay/genres/rules/action.md +399 -399
  352. package/augment-extensions/writing-standards/screenplay/genres/rules/adventure.md +407 -407
  353. package/augment-extensions/writing-standards/screenplay/genres/rules/animation.md +293 -293
  354. package/augment-extensions/writing-standards/screenplay/genres/rules/biographical.md +293 -293
  355. package/augment-extensions/writing-standards/screenplay/genres/rules/comedy.md +401 -401
  356. package/augment-extensions/writing-standards/screenplay/genres/rules/documentary.md +293 -293
  357. package/augment-extensions/writing-standards/screenplay/genres/rules/drama.md +409 -409
  358. package/augment-extensions/writing-standards/screenplay/genres/rules/fantasy.md +293 -293
  359. package/augment-extensions/writing-standards/screenplay/genres/rules/historical.md +293 -293
  360. package/augment-extensions/writing-standards/screenplay/genres/rules/horror.md +268 -268
  361. package/augment-extensions/writing-standards/screenplay/genres/rules/musical.md +294 -294
  362. package/augment-extensions/writing-standards/screenplay/genres/rules/mystery.md +293 -293
  363. package/augment-extensions/writing-standards/screenplay/genres/rules/noir.md +294 -294
  364. package/augment-extensions/writing-standards/screenplay/genres/rules/romance.md +293 -293
  365. package/augment-extensions/writing-standards/screenplay/genres/rules/sci-fi.md +289 -289
  366. package/augment-extensions/writing-standards/screenplay/genres/rules/superhero.md +293 -293
  367. package/augment-extensions/writing-standards/screenplay/genres/rules/thriller.md +294 -294
  368. package/augment-extensions/writing-standards/screenplay/genres/rules/western.md +293 -293
  369. package/augment-extensions/writing-standards/screenplay/module.json +124 -124
  370. package/augment-extensions/writing-standards/screenplay/rules/aaa-hollywood-films.md +339 -339
  371. package/augment-extensions/writing-standards/screenplay/rules/ai-integration-testing.md +329 -329
  372. package/augment-extensions/writing-standards/screenplay/rules/character-development.md +169 -169
  373. package/augment-extensions/writing-standards/screenplay/rules/commercials.md +437 -437
  374. package/augment-extensions/writing-standards/screenplay/rules/dialogue-writing.md +263 -263
  375. package/augment-extensions/writing-standards/screenplay/rules/diversity-inclusion.md +261 -261
  376. package/augment-extensions/writing-standards/screenplay/rules/examples-guide.md +315 -315
  377. package/augment-extensions/writing-standards/screenplay/rules/file-organization.md +213 -0
  378. package/augment-extensions/writing-standards/screenplay/rules/formatting-validation.md +413 -413
  379. package/augment-extensions/writing-standards/screenplay/rules/fountain-format.md +372 -372
  380. package/augment-extensions/writing-standards/screenplay/rules/independent-films.md +374 -374
  381. package/augment-extensions/writing-standards/screenplay/rules/live-tv-productions.md +443 -443
  382. package/augment-extensions/writing-standards/screenplay/rules/narrative-structures.md +207 -207
  383. package/augment-extensions/writing-standards/screenplay/rules/news-broadcasts.md +444 -444
  384. package/augment-extensions/writing-standards/screenplay/rules/pacing-timing.md +331 -331
  385. package/augment-extensions/writing-standards/screenplay/rules/quality-review-checklist.md +334 -334
  386. package/augment-extensions/writing-standards/screenplay/rules/quick-reference.md +299 -299
  387. package/augment-extensions/writing-standards/screenplay/rules/screen-continuity.md +263 -263
  388. package/augment-extensions/writing-standards/screenplay/rules/streaming-content.md +412 -412
  389. package/augment-extensions/writing-standards/screenplay/rules/trope-management.md +370 -370
  390. package/augment-extensions/writing-standards/screenplay/rules/tv-series.md +374 -374
  391. package/augment-extensions/writing-standards/screenplay/rules/universal-formatting.md +339 -339
  392. package/augment-extensions/writing-standards/screenplay/rules/vscode-integration.md +277 -277
  393. package/augment-extensions/writing-standards/screenplay/rules/web-content.md +393 -393
  394. package/augment-extensions/writing-standards/screenplay/schemas/beat-sheet.json +332 -332
  395. package/augment-extensions/writing-standards/screenplay/schemas/character-profile.json +247 -247
  396. package/augment-extensions/writing-standards/screenplay/schemas/feature-selection.json +200 -200
  397. package/augment-extensions/writing-standards/screenplay/schemas/plot-outline.json +233 -233
  398. package/augment-extensions/writing-standards/screenplay/schemas/screenplay-config.json +245 -245
  399. package/augment-extensions/writing-standards/screenplay/schemas/trope-inventory.json +221 -221
  400. package/augment-extensions/writing-standards/screenplay/styles/README.md +159 -159
  401. package/augment-extensions/writing-standards/screenplay/styles/examples/.gitkeep +2 -2
  402. package/augment-extensions/writing-standards/screenplay/styles/examples/style-applications.md +1449 -1449
  403. package/augment-extensions/writing-standards/screenplay/styles/module.json +64 -64
  404. package/augment-extensions/writing-standards/screenplay/styles/rules/.gitkeep +2 -2
  405. package/augment-extensions/writing-standards/screenplay/styles/rules/dialogue-centric.md +520 -520
  406. package/augment-extensions/writing-standards/screenplay/styles/rules/ensemble.md +499 -499
  407. package/augment-extensions/writing-standards/screenplay/styles/rules/epic.md +497 -497
  408. package/augment-extensions/writing-standards/screenplay/styles/rules/experimental.md +492 -492
  409. package/augment-extensions/writing-standards/screenplay/styles/rules/flashback.md +509 -509
  410. package/augment-extensions/writing-standards/screenplay/styles/rules/linear.md +490 -490
  411. package/augment-extensions/writing-standards/screenplay/styles/rules/minimalist.md +499 -499
  412. package/augment-extensions/writing-standards/screenplay/styles/rules/non-linear.md +501 -501
  413. package/augment-extensions/writing-standards/screenplay/styles/rules/poetic.md +499 -499
  414. package/augment-extensions/writing-standards/screenplay/styles/rules/realistic.md +498 -498
  415. package/augment-extensions/writing-standards/screenplay/styles/rules/satirical.md +499 -499
  416. package/augment-extensions/writing-standards/screenplay/styles/rules/surreal.md +508 -508
  417. package/augment-extensions/writing-standards/screenplay/styles/rules/voice-over.md +500 -500
  418. package/augment-extensions/writing-standards/screenplay/themes/README.md +158 -158
  419. package/augment-extensions/writing-standards/screenplay/themes/examples/.gitkeep +2 -2
  420. package/augment-extensions/writing-standards/screenplay/themes/examples/common-mistakes-and-fixes.md +643 -643
  421. package/augment-extensions/writing-standards/screenplay/themes/examples/complete-scene-example.md +311 -311
  422. package/augment-extensions/writing-standards/screenplay/themes/examples/individual-theme-examples.md +562 -562
  423. package/augment-extensions/writing-standards/screenplay/themes/examples/multi-theme-weaving.md +538 -538
  424. package/augment-extensions/writing-standards/screenplay/themes/examples/theme-application-guide.md +432 -432
  425. package/augment-extensions/writing-standards/screenplay/themes/examples/theme-integration-across-acts.md +637 -637
  426. package/augment-extensions/writing-standards/screenplay/themes/module.json +66 -66
  427. package/augment-extensions/writing-standards/screenplay/themes/rules/.gitkeep +2 -2
  428. package/augment-extensions/writing-standards/screenplay/themes/rules/ambition.md +458 -458
  429. package/augment-extensions/writing-standards/screenplay/themes/rules/betrayal.md +490 -490
  430. package/augment-extensions/writing-standards/screenplay/themes/rules/environment.md +458 -458
  431. package/augment-extensions/writing-standards/screenplay/themes/rules/fate.md +459 -459
  432. package/augment-extensions/writing-standards/screenplay/themes/rules/friendship.md +491 -491
  433. package/augment-extensions/writing-standards/screenplay/themes/rules/growth.md +491 -491
  434. package/augment-extensions/writing-standards/screenplay/themes/rules/identity.md +490 -490
  435. package/augment-extensions/writing-standards/screenplay/themes/rules/isolation.md +464 -464
  436. package/augment-extensions/writing-standards/screenplay/themes/rules/justice.md +461 -461
  437. package/augment-extensions/writing-standards/screenplay/themes/rules/love.md +489 -489
  438. package/augment-extensions/writing-standards/screenplay/themes/rules/power.md +494 -494
  439. package/augment-extensions/writing-standards/screenplay/themes/rules/redemption.md +483 -483
  440. package/augment-extensions/writing-standards/screenplay/themes/rules/revenge.md +489 -489
  441. package/augment-extensions/writing-standards/screenplay/themes/rules/survival.md +496 -496
  442. package/augment-extensions/writing-standards/screenplay/themes/rules/technology.md +463 -463
  443. package/augment-extensions/writing-standards/screenplay/utils/__tests__/file-organization.test.ts +169 -0
  444. package/augment-extensions/writing-standards/screenplay/utils/file-organization.ts +165 -0
  445. package/cli/MODULES.md +302 -302
  446. package/cli/dist/cli.js +113 -22
  447. package/cli/dist/cli.js.map +1 -1
  448. package/cli/dist/commands/gui.d.ts.map +1 -1
  449. package/cli/dist/commands/gui.js +54 -6
  450. package/cli/dist/commands/gui.js.map +1 -1
  451. package/cli/dist/commands/init.d.ts.map +1 -1
  452. package/cli/dist/commands/init.js +76 -23
  453. package/cli/dist/commands/init.js.map +1 -1
  454. package/cli/dist/commands/self-remove.d.ts.map +1 -1
  455. package/cli/dist/commands/self-remove.js +48 -74
  456. package/cli/dist/commands/self-remove.js.map +1 -1
  457. package/cli/dist/commands/show.d.ts +15 -0
  458. package/cli/dist/commands/show.d.ts.map +1 -1
  459. package/cli/dist/commands/show.js +576 -23
  460. package/cli/dist/commands/show.js.map +1 -1
  461. package/cli/dist/commands/showCompleted.d.ts +21 -0
  462. package/cli/dist/commands/showCompleted.d.ts.map +1 -0
  463. package/cli/dist/commands/showCompleted.js +225 -0
  464. package/cli/dist/commands/showCompleted.js.map +1 -0
  465. package/cli/dist/commands/skill.js +88 -88
  466. package/cli/dist/commands/update.d.ts +2 -0
  467. package/cli/dist/commands/update.d.ts.map +1 -1
  468. package/cli/dist/commands/update.js +67 -1
  469. package/cli/dist/commands/update.js.map +1 -1
  470. package/cli/dist/utils/beadsCompletedChecker.d.ts +72 -0
  471. package/cli/dist/utils/beadsCompletedChecker.d.ts.map +1 -0
  472. package/cli/dist/utils/beadsCompletedChecker.js +198 -0
  473. package/cli/dist/utils/beadsCompletedChecker.js.map +1 -0
  474. package/cli/dist/utils/catalog-sync.js +13 -13
  475. package/cli/dist/utils/config-system.d.ts +111 -0
  476. package/cli/dist/utils/config-system.d.ts.map +1 -0
  477. package/cli/dist/utils/config-system.js +239 -0
  478. package/cli/dist/utils/config-system.js.map +1 -0
  479. package/cli/dist/utils/extractCommandHelp.d.ts +51 -0
  480. package/cli/dist/utils/extractCommandHelp.d.ts.map +1 -0
  481. package/cli/dist/utils/extractCommandHelp.js +250 -0
  482. package/cli/dist/utils/extractCommandHelp.js.map +1 -0
  483. package/cli/dist/utils/hook-system.d.ts +84 -0
  484. package/cli/dist/utils/hook-system.d.ts.map +1 -0
  485. package/cli/dist/utils/hook-system.js +151 -0
  486. package/cli/dist/utils/hook-system.js.map +1 -0
  487. package/cli/dist/utils/inspection-cache.d.ts +56 -0
  488. package/cli/dist/utils/inspection-cache.d.ts.map +1 -0
  489. package/cli/dist/utils/inspection-cache.js +166 -0
  490. package/cli/dist/utils/inspection-cache.js.map +1 -0
  491. package/cli/dist/utils/inspection-handlers.d.ts +75 -0
  492. package/cli/dist/utils/inspection-handlers.d.ts.map +1 -0
  493. package/cli/dist/utils/inspection-handlers.js +171 -0
  494. package/cli/dist/utils/inspection-handlers.js.map +1 -0
  495. package/cli/dist/utils/install-rules.js +55 -55
  496. package/cli/dist/utils/mcp-integration.js +44 -44
  497. package/cli/dist/utils/module-system.d.ts +1 -0
  498. package/cli/dist/utils/module-system.d.ts.map +1 -1
  499. package/cli/dist/utils/module-system.js +8 -3
  500. package/cli/dist/utils/module-system.js.map +1 -1
  501. package/cli/dist/utils/plugin-system.d.ts +133 -0
  502. package/cli/dist/utils/plugin-system.d.ts.map +1 -0
  503. package/cli/dist/utils/plugin-system.js +210 -0
  504. package/cli/dist/utils/plugin-system.js.map +1 -0
  505. package/cli/dist/utils/progress.d.ts +67 -0
  506. package/cli/dist/utils/progress.d.ts.map +1 -0
  507. package/cli/dist/utils/progress.js +146 -0
  508. package/cli/dist/utils/progress.js.map +1 -0
  509. package/cli/dist/utils/rule-install-hooks.js +8 -8
  510. package/cli/dist/utils/stream-reader.d.ts +34 -0
  511. package/cli/dist/utils/stream-reader.d.ts.map +1 -0
  512. package/cli/dist/utils/stream-reader.js +147 -0
  513. package/cli/dist/utils/stream-reader.js.map +1 -0
  514. package/cli/dist/utils/vscode-editor.d.ts +45 -0
  515. package/cli/dist/utils/vscode-editor.d.ts.map +1 -0
  516. package/cli/dist/utils/vscode-editor.js +171 -0
  517. package/cli/dist/utils/vscode-editor.js.map +1 -0
  518. package/cli/dist/utils/vscode-links.d.ts +49 -0
  519. package/cli/dist/utils/vscode-links.d.ts.map +1 -0
  520. package/cli/dist/utils/vscode-links.js +167 -0
  521. package/cli/dist/utils/vscode-links.js.map +1 -0
  522. package/modules.md +667 -630
  523. package/package.json +85 -85
@@ -1,934 +1,934 @@
1
- # Vector Indexing
2
-
3
- ## Overview
4
-
5
- This document covers vector indexing fundamentals, including index types (HNSW, IVF, Flat, LSH), index parameters (ef_construction, M, nlist, nprobe), index selection criteria, index building strategies, index maintenance, performance tuning, and accuracy vs speed tradeoffs.
6
-
7
- ---
8
-
9
- ## What is Vector Indexing?
10
-
11
- ### Definition
12
-
13
- **Vector Index**: Data structure optimized for fast similarity search in high-dimensional vector spaces
14
-
15
- **Key Concepts:**
16
- - Enables fast approximate nearest neighbor (ANN) search
17
- - Trade-off between accuracy and speed
18
- - Different index types for different use cases
19
- - Critical for large-scale vector databases (>100k vectors)
20
-
21
- **Why Indexing Matters:**
22
- - **Without index**: Linear scan (O(n)) - slow for large datasets
23
- - **With index**: Sublinear search (O(log n) or better) - fast even for billions of vectors
24
-
25
- **Example:**
26
- ```
27
- Dataset: 1 million vectors (1536 dimensions)
28
- Linear scan: ~1000ms per query
29
- HNSW index: ~10ms per query (100x faster!)
30
- ```
31
-
32
- ---
33
-
34
- ## Index Types
35
-
36
- ### 1. HNSW (Hierarchical Navigable Small World)
37
-
38
- **Overview:**
39
- - Graph-based index
40
- - Best accuracy/speed trade-off
41
- - Most popular for production systems
42
- - Used by: Pinecone, Weaviate, Qdrant, Milvus
43
-
44
- **How it works:**
45
- - Builds multi-layer graph of vectors
46
- - Each layer has different connectivity
47
- - Search starts at top layer, navigates down
48
- - Finds approximate nearest neighbors efficiently
49
-
50
- **Pros:**
51
- - ✅ Excellent accuracy (>95% recall)
52
- - ✅ Fast search (milliseconds)
53
- - ✅ Good for high-dimensional data
54
- - ✅ Incremental updates supported
55
-
56
- **Cons:**
57
- - ❌ High memory usage (stores full graph)
58
- - ❌ Slower index building
59
- - ❌ Not ideal for very large datasets (>100M vectors)
60
-
61
- **Best for:**
62
- - Production applications
63
- - High accuracy requirements
64
- - Real-time search
65
- - Datasets < 100M vectors
66
-
67
- **Key Parameters:**
68
- - `M`: Number of connections per node (16-64)
69
- - `ef_construction`: Search depth during index building (100-500)
70
- - `ef_search`: Search depth during querying (50-500)
71
-
72
- ### 2. IVF (Inverted File Index)
73
-
74
- **Overview:**
75
- - Clustering-based index
76
- - Partitions vectors into clusters
77
- - Searches only relevant clusters
78
- - Used by: Milvus, Faiss
79
-
80
- **How it works:**
81
- - Cluster vectors using k-means
82
- - Create inverted index mapping clusters to vectors
83
- - Search: find nearest clusters, search within clusters
84
- - Trade accuracy for speed (fewer clusters searched)
85
-
86
- **Pros:**
87
- - ✅ Lower memory usage than HNSW
88
- - ✅ Faster search for very large datasets
89
- - ✅ Scalable to billions of vectors
90
- - ✅ Good for distributed systems
91
-
92
- **Cons:**
93
- - ❌ Lower accuracy than HNSW (80-90% recall)
94
- - ❌ Requires full rebuild for updates
95
- - ❌ Sensitive to cluster quality
96
- - ❌ Slower for small datasets
97
-
98
- **Best for:**
99
- - Very large datasets (>100M vectors)
100
- - Distributed systems
101
- - Batch processing
102
- - Lower accuracy tolerance
103
-
104
- **Key Parameters:**
105
- - `nlist`: Number of clusters (sqrt(n) to 4*sqrt(n))
106
- - `nprobe`: Number of clusters to search (1-nlist)
107
-
108
- ### 3. Flat (Exact Search)
109
-
110
- **Overview:**
111
- - No index, linear scan
112
- - Exact nearest neighbor search
113
- - Baseline for accuracy comparison
114
-
115
- **How it works:**
116
- - Compare query vector to every vector in database
117
- - Return k most similar vectors
118
- - Guaranteed exact results
119
-
120
- **Pros:**
121
- - ✅ 100% accuracy (exact search)
122
- - ✅ No index building time
123
- - ✅ No memory overhead
124
- - ✅ Simple implementation
125
-
126
- **Cons:**
127
- - ❌ Very slow for large datasets (O(n))
128
- - ❌ Not scalable
129
- - ❌ High query latency
130
-
131
- **Best for:**
132
- - Small datasets (<10k vectors)
133
- - Accuracy benchmarking
134
- - Development/testing
135
- - When exact results are critical
136
-
137
- **Key Parameters:**
138
- - None (no index)
139
-
140
- ### 4. LSH (Locality-Sensitive Hashing)
141
-
142
- **Overview:**
143
- - Hash-based index
144
- - Maps similar vectors to same hash buckets
145
- - Probabilistic search
146
-
147
- **How it works:**
148
- - Hash vectors using LSH functions
149
- - Similar vectors hash to same buckets
150
- - Search: hash query, search matching buckets
151
- - Trade accuracy for speed
152
-
153
- **Pros:**
154
- - ✅ Very fast search
155
- - ✅ Low memory usage
156
- - ✅ Good for very high dimensions
157
- - ✅ Supports streaming updates
158
-
159
- **Cons:**
160
- - ❌ Lower accuracy (70-85% recall)
161
- - ❌ Requires careful tuning
162
- - ❌ Sensitive to hash function choice
163
- - ❌ Less popular (fewer implementations)
164
-
165
- **Best for:**
166
- - Very high-dimensional data (>2000 dimensions)
167
- - Streaming data
168
- - Extreme speed requirements
169
- - Lower accuracy tolerance
170
-
171
- **Key Parameters:**
172
- - `num_tables`: Number of hash tables (10-50)
173
- - `num_bits`: Hash size (8-32 bits)
174
-
175
- ---
176
-
177
- ## Index Selection Criteria
178
-
179
- ### Decision Matrix
180
-
181
- | Dataset Size | Accuracy Need | Memory Budget | Recommended Index |
182
- |--------------|---------------|---------------|-------------------|
183
- | < 10k | Exact | Any | Flat |
184
- | 10k - 1M | High (>95%) | High | HNSW |
185
- | 1M - 100M | High (>95%) | High | HNSW |
186
- | 100M+ | High (>95%) | Very High | HNSW (distributed) |
187
- | 1M - 100M | Medium (85-95%) | Medium | IVF |
188
- | 100M+ | Medium (85-95%) | Medium | IVF |
189
- | Any | Low (<85%) | Low | LSH |
190
-
191
- ### Selection Guidelines
192
-
193
- **Choose HNSW if:**
194
- - You need high accuracy (>95% recall)
195
- - Dataset < 100M vectors
196
- - Memory is available
197
- - Real-time search is critical
198
- - **Most common choice for production**
199
-
200
- **Choose IVF if:**
201
- - Dataset > 100M vectors
202
- - Memory is limited
203
- - Batch processing is acceptable
204
- - 85-95% accuracy is sufficient
205
- - Distributed system is available
206
-
207
- **Choose Flat if:**
208
- - Dataset < 10k vectors
209
- - 100% accuracy is required
210
- - Development/testing phase
211
- - Benchmarking other indexes
212
-
213
- **Choose LSH if:**
214
- - Very high dimensions (>2000)
215
- - Extreme speed is critical
216
- - 70-85% accuracy is acceptable
217
- - Streaming updates are needed
218
-
219
- ---
220
-
221
- ## Index Parameters
222
-
223
- ### HNSW Parameters
224
-
225
- **M (Number of Connections)**
226
- - **Definition**: Number of bi-directional links per node in the graph
227
- - **Range**: 4-64 (typical: 16-32)
228
- - **Impact**:
229
- - Higher M → Better accuracy, slower search, more memory
230
- - Lower M → Faster search, less memory, lower accuracy
231
- - **Recommendation**: 16 (balanced), 32 (high accuracy), 8 (low memory)
232
-
233
- ```python
234
- # Pinecone
235
- index = pinecone.Index("my-index")
236
- index.configure_index(
237
- pod_type="p1.x1",
238
- replicas=1,
239
- metadata_config={"indexed": ["category"]},
240
- # M is set by pod type (typically 16)
241
- )
242
-
243
- # Qdrant
244
- from qdrant_client import QdrantClient
245
- from qdrant_client.models import VectorParams, Distance, HnswConfigDiff
246
-
247
- client = QdrantClient("localhost", port=6333)
248
- client.create_collection(
249
- collection_name="my_collection",
250
- vectors_config=VectorParams(size=1536, distance=Distance.COSINE),
251
- hnsw_config=HnswConfigDiff(m=16) # Set M parameter
252
- )
253
- ```
254
-
255
- **ef_construction (Build-time Search Depth)**
256
- - **Definition**: Size of dynamic candidate list during index construction
257
- - **Range**: 100-500 (typical: 200)
258
- - **Impact**:
259
- - Higher ef_construction → Better index quality, slower building
260
- - Lower ef_construction → Faster building, lower quality
261
- - **Recommendation**: 200 (balanced), 400 (high quality), 100 (fast build)
262
-
263
- ```python
264
- # Qdrant
265
- client.create_collection(
266
- collection_name="my_collection",
267
- vectors_config=VectorParams(size=1536, distance=Distance.COSINE),
268
- hnsw_config=HnswConfigDiff(
269
- m=16,
270
- ef_construct=200 # Build-time parameter
271
- )
272
- )
273
- ```
274
-
275
- **ef_search (Query-time Search Depth)**
276
- - **Definition**: Size of dynamic candidate list during search
277
- - **Range**: 50-500 (typical: 100)
278
- - **Impact**:
279
- - Higher ef_search → Better accuracy, slower queries
280
- - Lower ef_search → Faster queries, lower accuracy
281
- - **Recommendation**: 100 (balanced), 200 (high accuracy), 50 (fast queries)
282
-
283
- ```python
284
- # Qdrant
285
- from qdrant_client.models import SearchParams
286
-
287
- results = client.search(
288
- collection_name="my_collection",
289
- query_vector=[0.1, 0.2, ...],
290
- limit=10,
291
- search_params=SearchParams(hnsw_ef=100) # Query-time parameter
292
- )
293
- ```
294
-
295
- ### IVF Parameters
296
-
297
- **nlist (Number of Clusters)**
298
- - **Definition**: Number of clusters to partition vectors into
299
- - **Range**: sqrt(n) to 4*sqrt(n) where n = number of vectors
300
- - **Impact**:
301
- - Higher nlist → More granular partitioning, slower search
302
- - Lower nlist → Coarser partitioning, faster search
303
- - **Recommendation**: sqrt(n) for small datasets, 4*sqrt(n) for large datasets
304
-
305
- ```python
306
- # Faiss (used by Milvus)
307
- import faiss
308
-
309
- # For 1M vectors: nlist = sqrt(1,000,000) = 1000
310
- nlist = 1000
311
- quantizer = faiss.IndexFlatL2(dimension)
312
- index = faiss.IndexIVFFlat(quantizer, dimension, nlist)
313
-
314
- # Train index (required for IVF)
315
- index.train(training_vectors)
316
- index.add(vectors)
317
- ```
318
-
319
- **nprobe (Number of Clusters to Search)**
320
- - **Definition**: Number of nearest clusters to search during query
321
- - **Range**: 1 to nlist (typical: 10-100)
322
- - **Impact**:
323
- - Higher nprobe → Better accuracy, slower search
324
- - Lower nprobe → Faster search, lower accuracy
325
- - **Recommendation**: 10 (fast), 50 (balanced), 100 (high accuracy)
326
-
327
- ```python
328
- # Faiss
329
- index.nprobe = 10 # Search 10 nearest clusters
330
-
331
- # Search
332
- distances, indices = index.search(query_vectors, k=10)
333
- ```
334
-
335
- ### LSH Parameters
336
-
337
- **num_tables (Number of Hash Tables)**
338
- - **Definition**: Number of independent hash tables
339
- - **Range**: 10-50 (typical: 20)
340
- - **Impact**:
341
- - More tables → Better accuracy, more memory
342
- - Fewer tables → Less memory, lower accuracy
343
-
344
- **num_bits (Hash Size)**
345
- - **Definition**: Number of bits in hash code
346
- - **Range**: 8-32 (typical: 16)
347
- - **Impact**:
348
- - More bits → More buckets, better precision
349
- - Fewer bits → Fewer buckets, faster search
350
-
351
- ---
352
-
353
- ## Index Building Strategies
354
-
355
- ### Strategy 1: Batch Building
356
-
357
- **When to use:**
358
- - Initial index creation
359
- - Full reindex
360
- - Offline processing
361
-
362
- **Process:**
363
- ```python
364
- def batch_build_index(vectors, batch_size=10000):
365
- """Build index in batches"""
366
- index = create_index()
367
-
368
- for i in range(0, len(vectors), batch_size):
369
- batch = vectors[i:i + batch_size]
370
- index.add(batch)
371
-
372
- return index
373
-
374
- # Example with Pinecone
375
- import pinecone
376
-
377
- index = pinecone.Index("my-index")
378
-
379
- # Batch upsert
380
- batch_size = 100
381
- for i in range(0, len(vectors), batch_size):
382
- batch = vectors[i:i + batch_size]
383
- index.upsert(vectors=batch)
384
- ```
385
-
386
- **Pros:**
387
- - Efficient for large datasets
388
- - Better resource utilization
389
- - Can parallelize batches
390
-
391
- **Cons:**
392
- - Requires all data upfront
393
- - Longer initial build time
394
-
395
- ### Strategy 2: Incremental Building
396
-
397
- **When to use:**
398
- - Streaming data
399
- - Real-time updates
400
- - Continuous ingestion
401
-
402
- **Process:**
403
- ```python
404
- def incremental_add(index, new_vectors):
405
- """Add vectors incrementally"""
406
- for vector in new_vectors:
407
- index.add([vector])
408
- return index
409
-
410
- # Example with Qdrant
411
- from qdrant_client import QdrantClient
412
- from qdrant_client.models import PointStruct
413
-
414
- client = QdrantClient("localhost", port=6333)
415
-
416
- # Add vectors one at a time or in small batches
417
- client.upsert(
418
- collection_name="my_collection",
419
- points=[
420
- PointStruct(
421
- id=1,
422
- vector=[0.1, 0.2, ...],
423
- payload={"text": "Document 1"}
424
- )
425
- ]
426
- )
427
- ```
428
-
429
- **Pros:**
430
- - No downtime
431
- - Immediate availability
432
- - Handles streaming data
433
-
434
- **Cons:**
435
- - Slower than batch building
436
- - May degrade index quality over time
437
- - Requires periodic optimization
438
-
439
- ### Strategy 3: Parallel Building
440
-
441
- **When to use:**
442
- - Very large datasets (>10M vectors)
443
- - Distributed systems
444
- - Time-critical builds
445
-
446
- **Process:**
447
- ```python
448
- from concurrent.futures import ThreadPoolExecutor
449
-
450
- def parallel_build_index(vectors, num_workers=4):
451
- """Build index in parallel"""
452
- chunk_size = len(vectors) // num_workers
453
- chunks = [vectors[i:i + chunk_size] for i in range(0, len(vectors), chunk_size)]
454
-
455
- with ThreadPoolExecutor(max_workers=num_workers) as executor:
456
- futures = [executor.submit(build_partial_index, chunk) for chunk in chunks]
457
- partial_indexes = [f.result() for f in futures]
458
-
459
- # Merge partial indexes
460
- final_index = merge_indexes(partial_indexes)
461
- return final_index
462
- ```
463
-
464
- **Pros:**
465
- - Fastest for large datasets
466
- - Utilizes multiple cores/machines
467
- - Scalable
468
-
469
- **Cons:**
470
- - More complex implementation
471
- - Requires merge step
472
- - Higher resource usage
473
-
474
- ---
475
-
476
- ## Index Maintenance
477
-
478
- ### When to Maintain Indexes
479
-
480
- **Triggers for maintenance:**
481
- - ✅ After large batch of updates (>10% of index size)
482
- - ✅ Degraded query performance
483
- - ✅ High memory usage
484
- - ✅ Scheduled maintenance windows
485
- - ✅ After deleting many vectors
486
-
487
- ### Maintenance Operations
488
-
489
- **1. Index Optimization**
490
- ```python
491
- # Qdrant
492
- client.optimize(collection_name="my_collection")
493
-
494
- # Weaviate (automatic, but can trigger manually)
495
- client.schema.update_config(
496
- class_name="Document",
497
- config={"vectorIndexConfig": {"cleanupIntervalSeconds": 300}}
498
- )
499
- ```
500
-
501
- **2. Index Rebuilding**
502
- ```python
503
- def rebuild_index(old_index, vectors):
504
- """Rebuild index from scratch"""
505
- # Create new index
506
- new_index = create_index()
507
-
508
- # Add all vectors
509
- new_index.add(vectors)
510
-
511
- # Swap indexes (zero downtime)
512
- swap_indexes(old_index, new_index)
513
-
514
- # Delete old index
515
- delete_index(old_index)
516
- ```
517
-
518
- **3. Compaction**
519
- ```python
520
- # Remove deleted vectors and optimize storage
521
- # Qdrant
522
- client.update_collection(
523
- collection_name="my_collection",
524
- optimizer_config={"deleted_threshold": 0.2} # Compact when 20% deleted
525
- )
526
- ```
527
-
528
- **4. Vacuuming**
529
- ```python
530
- # Reclaim space from deleted vectors
531
- # Similar to database VACUUM operation
532
- def vacuum_index(index):
533
- """Remove deleted vectors and reclaim space"""
534
- # Implementation depends on vector database
535
- index.vacuum()
536
- ```
537
-
538
- ### Maintenance Best Practices
539
-
540
- ✅ **DO:**
541
- - Schedule maintenance during low-traffic periods
542
- - Monitor index health metrics
543
- - Automate routine maintenance
544
- - Test maintenance procedures
545
- - Keep backups before major operations
546
-
547
- ❌ **DON'T:**
548
- - Maintain during peak traffic
549
- - Skip monitoring
550
- - Manually trigger without testing
551
- - Forget to backup
552
- - Ignore performance degradation
553
-
554
- ---
555
-
556
- ## Performance Tuning
557
-
558
- ### Tuning for Accuracy
559
-
560
- **Goal**: Maximize recall (find most similar vectors)
561
-
562
- **HNSW Tuning:**
563
- ```python
564
- # High accuracy configuration
565
- hnsw_config = {
566
- "m": 32, # More connections
567
- "ef_construct": 400, # Better index quality
568
- "ef_search": 200 # Deeper search
569
- }
570
-
571
- # Expected: 98-99% recall, ~50ms query latency
572
- ```
573
-
574
- **IVF Tuning:**
575
- ```python
576
- # High accuracy configuration
577
- ivf_config = {
578
- "nlist": 4 * sqrt(n), # More clusters
579
- "nprobe": 100 # Search more clusters
580
- }
581
-
582
- # Expected: 90-95% recall, ~30ms query latency
583
- ```
584
-
585
- ### Tuning for Speed
586
-
587
- **Goal**: Minimize query latency
588
-
589
- **HNSW Tuning:**
590
- ```python
591
- # High speed configuration
592
- hnsw_config = {
593
- "m": 8, # Fewer connections
594
- "ef_construct": 100, # Faster building
595
- "ef_search": 50 # Shallow search
596
- }
597
-
598
- # Expected: 90-95% recall, ~5ms query latency
599
- ```
600
-
601
- **IVF Tuning:**
602
- ```python
603
- # High speed configuration
604
- ivf_config = {
605
- "nlist": sqrt(n), # Fewer clusters
606
- "nprobe": 10 # Search fewer clusters
607
- }
608
-
609
- # Expected: 80-85% recall, ~5ms query latency
610
- ```
611
-
612
- ### Tuning for Memory
613
-
614
- **Goal**: Minimize memory usage
615
-
616
- **Strategies:**
617
- 1. **Use IVF instead of HNSW** (lower memory footprint)
618
- 2. **Reduce M parameter** (fewer connections = less memory)
619
- 3. **Use quantization** (compress vectors)
620
- 4. **Use product quantization** (PQ) for very large datasets
621
-
622
- ```python
623
- # Faiss with Product Quantization
624
- import faiss
625
-
626
- # Original: 1536 dimensions * 4 bytes = 6KB per vector
627
- # PQ: 1536 dimensions → 64 bytes per vector (96x compression!)
628
-
629
- dimension = 1536
630
- m = 8 # Number of sub-quantizers
631
- nbits = 8 # Bits per sub-quantizer
632
-
633
- quantizer = faiss.IndexFlatL2(dimension)
634
- index = faiss.IndexIVFPQ(quantizer, dimension, nlist=1000, m=m, nbits=nbits)
635
-
636
- # Train and add vectors
637
- index.train(training_vectors)
638
- index.add(vectors)
639
- ```
640
-
641
- ### Tuning for Scale
642
-
643
- **Goal**: Handle billions of vectors
644
-
645
- **Strategies:**
646
- 1. **Use IVF with PQ** (memory efficient)
647
- 2. **Distribute across multiple nodes** (horizontal scaling)
648
- 3. **Use GPU acceleration** (faster search)
649
- 4. **Implement sharding** (partition data)
650
-
651
- ```python
652
- # Distributed Milvus example
653
- from pymilvus import connections, Collection
654
-
655
- # Connect to Milvus cluster
656
- connections.connect(host="milvus-cluster", port=19530)
657
-
658
- # Create collection with sharding
659
- collection = Collection(
660
- name="large_collection",
661
- schema=schema,
662
- shards_num=4 # Distribute across 4 shards
663
- )
664
- ```
665
-
666
- ---
667
-
668
- ## Accuracy vs Speed Tradeoffs
669
-
670
- ### Understanding the Tradeoff
671
-
672
- **Key Insight**: You can't have perfect accuracy AND maximum speed
673
-
674
- **Tradeoff Spectrum:**
675
- ```
676
- Flat Index HNSW (high params) HNSW (low params) IVF (low nprobe)
677
- | | | |
678
- 100% accuracy 98% accuracy 92% accuracy 80% accuracy
679
- Slowest Slow Fast Fastest
680
- ```
681
-
682
- ### Measuring Accuracy
683
-
684
- **Recall**: Percentage of true nearest neighbors found
685
-
686
- ```python
687
- def measure_recall(index, query_vectors, ground_truth, k=10):
688
- """Measure index recall"""
689
- total_recall = 0
690
-
691
- for i, query in enumerate(query_vectors):
692
- # Get results from index
693
- results = index.search(query, k=k)
694
- result_ids = set([r.id for r in results])
695
-
696
- # Compare to ground truth
697
- true_ids = set(ground_truth[i][:k])
698
-
699
- # Calculate recall
700
- recall = len(result_ids & true_ids) / k
701
- total_recall += recall
702
-
703
- return total_recall / len(query_vectors)
704
-
705
- # Example
706
- recall = measure_recall(index, test_queries, ground_truth, k=10)
707
- print(f"Recall@10: {recall:.2%}") # e.g., "Recall@10: 95.50%"
708
- ```
709
-
710
- ### Measuring Speed
711
-
712
- **Query Latency**: Time to execute a single query
713
-
714
- ```python
715
- import time
716
-
717
- def measure_latency(index, query_vectors, k=10):
718
- """Measure average query latency"""
719
- latencies = []
720
-
721
- for query in query_vectors:
722
- start = time.time()
723
- results = index.search(query, k=k)
724
- latency = (time.time() - start) * 1000 # Convert to ms
725
- latencies.append(latency)
726
-
727
- return {
728
- "mean": sum(latencies) / len(latencies),
729
- "p50": sorted(latencies)[len(latencies) // 2],
730
- "p95": sorted(latencies)[int(len(latencies) * 0.95)],
731
- "p99": sorted(latencies)[int(len(latencies) * 0.99)]
732
- }
733
-
734
- # Example
735
- latency = measure_latency(index, test_queries, k=10)
736
- print(f"Mean latency: {latency['mean']:.2f}ms")
737
- print(f"P95 latency: {latency['p95']:.2f}ms")
738
- ```
739
-
740
- ### Choosing the Right Balance
741
-
742
- **Use Case: Semantic Search (User-Facing)**
743
- - **Target**: 95%+ recall, <50ms latency
744
- - **Index**: HNSW with M=16, ef_search=100
745
- - **Rationale**: Users expect accurate results, 50ms is acceptable
746
-
747
- **Use Case: RAG (LLM Context Retrieval)**
748
- - **Target**: 90%+ recall, <20ms latency
749
- - **Index**: HNSW with M=16, ef_search=50
750
- - **Rationale**: LLM can handle slightly less accurate context, speed matters
751
-
752
- **Use Case: Recommendation Engine (Batch)**
753
- - **Target**: 85%+ recall, <100ms latency
754
- - **Index**: IVF with nprobe=50
755
- - **Rationale**: Batch processing, accuracy less critical, cost optimization
756
-
757
- **Use Case: Real-Time Anomaly Detection**
758
- - **Target**: 80%+ recall, <5ms latency
759
- - **Index**: IVF with nprobe=10 or LSH
760
- - **Rationale**: Speed is critical, false negatives acceptable
761
-
762
- ### Benchmarking Example
763
-
764
- ```python
765
- def benchmark_index_configs(vectors, queries, ground_truth):
766
- """Benchmark different index configurations"""
767
- configs = [
768
- {"name": "High Accuracy", "m": 32, "ef_search": 200},
769
- {"name": "Balanced", "m": 16, "ef_search": 100},
770
- {"name": "High Speed", "m": 8, "ef_search": 50}
771
- ]
772
-
773
- results = []
774
-
775
- for config in configs:
776
- # Build index
777
- index = build_hnsw_index(vectors, m=config["m"])
778
-
779
- # Measure recall
780
- recall = measure_recall(index, queries, ground_truth, k=10)
781
-
782
- # Measure latency
783
- latency = measure_latency(index, queries, k=10)
784
-
785
- results.append({
786
- "config": config["name"],
787
- "recall": recall,
788
- "latency_p95": latency["p95"]
789
- })
790
-
791
- return results
792
-
793
- # Example output:
794
- # [
795
- # {"config": "High Accuracy", "recall": 0.98, "latency_p95": 45.2},
796
- # {"config": "Balanced", "recall": 0.95, "latency_p95": 12.5},
797
- # {"config": "High Speed", "recall": 0.90, "latency_p95": 5.1}
798
- # ]
799
- ```
800
-
801
- ---
802
-
803
- ## Best Practices
804
-
805
- ### 1. Index Selection
806
-
807
- ✅ **DO:**
808
- - Use HNSW for most production use cases
809
- - Use IVF for very large datasets (>100M vectors)
810
- - Use Flat for small datasets (<10k vectors)
811
- - Benchmark on your data before choosing
812
-
813
- ❌ **DON'T:**
814
- - Use Flat for large datasets
815
- - Choose index based on popularity alone
816
- - Skip benchmarking
817
- - Ignore memory constraints
818
-
819
- ### 2. Parameter Tuning
820
-
821
- ✅ **DO:**
822
- - Start with recommended defaults
823
- - Tune based on accuracy/speed requirements
824
- - Measure recall and latency
825
- - Document parameter choices
826
-
827
- ❌ **DON'T:**
828
- - Use random parameters
829
- - Tune without measuring
830
- - Ignore tradeoffs
831
- - Skip documentation
832
-
833
- ### 3. Index Building
834
-
835
- ✅ **DO:**
836
- - Batch build for initial index
837
- - Use incremental updates for streaming data
838
- - Parallelize for large datasets
839
- - Monitor build progress
840
-
841
- ❌ **DON'T:**
842
- - Build one vector at a time
843
- - Skip batching
844
- - Ignore build time
845
- - Forget to monitor
846
-
847
- ### 4. Index Maintenance
848
-
849
- ✅ **DO:**
850
- - Schedule regular maintenance
851
- - Monitor index health
852
- - Rebuild when performance degrades
853
- - Keep backups
854
-
855
- ❌ **DON'T:**
856
- - Skip maintenance
857
- - Ignore performance degradation
858
- - Maintain during peak traffic
859
- - Forget backups
860
-
861
- ### 5. Performance Optimization
862
-
863
- ✅ **DO:**
864
- - Measure before optimizing
865
- - Tune for your use case
866
- - Balance accuracy and speed
867
- - Monitor production metrics
868
-
869
- ❌ **DON'T:**
870
- - Optimize prematurely
871
- - Tune without measuring
872
- - Ignore use case requirements
873
- - Skip production monitoring
874
-
875
- ---
876
-
877
- ## Common Pitfalls
878
-
879
- ### 1. Wrong Index Type
880
-
881
- **Problem**: Using Flat index for 1M vectors (very slow)
882
-
883
- **Solution**: Use HNSW or IVF for large datasets
884
-
885
- ### 2. Poor Parameter Tuning
886
-
887
- **Problem**: Using default parameters without tuning
888
-
889
- **Solution**: Benchmark and tune for your use case
890
-
891
- ### 3. No Index Maintenance
892
-
893
- **Problem**: Index performance degrades over time
894
-
895
- **Solution**: Schedule regular maintenance and rebuilds
896
-
897
- ### 4. Ignoring Accuracy
898
-
899
- **Problem**: Optimizing only for speed, poor results
900
-
901
- **Solution**: Measure recall, balance accuracy and speed
902
-
903
- ### 5. Not Benchmarking
904
-
905
- **Problem**: Choosing index/parameters without testing
906
-
907
- **Solution**: Benchmark on representative data before production
908
-
909
- ---
910
-
911
- ## Summary
912
-
913
- **Key Takeaways:**
914
- 1. HNSW is best for most production use cases (high accuracy, good speed)
915
- 2. IVF is best for very large datasets (>100M vectors, lower memory)
916
- 3. Tune parameters based on accuracy/speed requirements
917
- 4. Measure recall and latency to validate configuration
918
- 5. Maintain indexes regularly for optimal performance
919
- 6. Balance accuracy and speed based on use case
920
-
921
- **Parameter Recommendations:**
922
- - **HNSW (balanced)**: M=16, ef_construct=200, ef_search=100
923
- - **HNSW (high accuracy)**: M=32, ef_construct=400, ef_search=200
924
- - **HNSW (high speed)**: M=8, ef_construct=100, ef_search=50
925
- - **IVF (balanced)**: nlist=sqrt(n), nprobe=50
926
- - **IVF (high accuracy)**: nlist=4*sqrt(n), nprobe=100
927
- - **IVF (high speed)**: nlist=sqrt(n), nprobe=10
928
-
929
- **Next Steps:**
930
- - See `vector-databases.md` for vector database fundamentals
931
- - See `vector-embeddings.md` for embedding generation
932
- - See `examples/vector-database-example.md` for complete implementation
933
-
934
-
1
+ # Vector Indexing
2
+
3
+ ## Overview
4
+
5
+ This document covers vector indexing fundamentals, including index types (HNSW, IVF, Flat, LSH), index parameters (ef_construction, M, nlist, nprobe), index selection criteria, index building strategies, index maintenance, performance tuning, and accuracy vs speed tradeoffs.
6
+
7
+ ---
8
+
9
+ ## What is Vector Indexing?
10
+
11
+ ### Definition
12
+
13
+ **Vector Index**: Data structure optimized for fast similarity search in high-dimensional vector spaces
14
+
15
+ **Key Concepts:**
16
+ - Enables fast approximate nearest neighbor (ANN) search
17
+ - Trade-off between accuracy and speed
18
+ - Different index types for different use cases
19
+ - Critical for large-scale vector databases (>100k vectors)
20
+
21
+ **Why Indexing Matters:**
22
+ - **Without index**: Linear scan (O(n)) - slow for large datasets
23
+ - **With index**: Sublinear search (O(log n) or better) - fast even for billions of vectors
24
+
25
+ **Example:**
26
+ ```
27
+ Dataset: 1 million vectors (1536 dimensions)
28
+ Linear scan: ~1000ms per query
29
+ HNSW index: ~10ms per query (100x faster!)
30
+ ```
31
+
32
+ ---
33
+
34
+ ## Index Types
35
+
36
+ ### 1. HNSW (Hierarchical Navigable Small World)
37
+
38
+ **Overview:**
39
+ - Graph-based index
40
+ - Best accuracy/speed trade-off
41
+ - Most popular for production systems
42
+ - Used by: Pinecone, Weaviate, Qdrant, Milvus
43
+
44
+ **How it works:**
45
+ - Builds multi-layer graph of vectors
46
+ - Each layer has different connectivity
47
+ - Search starts at top layer, navigates down
48
+ - Finds approximate nearest neighbors efficiently
49
+
50
+ **Pros:**
51
+ - ✅ Excellent accuracy (>95% recall)
52
+ - ✅ Fast search (milliseconds)
53
+ - ✅ Good for high-dimensional data
54
+ - ✅ Incremental updates supported
55
+
56
+ **Cons:**
57
+ - ❌ High memory usage (stores full graph)
58
+ - ❌ Slower index building
59
+ - ❌ Not ideal for very large datasets (>100M vectors)
60
+
61
+ **Best for:**
62
+ - Production applications
63
+ - High accuracy requirements
64
+ - Real-time search
65
+ - Datasets < 100M vectors
66
+
67
+ **Key Parameters:**
68
+ - `M`: Number of connections per node (16-64)
69
+ - `ef_construction`: Search depth during index building (100-500)
70
+ - `ef_search`: Search depth during querying (50-500)
71
+
72
+ ### 2. IVF (Inverted File Index)
73
+
74
+ **Overview:**
75
+ - Clustering-based index
76
+ - Partitions vectors into clusters
77
+ - Searches only relevant clusters
78
+ - Used by: Milvus, Faiss
79
+
80
+ **How it works:**
81
+ - Cluster vectors using k-means
82
+ - Create inverted index mapping clusters to vectors
83
+ - Search: find nearest clusters, search within clusters
84
+ - Trade accuracy for speed (fewer clusters searched)
85
+
86
+ **Pros:**
87
+ - ✅ Lower memory usage than HNSW
88
+ - ✅ Faster search for very large datasets
89
+ - ✅ Scalable to billions of vectors
90
+ - ✅ Good for distributed systems
91
+
92
+ **Cons:**
93
+ - ❌ Lower accuracy than HNSW (80-90% recall)
94
+ - ❌ Requires full rebuild for updates
95
+ - ❌ Sensitive to cluster quality
96
+ - ❌ Slower for small datasets
97
+
98
+ **Best for:**
99
+ - Very large datasets (>100M vectors)
100
+ - Distributed systems
101
+ - Batch processing
102
+ - Lower accuracy tolerance
103
+
104
+ **Key Parameters:**
105
+ - `nlist`: Number of clusters (sqrt(n) to 4*sqrt(n))
106
+ - `nprobe`: Number of clusters to search (1-nlist)
107
+
108
+ ### 3. Flat (Exact Search)
109
+
110
+ **Overview:**
111
+ - No index, linear scan
112
+ - Exact nearest neighbor search
113
+ - Baseline for accuracy comparison
114
+
115
+ **How it works:**
116
+ - Compare query vector to every vector in database
117
+ - Return k most similar vectors
118
+ - Guaranteed exact results
119
+
120
+ **Pros:**
121
+ - ✅ 100% accuracy (exact search)
122
+ - ✅ No index building time
123
+ - ✅ No memory overhead
124
+ - ✅ Simple implementation
125
+
126
+ **Cons:**
127
+ - ❌ Very slow for large datasets (O(n))
128
+ - ❌ Not scalable
129
+ - ❌ High query latency
130
+
131
+ **Best for:**
132
+ - Small datasets (<10k vectors)
133
+ - Accuracy benchmarking
134
+ - Development/testing
135
+ - When exact results are critical
136
+
137
+ **Key Parameters:**
138
+ - None (no index)
139
+
140
+ ### 4. LSH (Locality-Sensitive Hashing)
141
+
142
+ **Overview:**
143
+ - Hash-based index
144
+ - Maps similar vectors to same hash buckets
145
+ - Probabilistic search
146
+
147
+ **How it works:**
148
+ - Hash vectors using LSH functions
149
+ - Similar vectors hash to same buckets
150
+ - Search: hash query, search matching buckets
151
+ - Trade accuracy for speed
152
+
153
+ **Pros:**
154
+ - ✅ Very fast search
155
+ - ✅ Low memory usage
156
+ - ✅ Good for very high dimensions
157
+ - ✅ Supports streaming updates
158
+
159
+ **Cons:**
160
+ - ❌ Lower accuracy (70-85% recall)
161
+ - ❌ Requires careful tuning
162
+ - ❌ Sensitive to hash function choice
163
+ - ❌ Less popular (fewer implementations)
164
+
165
+ **Best for:**
166
+ - Very high-dimensional data (>2000 dimensions)
167
+ - Streaming data
168
+ - Extreme speed requirements
169
+ - Lower accuracy tolerance
170
+
171
+ **Key Parameters:**
172
+ - `num_tables`: Number of hash tables (10-50)
173
+ - `num_bits`: Hash size (8-32 bits)
174
+
175
+ ---
176
+
177
+ ## Index Selection Criteria
178
+
179
+ ### Decision Matrix
180
+
181
+ | Dataset Size | Accuracy Need | Memory Budget | Recommended Index |
182
+ |--------------|---------------|---------------|-------------------|
183
+ | < 10k | Exact | Any | Flat |
184
+ | 10k - 1M | High (>95%) | High | HNSW |
185
+ | 1M - 100M | High (>95%) | High | HNSW |
186
+ | 100M+ | High (>95%) | Very High | HNSW (distributed) |
187
+ | 1M - 100M | Medium (85-95%) | Medium | IVF |
188
+ | 100M+ | Medium (85-95%) | Medium | IVF |
189
+ | Any | Low (<85%) | Low | LSH |
190
+
191
+ ### Selection Guidelines
192
+
193
+ **Choose HNSW if:**
194
+ - You need high accuracy (>95% recall)
195
+ - Dataset < 100M vectors
196
+ - Memory is available
197
+ - Real-time search is critical
198
+ - **Most common choice for production**
199
+
200
+ **Choose IVF if:**
201
+ - Dataset > 100M vectors
202
+ - Memory is limited
203
+ - Batch processing is acceptable
204
+ - 85-95% accuracy is sufficient
205
+ - Distributed system is available
206
+
207
+ **Choose Flat if:**
208
+ - Dataset < 10k vectors
209
+ - 100% accuracy is required
210
+ - Development/testing phase
211
+ - Benchmarking other indexes
212
+
213
+ **Choose LSH if:**
214
+ - Very high dimensions (>2000)
215
+ - Extreme speed is critical
216
+ - 70-85% accuracy is acceptable
217
+ - Streaming updates are needed
218
+
219
+ ---
220
+
221
+ ## Index Parameters
222
+
223
+ ### HNSW Parameters
224
+
225
+ **M (Number of Connections)**
226
+ - **Definition**: Number of bi-directional links per node in the graph
227
+ - **Range**: 4-64 (typical: 16-32)
228
+ - **Impact**:
229
+ - Higher M → Better accuracy, slower search, more memory
230
+ - Lower M → Faster search, less memory, lower accuracy
231
+ - **Recommendation**: 16 (balanced), 32 (high accuracy), 8 (low memory)
232
+
233
+ ```python
234
+ # Pinecone
235
+ index = pinecone.Index("my-index")
236
+ index.configure_index(
237
+ pod_type="p1.x1",
238
+ replicas=1,
239
+ metadata_config={"indexed": ["category"]},
240
+ # M is set by pod type (typically 16)
241
+ )
242
+
243
+ # Qdrant
244
+ from qdrant_client import QdrantClient
245
+ from qdrant_client.models import VectorParams, Distance, HnswConfigDiff
246
+
247
+ client = QdrantClient("localhost", port=6333)
248
+ client.create_collection(
249
+ collection_name="my_collection",
250
+ vectors_config=VectorParams(size=1536, distance=Distance.COSINE),
251
+ hnsw_config=HnswConfigDiff(m=16) # Set M parameter
252
+ )
253
+ ```
254
+
255
+ **ef_construction (Build-time Search Depth)**
256
+ - **Definition**: Size of dynamic candidate list during index construction
257
+ - **Range**: 100-500 (typical: 200)
258
+ - **Impact**:
259
+ - Higher ef_construction → Better index quality, slower building
260
+ - Lower ef_construction → Faster building, lower quality
261
+ - **Recommendation**: 200 (balanced), 400 (high quality), 100 (fast build)
262
+
263
+ ```python
264
+ # Qdrant
265
+ client.create_collection(
266
+ collection_name="my_collection",
267
+ vectors_config=VectorParams(size=1536, distance=Distance.COSINE),
268
+ hnsw_config=HnswConfigDiff(
269
+ m=16,
270
+ ef_construct=200 # Build-time parameter
271
+ )
272
+ )
273
+ ```
274
+
275
+ **ef_search (Query-time Search Depth)**
276
+ - **Definition**: Size of dynamic candidate list during search
277
+ - **Range**: 50-500 (typical: 100)
278
+ - **Impact**:
279
+ - Higher ef_search → Better accuracy, slower queries
280
+ - Lower ef_search → Faster queries, lower accuracy
281
+ - **Recommendation**: 100 (balanced), 200 (high accuracy), 50 (fast queries)
282
+
283
+ ```python
284
+ # Qdrant
285
+ from qdrant_client.models import SearchParams
286
+
287
+ results = client.search(
288
+ collection_name="my_collection",
289
+ query_vector=[0.1, 0.2, ...],
290
+ limit=10,
291
+ search_params=SearchParams(hnsw_ef=100) # Query-time parameter
292
+ )
293
+ ```
294
+
295
+ ### IVF Parameters
296
+
297
+ **nlist (Number of Clusters)**
298
+ - **Definition**: Number of clusters to partition vectors into
299
+ - **Range**: sqrt(n) to 4*sqrt(n) where n = number of vectors
300
+ - **Impact**:
301
+ - Higher nlist → More granular partitioning, slower search
302
+ - Lower nlist → Coarser partitioning, faster search
303
+ - **Recommendation**: sqrt(n) for small datasets, 4*sqrt(n) for large datasets
304
+
305
+ ```python
306
+ # Faiss (used by Milvus)
307
+ import faiss
308
+
309
+ # For 1M vectors: nlist = sqrt(1,000,000) = 1000
310
+ nlist = 1000
311
+ quantizer = faiss.IndexFlatL2(dimension)
312
+ index = faiss.IndexIVFFlat(quantizer, dimension, nlist)
313
+
314
+ # Train index (required for IVF)
315
+ index.train(training_vectors)
316
+ index.add(vectors)
317
+ ```
318
+
319
+ **nprobe (Number of Clusters to Search)**
320
+ - **Definition**: Number of nearest clusters to search during query
321
+ - **Range**: 1 to nlist (typical: 10-100)
322
+ - **Impact**:
323
+ - Higher nprobe → Better accuracy, slower search
324
+ - Lower nprobe → Faster search, lower accuracy
325
+ - **Recommendation**: 10 (fast), 50 (balanced), 100 (high accuracy)
326
+
327
+ ```python
328
+ # Faiss
329
+ index.nprobe = 10 # Search 10 nearest clusters
330
+
331
+ # Search
332
+ distances, indices = index.search(query_vectors, k=10)
333
+ ```
334
+
335
+ ### LSH Parameters
336
+
337
+ **num_tables (Number of Hash Tables)**
338
+ - **Definition**: Number of independent hash tables
339
+ - **Range**: 10-50 (typical: 20)
340
+ - **Impact**:
341
+ - More tables → Better accuracy, more memory
342
+ - Fewer tables → Less memory, lower accuracy
343
+
344
+ **num_bits (Hash Size)**
345
+ - **Definition**: Number of bits in hash code
346
+ - **Range**: 8-32 (typical: 16)
347
+ - **Impact**:
348
+ - More bits → More buckets, better precision
349
+ - Fewer bits → Fewer buckets, faster search
350
+
351
+ ---
352
+
353
+ ## Index Building Strategies
354
+
355
+ ### Strategy 1: Batch Building
356
+
357
+ **When to use:**
358
+ - Initial index creation
359
+ - Full reindex
360
+ - Offline processing
361
+
362
+ **Process:**
363
+ ```python
364
+ def batch_build_index(vectors, batch_size=10000):
365
+ """Build index in batches"""
366
+ index = create_index()
367
+
368
+ for i in range(0, len(vectors), batch_size):
369
+ batch = vectors[i:i + batch_size]
370
+ index.add(batch)
371
+
372
+ return index
373
+
374
+ # Example with Pinecone
375
+ import pinecone
376
+
377
+ index = pinecone.Index("my-index")
378
+
379
+ # Batch upsert
380
+ batch_size = 100
381
+ for i in range(0, len(vectors), batch_size):
382
+ batch = vectors[i:i + batch_size]
383
+ index.upsert(vectors=batch)
384
+ ```
385
+
386
+ **Pros:**
387
+ - Efficient for large datasets
388
+ - Better resource utilization
389
+ - Can parallelize batches
390
+
391
+ **Cons:**
392
+ - Requires all data upfront
393
+ - Longer initial build time
394
+
395
+ ### Strategy 2: Incremental Building
396
+
397
+ **When to use:**
398
+ - Streaming data
399
+ - Real-time updates
400
+ - Continuous ingestion
401
+
402
+ **Process:**
403
+ ```python
404
+ def incremental_add(index, new_vectors):
405
+ """Add vectors incrementally"""
406
+ for vector in new_vectors:
407
+ index.add([vector])
408
+ return index
409
+
410
+ # Example with Qdrant
411
+ from qdrant_client import QdrantClient
412
+ from qdrant_client.models import PointStruct
413
+
414
+ client = QdrantClient("localhost", port=6333)
415
+
416
+ # Add vectors one at a time or in small batches
417
+ client.upsert(
418
+ collection_name="my_collection",
419
+ points=[
420
+ PointStruct(
421
+ id=1,
422
+ vector=[0.1, 0.2, ...],
423
+ payload={"text": "Document 1"}
424
+ )
425
+ ]
426
+ )
427
+ ```
428
+
429
+ **Pros:**
430
+ - No downtime
431
+ - Immediate availability
432
+ - Handles streaming data
433
+
434
+ **Cons:**
435
+ - Slower than batch building
436
+ - May degrade index quality over time
437
+ - Requires periodic optimization
438
+
439
+ ### Strategy 3: Parallel Building
440
+
441
+ **When to use:**
442
+ - Very large datasets (>10M vectors)
443
+ - Distributed systems
444
+ - Time-critical builds
445
+
446
+ **Process:**
447
+ ```python
448
+ from concurrent.futures import ThreadPoolExecutor
449
+
450
+ def parallel_build_index(vectors, num_workers=4):
451
+ """Build index in parallel"""
452
+ chunk_size = len(vectors) // num_workers
453
+ chunks = [vectors[i:i + chunk_size] for i in range(0, len(vectors), chunk_size)]
454
+
455
+ with ThreadPoolExecutor(max_workers=num_workers) as executor:
456
+ futures = [executor.submit(build_partial_index, chunk) for chunk in chunks]
457
+ partial_indexes = [f.result() for f in futures]
458
+
459
+ # Merge partial indexes
460
+ final_index = merge_indexes(partial_indexes)
461
+ return final_index
462
+ ```
463
+
464
+ **Pros:**
465
+ - Fastest for large datasets
466
+ - Utilizes multiple cores/machines
467
+ - Scalable
468
+
469
+ **Cons:**
470
+ - More complex implementation
471
+ - Requires merge step
472
+ - Higher resource usage
473
+
474
+ ---
475
+
476
+ ## Index Maintenance
477
+
478
+ ### When to Maintain Indexes
479
+
480
+ **Triggers for maintenance:**
481
+ - ✅ After large batch of updates (>10% of index size)
482
+ - ✅ Degraded query performance
483
+ - ✅ High memory usage
484
+ - ✅ Scheduled maintenance windows
485
+ - ✅ After deleting many vectors
486
+
487
+ ### Maintenance Operations
488
+
489
+ **1. Index Optimization**
490
+ ```python
491
+ # Qdrant
492
+ client.optimize(collection_name="my_collection")
493
+
494
+ # Weaviate (automatic, but can trigger manually)
495
+ client.schema.update_config(
496
+ class_name="Document",
497
+ config={"vectorIndexConfig": {"cleanupIntervalSeconds": 300}}
498
+ )
499
+ ```
500
+
501
+ **2. Index Rebuilding**
502
+ ```python
503
+ def rebuild_index(old_index, vectors):
504
+ """Rebuild index from scratch"""
505
+ # Create new index
506
+ new_index = create_index()
507
+
508
+ # Add all vectors
509
+ new_index.add(vectors)
510
+
511
+ # Swap indexes (zero downtime)
512
+ swap_indexes(old_index, new_index)
513
+
514
+ # Delete old index
515
+ delete_index(old_index)
516
+ ```
517
+
518
+ **3. Compaction**
519
+ ```python
520
+ # Remove deleted vectors and optimize storage
521
+ # Qdrant
522
+ client.update_collection(
523
+ collection_name="my_collection",
524
+ optimizer_config={"deleted_threshold": 0.2} # Compact when 20% deleted
525
+ )
526
+ ```
527
+
528
+ **4. Vacuuming**
529
+ ```python
530
+ # Reclaim space from deleted vectors
531
+ # Similar to database VACUUM operation
532
+ def vacuum_index(index):
533
+ """Remove deleted vectors and reclaim space"""
534
+ # Implementation depends on vector database
535
+ index.vacuum()
536
+ ```
537
+
538
+ ### Maintenance Best Practices
539
+
540
+ ✅ **DO:**
541
+ - Schedule maintenance during low-traffic periods
542
+ - Monitor index health metrics
543
+ - Automate routine maintenance
544
+ - Test maintenance procedures
545
+ - Keep backups before major operations
546
+
547
+ ❌ **DON'T:**
548
+ - Maintain during peak traffic
549
+ - Skip monitoring
550
+ - Manually trigger without testing
551
+ - Forget to backup
552
+ - Ignore performance degradation
553
+
554
+ ---
555
+
556
+ ## Performance Tuning
557
+
558
+ ### Tuning for Accuracy
559
+
560
+ **Goal**: Maximize recall (find most similar vectors)
561
+
562
+ **HNSW Tuning:**
563
+ ```python
564
+ # High accuracy configuration
565
+ hnsw_config = {
566
+ "m": 32, # More connections
567
+ "ef_construct": 400, # Better index quality
568
+ "ef_search": 200 # Deeper search
569
+ }
570
+
571
+ # Expected: 98-99% recall, ~50ms query latency
572
+ ```
573
+
574
+ **IVF Tuning:**
575
+ ```python
576
+ # High accuracy configuration
577
+ ivf_config = {
578
+ "nlist": 4 * sqrt(n), # More clusters
579
+ "nprobe": 100 # Search more clusters
580
+ }
581
+
582
+ # Expected: 90-95% recall, ~30ms query latency
583
+ ```
584
+
585
+ ### Tuning for Speed
586
+
587
+ **Goal**: Minimize query latency
588
+
589
+ **HNSW Tuning:**
590
+ ```python
591
+ # High speed configuration
592
+ hnsw_config = {
593
+ "m": 8, # Fewer connections
594
+ "ef_construct": 100, # Faster building
595
+ "ef_search": 50 # Shallow search
596
+ }
597
+
598
+ # Expected: 90-95% recall, ~5ms query latency
599
+ ```
600
+
601
+ **IVF Tuning:**
602
+ ```python
603
+ # High speed configuration
604
+ ivf_config = {
605
+ "nlist": sqrt(n), # Fewer clusters
606
+ "nprobe": 10 # Search fewer clusters
607
+ }
608
+
609
+ # Expected: 80-85% recall, ~5ms query latency
610
+ ```
611
+
612
+ ### Tuning for Memory
613
+
614
+ **Goal**: Minimize memory usage
615
+
616
+ **Strategies:**
617
+ 1. **Use IVF instead of HNSW** (lower memory footprint)
618
+ 2. **Reduce M parameter** (fewer connections = less memory)
619
+ 3. **Use quantization** (compress vectors)
620
+ 4. **Use product quantization** (PQ) for very large datasets
621
+
622
+ ```python
623
+ # Faiss with Product Quantization
624
+ import faiss
625
+
626
+ # Original: 1536 dimensions * 4 bytes = 6KB per vector
627
+ # PQ: 1536 dimensions → 64 bytes per vector (96x compression!)
628
+
629
+ dimension = 1536
630
+ m = 8 # Number of sub-quantizers
631
+ nbits = 8 # Bits per sub-quantizer
632
+
633
+ quantizer = faiss.IndexFlatL2(dimension)
634
+ index = faiss.IndexIVFPQ(quantizer, dimension, nlist=1000, m=m, nbits=nbits)
635
+
636
+ # Train and add vectors
637
+ index.train(training_vectors)
638
+ index.add(vectors)
639
+ ```
640
+
641
+ ### Tuning for Scale
642
+
643
+ **Goal**: Handle billions of vectors
644
+
645
+ **Strategies:**
646
+ 1. **Use IVF with PQ** (memory efficient)
647
+ 2. **Distribute across multiple nodes** (horizontal scaling)
648
+ 3. **Use GPU acceleration** (faster search)
649
+ 4. **Implement sharding** (partition data)
650
+
651
+ ```python
652
+ # Distributed Milvus example
653
+ from pymilvus import connections, Collection
654
+
655
+ # Connect to Milvus cluster
656
+ connections.connect(host="milvus-cluster", port=19530)
657
+
658
+ # Create collection with sharding
659
+ collection = Collection(
660
+ name="large_collection",
661
+ schema=schema,
662
+ shards_num=4 # Distribute across 4 shards
663
+ )
664
+ ```
665
+
666
+ ---
667
+
668
+ ## Accuracy vs Speed Tradeoffs
669
+
670
+ ### Understanding the Tradeoff
671
+
672
+ **Key Insight**: You can't have perfect accuracy AND maximum speed
673
+
674
+ **Tradeoff Spectrum:**
675
+ ```
676
+ Flat Index HNSW (high params) HNSW (low params) IVF (low nprobe)
677
+ | | | |
678
+ 100% accuracy 98% accuracy 92% accuracy 80% accuracy
679
+ Slowest Slow Fast Fastest
680
+ ```
681
+
682
+ ### Measuring Accuracy
683
+
684
+ **Recall**: Percentage of true nearest neighbors found
685
+
686
+ ```python
687
+ def measure_recall(index, query_vectors, ground_truth, k=10):
688
+ """Measure index recall"""
689
+ total_recall = 0
690
+
691
+ for i, query in enumerate(query_vectors):
692
+ # Get results from index
693
+ results = index.search(query, k=k)
694
+ result_ids = set([r.id for r in results])
695
+
696
+ # Compare to ground truth
697
+ true_ids = set(ground_truth[i][:k])
698
+
699
+ # Calculate recall
700
+ recall = len(result_ids & true_ids) / k
701
+ total_recall += recall
702
+
703
+ return total_recall / len(query_vectors)
704
+
705
+ # Example
706
+ recall = measure_recall(index, test_queries, ground_truth, k=10)
707
+ print(f"Recall@10: {recall:.2%}") # e.g., "Recall@10: 95.50%"
708
+ ```
709
+
710
+ ### Measuring Speed
711
+
712
+ **Query Latency**: Time to execute a single query
713
+
714
+ ```python
715
+ import time
716
+
717
+ def measure_latency(index, query_vectors, k=10):
718
+ """Measure average query latency"""
719
+ latencies = []
720
+
721
+ for query in query_vectors:
722
+ start = time.time()
723
+ results = index.search(query, k=k)
724
+ latency = (time.time() - start) * 1000 # Convert to ms
725
+ latencies.append(latency)
726
+
727
+ return {
728
+ "mean": sum(latencies) / len(latencies),
729
+ "p50": sorted(latencies)[len(latencies) // 2],
730
+ "p95": sorted(latencies)[int(len(latencies) * 0.95)],
731
+ "p99": sorted(latencies)[int(len(latencies) * 0.99)]
732
+ }
733
+
734
+ # Example
735
+ latency = measure_latency(index, test_queries, k=10)
736
+ print(f"Mean latency: {latency['mean']:.2f}ms")
737
+ print(f"P95 latency: {latency['p95']:.2f}ms")
738
+ ```
739
+
740
+ ### Choosing the Right Balance
741
+
742
+ **Use Case: Semantic Search (User-Facing)**
743
+ - **Target**: 95%+ recall, <50ms latency
744
+ - **Index**: HNSW with M=16, ef_search=100
745
+ - **Rationale**: Users expect accurate results, 50ms is acceptable
746
+
747
+ **Use Case: RAG (LLM Context Retrieval)**
748
+ - **Target**: 90%+ recall, <20ms latency
749
+ - **Index**: HNSW with M=16, ef_search=50
750
+ - **Rationale**: LLM can handle slightly less accurate context, speed matters
751
+
752
+ **Use Case: Recommendation Engine (Batch)**
753
+ - **Target**: 85%+ recall, <100ms latency
754
+ - **Index**: IVF with nprobe=50
755
+ - **Rationale**: Batch processing, accuracy less critical, cost optimization
756
+
757
+ **Use Case: Real-Time Anomaly Detection**
758
+ - **Target**: 80%+ recall, <5ms latency
759
+ - **Index**: IVF with nprobe=10 or LSH
760
+ - **Rationale**: Speed is critical, false negatives acceptable
761
+
762
+ ### Benchmarking Example
763
+
764
+ ```python
765
+ def benchmark_index_configs(vectors, queries, ground_truth):
766
+ """Benchmark different index configurations"""
767
+ configs = [
768
+ {"name": "High Accuracy", "m": 32, "ef_search": 200},
769
+ {"name": "Balanced", "m": 16, "ef_search": 100},
770
+ {"name": "High Speed", "m": 8, "ef_search": 50}
771
+ ]
772
+
773
+ results = []
774
+
775
+ for config in configs:
776
+ # Build index
777
+ index = build_hnsw_index(vectors, m=config["m"])
778
+
779
+ # Measure recall
780
+ recall = measure_recall(index, queries, ground_truth, k=10)
781
+
782
+ # Measure latency
783
+ latency = measure_latency(index, queries, k=10)
784
+
785
+ results.append({
786
+ "config": config["name"],
787
+ "recall": recall,
788
+ "latency_p95": latency["p95"]
789
+ })
790
+
791
+ return results
792
+
793
+ # Example output:
794
+ # [
795
+ # {"config": "High Accuracy", "recall": 0.98, "latency_p95": 45.2},
796
+ # {"config": "Balanced", "recall": 0.95, "latency_p95": 12.5},
797
+ # {"config": "High Speed", "recall": 0.90, "latency_p95": 5.1}
798
+ # ]
799
+ ```
800
+
801
+ ---
802
+
803
+ ## Best Practices
804
+
805
+ ### 1. Index Selection
806
+
807
+ ✅ **DO:**
808
+ - Use HNSW for most production use cases
809
+ - Use IVF for very large datasets (>100M vectors)
810
+ - Use Flat for small datasets (<10k vectors)
811
+ - Benchmark on your data before choosing
812
+
813
+ ❌ **DON'T:**
814
+ - Use Flat for large datasets
815
+ - Choose index based on popularity alone
816
+ - Skip benchmarking
817
+ - Ignore memory constraints
818
+
819
+ ### 2. Parameter Tuning
820
+
821
+ ✅ **DO:**
822
+ - Start with recommended defaults
823
+ - Tune based on accuracy/speed requirements
824
+ - Measure recall and latency
825
+ - Document parameter choices
826
+
827
+ ❌ **DON'T:**
828
+ - Use random parameters
829
+ - Tune without measuring
830
+ - Ignore tradeoffs
831
+ - Skip documentation
832
+
833
+ ### 3. Index Building
834
+
835
+ ✅ **DO:**
836
+ - Batch build for initial index
837
+ - Use incremental updates for streaming data
838
+ - Parallelize for large datasets
839
+ - Monitor build progress
840
+
841
+ ❌ **DON'T:**
842
+ - Build one vector at a time
843
+ - Skip batching
844
+ - Ignore build time
845
+ - Forget to monitor
846
+
847
+ ### 4. Index Maintenance
848
+
849
+ ✅ **DO:**
850
+ - Schedule regular maintenance
851
+ - Monitor index health
852
+ - Rebuild when performance degrades
853
+ - Keep backups
854
+
855
+ ❌ **DON'T:**
856
+ - Skip maintenance
857
+ - Ignore performance degradation
858
+ - Maintain during peak traffic
859
+ - Forget backups
860
+
861
+ ### 5. Performance Optimization
862
+
863
+ ✅ **DO:**
864
+ - Measure before optimizing
865
+ - Tune for your use case
866
+ - Balance accuracy and speed
867
+ - Monitor production metrics
868
+
869
+ ❌ **DON'T:**
870
+ - Optimize prematurely
871
+ - Tune without measuring
872
+ - Ignore use case requirements
873
+ - Skip production monitoring
874
+
875
+ ---
876
+
877
+ ## Common Pitfalls
878
+
879
+ ### 1. Wrong Index Type
880
+
881
+ **Problem**: Using Flat index for 1M vectors (very slow)
882
+
883
+ **Solution**: Use HNSW or IVF for large datasets
884
+
885
+ ### 2. Poor Parameter Tuning
886
+
887
+ **Problem**: Using default parameters without tuning
888
+
889
+ **Solution**: Benchmark and tune for your use case
890
+
891
+ ### 3. No Index Maintenance
892
+
893
+ **Problem**: Index performance degrades over time
894
+
895
+ **Solution**: Schedule regular maintenance and rebuilds
896
+
897
+ ### 4. Ignoring Accuracy
898
+
899
+ **Problem**: Optimizing only for speed, poor results
900
+
901
+ **Solution**: Measure recall, balance accuracy and speed
902
+
903
+ ### 5. Not Benchmarking
904
+
905
+ **Problem**: Choosing index/parameters without testing
906
+
907
+ **Solution**: Benchmark on representative data before production
908
+
909
+ ---
910
+
911
+ ## Summary
912
+
913
+ **Key Takeaways:**
914
+ 1. HNSW is best for most production use cases (high accuracy, good speed)
915
+ 2. IVF is best for very large datasets (>100M vectors, lower memory)
916
+ 3. Tune parameters based on accuracy/speed requirements
917
+ 4. Measure recall and latency to validate configuration
918
+ 5. Maintain indexes regularly for optimal performance
919
+ 6. Balance accuracy and speed based on use case
920
+
921
+ **Parameter Recommendations:**
922
+ - **HNSW (balanced)**: M=16, ef_construct=200, ef_search=100
923
+ - **HNSW (high accuracy)**: M=32, ef_construct=400, ef_search=200
924
+ - **HNSW (high speed)**: M=8, ef_construct=100, ef_search=50
925
+ - **IVF (balanced)**: nlist=sqrt(n), nprobe=50
926
+ - **IVF (high accuracy)**: nlist=4*sqrt(n), nprobe=100
927
+ - **IVF (high speed)**: nlist=sqrt(n), nprobe=10
928
+
929
+ **Next Steps:**
930
+ - See `vector-databases.md` for vector database fundamentals
931
+ - See `vector-embeddings.md` for embedding generation
932
+ - See `examples/vector-database-example.md` for complete implementation
933
+
934
+