@rsrsai/macos-x64 0.0.0-stage → 1.0.20-dev.13

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 (298) hide show
  1. package/COMMERCIAL-LICENSE.md +11 -0
  2. package/LICENSE +47 -0
  3. package/bin/core-notices/CORE-SDK-LICENSE.txt +74 -0
  4. package/bin/core-notices/consumer/README.md +22 -0
  5. package/bin/core-notices/consumer/dbus-MIT.txt +19 -0
  6. package/bin/core-notices/consumer/dbus-secret-service-MIT.txt +25 -0
  7. package/bin/core-notices/consumer/libdbus-COPYING.txt +552 -0
  8. package/bin/core-notices/consumer/libdbus-sys-MIT.txt +19 -0
  9. package/bin/core-notices/dependencies.json +1382 -0
  10. package/bin/core-notices/models/FlagEmbedding-LICENSE.txt +21 -0
  11. package/bin/core-notices/models/bge-m3-MODEL-CARD.md +300 -0
  12. package/bin/core-notices/models/bge-small-zh-v1.5-MODEL-CARD.md +12 -0
  13. package/bin/core-notices/models/sources.json +17 -0
  14. package/bin/core-notices/native/CORE-SDK-NOTICE.txt +5 -0
  15. package/bin/core-notices/native/DirectML-LICENSE-CODE.txt +21 -0
  16. package/bin/core-notices/native/DirectML-LICENSE.txt +48 -0
  17. package/bin/core-notices/native/DirectML-ThirdPartyNotices.txt +103 -0
  18. package/bin/core-notices/native/onnxruntime-LICENSE.txt +21 -0
  19. package/bin/core-notices/native/onnxruntime-ThirdPartyNotices.txt +6508 -0
  20. package/bin/core-notices/rust/COPYRIGHT.html +278689 -0
  21. package/bin/core-notices/rust/adler2-2.0.1/LICENSE-0BSD +12 -0
  22. package/bin/core-notices/rust/adler2-2.0.1/LICENSE-APACHE +201 -0
  23. package/bin/core-notices/rust/adler2-2.0.1/LICENSE-MIT +23 -0
  24. package/bin/core-notices/rust/ahash-0.8.12/LICENSE-APACHE +201 -0
  25. package/bin/core-notices/rust/ahash-0.8.12/LICENSE-MIT +25 -0
  26. package/bin/core-notices/rust/aho-corasick-1.1.5/COPYING +3 -0
  27. package/bin/core-notices/rust/aho-corasick-1.1.5/LICENSE-MIT +21 -0
  28. package/bin/core-notices/rust/anyhow-1.0.104/LICENSE-APACHE +176 -0
  29. package/bin/core-notices/rust/anyhow-1.0.104/LICENSE-MIT +23 -0
  30. package/bin/core-notices/rust/autocfg-1.5.1/LICENSE-APACHE +201 -0
  31. package/bin/core-notices/rust/autocfg-1.5.1/LICENSE-MIT +25 -0
  32. package/bin/core-notices/rust/base64-0.13.1/LICENSE-APACHE +201 -0
  33. package/bin/core-notices/rust/base64-0.13.1/LICENSE-MIT +21 -0
  34. package/bin/core-notices/rust/base64-0.22.1/LICENSE-APACHE +201 -0
  35. package/bin/core-notices/rust/base64-0.22.1/LICENSE-MIT +21 -0
  36. package/bin/core-notices/rust/base64-0.23.1/LICENSE-APACHE +201 -0
  37. package/bin/core-notices/rust/base64-0.23.1/LICENSE-MIT +21 -0
  38. package/bin/core-notices/rust/base64ct-1.8.3/LICENSE-APACHE +201 -0
  39. package/bin/core-notices/rust/base64ct-1.8.3/LICENSE-MIT +26 -0
  40. package/bin/core-notices/rust/bitflags-2.13.2/LICENSE-APACHE +201 -0
  41. package/bin/core-notices/rust/bitflags-2.13.2/LICENSE-MIT +25 -0
  42. package/bin/core-notices/rust/block-buffer-0.10.4/LICENSE-APACHE +201 -0
  43. package/bin/core-notices/rust/block-buffer-0.10.4/LICENSE-MIT +25 -0
  44. package/bin/core-notices/rust/byteorder-1.5.0/COPYING +3 -0
  45. package/bin/core-notices/rust/byteorder-1.5.0/LICENSE-MIT +21 -0
  46. package/bin/core-notices/rust/bytes-1.12.1/LICENSE +25 -0
  47. package/bin/core-notices/rust/castaway-0.2.4/LICENSE +21 -0
  48. package/bin/core-notices/rust/cc-1.4.7/LICENSE-APACHE +201 -0
  49. package/bin/core-notices/rust/cc-1.4.7/LICENSE-MIT +25 -0
  50. package/bin/core-notices/rust/cfg-if-1.0.5/LICENSE-APACHE +201 -0
  51. package/bin/core-notices/rust/cfg-if-1.0.5/LICENSE-MIT +25 -0
  52. package/bin/core-notices/rust/chrono-0.4.45/LICENSE.txt +240 -0
  53. package/bin/core-notices/rust/compact_str-0.9.1/LICENSE +21 -0
  54. package/bin/core-notices/rust/core-foundation-0.10.1/LICENSE-APACHE +201 -0
  55. package/bin/core-notices/rust/core-foundation-0.10.1/LICENSE-MIT +25 -0
  56. package/bin/core-notices/rust/core-foundation-sys-0.8.7/LICENSE-APACHE +201 -0
  57. package/bin/core-notices/rust/core-foundation-sys-0.8.7/LICENSE-MIT +25 -0
  58. package/bin/core-notices/rust/cpufeatures-0.2.17/LICENSE-APACHE +201 -0
  59. package/bin/core-notices/rust/cpufeatures-0.2.17/LICENSE-MIT +25 -0
  60. package/bin/core-notices/rust/crc32fast-1.5.2/LICENSE-APACHE +202 -0
  61. package/bin/core-notices/rust/crc32fast-1.5.2/LICENSE-MIT +21 -0
  62. package/bin/core-notices/rust/crossbeam-deque-0.8.8/LICENSE-APACHE +201 -0
  63. package/bin/core-notices/rust/crossbeam-deque-0.8.8/LICENSE-MIT +27 -0
  64. package/bin/core-notices/rust/crossbeam-epoch-0.9.21/LICENSE-APACHE +201 -0
  65. package/bin/core-notices/rust/crossbeam-epoch-0.9.21/LICENSE-MIT +27 -0
  66. package/bin/core-notices/rust/crossbeam-utils-0.8.23/LICENSE-APACHE +201 -0
  67. package/bin/core-notices/rust/crossbeam-utils-0.8.23/LICENSE-MIT +27 -0
  68. package/bin/core-notices/rust/crypto-common-0.1.7/LICENSE-APACHE +201 -0
  69. package/bin/core-notices/rust/crypto-common-0.1.7/LICENSE-MIT +25 -0
  70. package/bin/core-notices/rust/daachorse-3.0.3/LICENSE-APACHE +176 -0
  71. package/bin/core-notices/rust/daachorse-3.0.3/LICENSE-MIT +23 -0
  72. package/bin/core-notices/rust/darling-0.20.11/LICENSE +21 -0
  73. package/bin/core-notices/rust/darling_core-0.20.11/LICENSE +21 -0
  74. package/bin/core-notices/rust/darling_macro-0.20.11/LICENSE +21 -0
  75. package/bin/core-notices/rust/dary_heap-0.3.9/LICENSE-APACHE +176 -0
  76. package/bin/core-notices/rust/dary_heap-0.3.9/LICENSE-MIT +23 -0
  77. package/bin/core-notices/rust/der-0.8.2/LICENSE-APACHE +201 -0
  78. package/bin/core-notices/rust/der-0.8.2/LICENSE-MIT +25 -0
  79. package/bin/core-notices/rust/derive_builder-0.20.2/LICENSE-APACHE +202 -0
  80. package/bin/core-notices/rust/derive_builder-0.20.2/LICENSE-MIT +21 -0
  81. package/bin/core-notices/rust/derive_builder_core-0.20.2/LICENSE-APACHE +202 -0
  82. package/bin/core-notices/rust/derive_builder_core-0.20.2/LICENSE-MIT +21 -0
  83. package/bin/core-notices/rust/derive_builder_macro-0.20.2/LICENSE-APACHE +202 -0
  84. package/bin/core-notices/rust/derive_builder_macro-0.20.2/LICENSE-MIT +21 -0
  85. package/bin/core-notices/rust/digest-0.10.7/LICENSE-APACHE +201 -0
  86. package/bin/core-notices/rust/digest-0.10.7/LICENSE-MIT +25 -0
  87. package/bin/core-notices/rust/either-1.18.0/LICENSE-APACHE +201 -0
  88. package/bin/core-notices/rust/either-1.18.0/LICENSE-MIT +25 -0
  89. package/bin/core-notices/rust/errno-0.3.14/LICENSE-APACHE +201 -0
  90. package/bin/core-notices/rust/errno-0.3.14/LICENSE-MIT +25 -0
  91. package/bin/core-notices/rust/esaxx-rs-0.1.10/LICENSE +201 -0
  92. package/bin/core-notices/rust/fastrand-2.5.0/LICENSE-APACHE +201 -0
  93. package/bin/core-notices/rust/fastrand-2.5.0/LICENSE-MIT +23 -0
  94. package/bin/core-notices/rust/find-msvc-tools-0.1.13/LICENSE-APACHE +201 -0
  95. package/bin/core-notices/rust/find-msvc-tools-0.1.13/LICENSE-MIT +25 -0
  96. package/bin/core-notices/rust/flate2-1.1.10/LICENSE-APACHE +201 -0
  97. package/bin/core-notices/rust/flate2-1.1.10/LICENSE-MIT +25 -0
  98. package/bin/core-notices/rust/fnv-1.0.7/LICENSE-APACHE +201 -0
  99. package/bin/core-notices/rust/fnv-1.0.7/LICENSE-MIT +25 -0
  100. package/bin/core-notices/rust/generic-array-0.14.7/LICENSE +21 -0
  101. package/bin/core-notices/rust/getrandom-0.2.17/LICENSE-APACHE +201 -0
  102. package/bin/core-notices/rust/getrandom-0.2.17/LICENSE-MIT +26 -0
  103. package/bin/core-notices/rust/getrandom-0.3.4/LICENSE-APACHE +201 -0
  104. package/bin/core-notices/rust/getrandom-0.3.4/LICENSE-MIT +26 -0
  105. package/bin/core-notices/rust/getrandom-0.4.3/LICENSE-APACHE +201 -0
  106. package/bin/core-notices/rust/getrandom-0.4.3/LICENSE-MIT +26 -0
  107. package/bin/core-notices/rust/hmac-sha256-1.1.14/LICENSE +15 -0
  108. package/bin/core-notices/rust/http-1.5.0/LICENSE-APACHE +201 -0
  109. package/bin/core-notices/rust/http-1.5.0/LICENSE-MIT +25 -0
  110. package/bin/core-notices/rust/httparse-1.10.1/LICENSE-APACHE +201 -0
  111. package/bin/core-notices/rust/httparse-1.10.1/LICENSE-MIT +20 -0
  112. package/bin/core-notices/rust/iana-time-zone-0.1.65/LICENSE-APACHE +201 -0
  113. package/bin/core-notices/rust/iana-time-zone-0.1.65/LICENSE-MIT +25 -0
  114. package/bin/core-notices/rust/ident_case-1.0.1/LICENSE +19 -0
  115. package/bin/core-notices/rust/itertools-0.14.0/LICENSE-APACHE +201 -0
  116. package/bin/core-notices/rust/itertools-0.14.0/LICENSE-MIT +25 -0
  117. package/bin/core-notices/rust/itoa-1.0.18/LICENSE-APACHE +176 -0
  118. package/bin/core-notices/rust/itoa-1.0.18/LICENSE-MIT +23 -0
  119. package/bin/core-notices/rust/libc-0.2.189/LICENSE-APACHE +176 -0
  120. package/bin/core-notices/rust/libc-0.2.189/LICENSE-MIT +25 -0
  121. package/bin/core-notices/rust/log-0.4.34/LICENSE-APACHE +201 -0
  122. package/bin/core-notices/rust/log-0.4.34/LICENSE-MIT +25 -0
  123. package/bin/core-notices/rust/lzma-rust2-0.15.8/LICENSE +201 -0
  124. package/bin/core-notices/rust/macro_rules_attribute-0.2.3/LICENSE-APACHE +201 -0
  125. package/bin/core-notices/rust/macro_rules_attribute-0.2.3/LICENSE-MIT +21 -0
  126. package/bin/core-notices/rust/macro_rules_attribute-0.2.3/LICENSE-ZLIB +19 -0
  127. package/bin/core-notices/rust/macro_rules_attribute-proc_macro-0.2.3/LICENSE-APACHE +201 -0
  128. package/bin/core-notices/rust/macro_rules_attribute-proc_macro-0.2.3/LICENSE-MIT +21 -0
  129. package/bin/core-notices/rust/macro_rules_attribute-proc_macro-0.2.3/LICENSE-ZLIB +19 -0
  130. package/bin/core-notices/rust/matrixmultiply-0.3.11/LICENSE-APACHE +201 -0
  131. package/bin/core-notices/rust/matrixmultiply-0.3.11/LICENSE-MIT +27 -0
  132. package/bin/core-notices/rust/memchr-2.8.3/COPYING +3 -0
  133. package/bin/core-notices/rust/memchr-2.8.3/LICENSE-MIT +21 -0
  134. package/bin/core-notices/rust/minimal-lexical-0.2.1/LICENSE-APACHE +201 -0
  135. package/bin/core-notices/rust/minimal-lexical-0.2.1/LICENSE-MIT +23 -0
  136. package/bin/core-notices/rust/minimal-lexical-0.2.1/LICENSE.md +37 -0
  137. package/bin/core-notices/rust/miniz_oxide-0.9.1/LICENSE +25 -0
  138. package/bin/core-notices/rust/miniz_oxide-0.9.1/LICENSE-APACHE.md +177 -0
  139. package/bin/core-notices/rust/miniz_oxide-0.9.1/LICENSE-MIT.md +24 -0
  140. package/bin/core-notices/rust/miniz_oxide-0.9.1/LICENSE-ZLIB.md +14 -0
  141. package/bin/core-notices/rust/monostate-0.1.18/LICENSE-APACHE +176 -0
  142. package/bin/core-notices/rust/monostate-0.1.18/LICENSE-MIT +23 -0
  143. package/bin/core-notices/rust/monostate-impl-0.1.18/LICENSE-APACHE +176 -0
  144. package/bin/core-notices/rust/monostate-impl-0.1.18/LICENSE-MIT +23 -0
  145. package/bin/core-notices/rust/native-tls-0.2.18/LICENSE-APACHE +202 -0
  146. package/bin/core-notices/rust/native-tls-0.2.18/LICENSE-MIT +19 -0
  147. package/bin/core-notices/rust/ndarray-0.17.2/LICENSE-APACHE +201 -0
  148. package/bin/core-notices/rust/ndarray-0.17.2/LICENSE-MIT +27 -0
  149. package/bin/core-notices/rust/nom-7.1.3/LICENSE +20 -0
  150. package/bin/core-notices/rust/num-complex-0.4.6/LICENSE-APACHE +201 -0
  151. package/bin/core-notices/rust/num-complex-0.4.6/LICENSE-MIT +25 -0
  152. package/bin/core-notices/rust/num-integer-0.1.47/LICENSE-APACHE +201 -0
  153. package/bin/core-notices/rust/num-integer-0.1.47/LICENSE-MIT +25 -0
  154. package/bin/core-notices/rust/num-traits-0.2.19/LICENSE-APACHE +201 -0
  155. package/bin/core-notices/rust/num-traits-0.2.19/LICENSE-MIT +25 -0
  156. package/bin/core-notices/rust/once_cell-1.21.4/LICENSE-APACHE +201 -0
  157. package/bin/core-notices/rust/once_cell-1.21.4/LICENSE-MIT +23 -0
  158. package/bin/core-notices/rust/onig-6.5.3/LICENSE.md +29 -0
  159. package/bin/core-notices/rust/onig_sys-69.9.3/LICENSE.md +30 -0
  160. package/bin/core-notices/rust/onig_sys-69.9.3/oniguruma/COPYING +26 -0
  161. package/bin/core-notices/rust/ort-2.0.0-rc.13/LICENSE-APACHE +202 -0
  162. package/bin/core-notices/rust/ort-2.0.0-rc.13/LICENSE-MIT +22 -0
  163. package/bin/core-notices/rust/ort-sys-2.0.0-rc.13/LICENSE-APACHE +202 -0
  164. package/bin/core-notices/rust/ort-sys-2.0.0-rc.13/LICENSE-MIT +22 -0
  165. package/bin/core-notices/rust/paste-1.0.15/LICENSE-APACHE +176 -0
  166. package/bin/core-notices/rust/paste-1.0.15/LICENSE-MIT +23 -0
  167. package/bin/core-notices/rust/pastey-0.2.3/LICENSE-APACHE +176 -0
  168. package/bin/core-notices/rust/pastey-0.2.3/LICENSE-MIT +23 -0
  169. package/bin/core-notices/rust/pem-rfc7468-1.0.0/LICENSE-APACHE +201 -0
  170. package/bin/core-notices/rust/pem-rfc7468-1.0.0/LICENSE-MIT +25 -0
  171. package/bin/core-notices/rust/percent-encoding-2.3.2/LICENSE-APACHE +201 -0
  172. package/bin/core-notices/rust/percent-encoding-2.3.2/LICENSE-MIT +25 -0
  173. package/bin/core-notices/rust/pin-project-lite-0.2.17/LICENSE-APACHE +177 -0
  174. package/bin/core-notices/rust/pin-project-lite-0.2.17/LICENSE-MIT +23 -0
  175. package/bin/core-notices/rust/pkg-config-0.3.34/LICENSE-APACHE +201 -0
  176. package/bin/core-notices/rust/pkg-config-0.3.34/LICENSE-MIT +25 -0
  177. package/bin/core-notices/rust/ppv-lite86-0.2.21/LICENSE-APACHE +201 -0
  178. package/bin/core-notices/rust/ppv-lite86-0.2.21/LICENSE-MIT +25 -0
  179. package/bin/core-notices/rust/proc-macro2-1.0.107/LICENSE-APACHE +176 -0
  180. package/bin/core-notices/rust/proc-macro2-1.0.107/LICENSE-MIT +23 -0
  181. package/bin/core-notices/rust/quote-1.0.47/LICENSE-APACHE +176 -0
  182. package/bin/core-notices/rust/quote-1.0.47/LICENSE-MIT +23 -0
  183. package/bin/core-notices/rust/rand-0.9.5/COPYRIGHT +12 -0
  184. package/bin/core-notices/rust/rand-0.9.5/LICENSE-APACHE +176 -0
  185. package/bin/core-notices/rust/rand-0.9.5/LICENSE-MIT +26 -0
  186. package/bin/core-notices/rust/rand_chacha-0.9.0/COPYRIGHT +12 -0
  187. package/bin/core-notices/rust/rand_chacha-0.9.0/LICENSE-APACHE +176 -0
  188. package/bin/core-notices/rust/rand_chacha-0.9.0/LICENSE-MIT +26 -0
  189. package/bin/core-notices/rust/rand_core-0.6.4/COPYRIGHT +12 -0
  190. package/bin/core-notices/rust/rand_core-0.6.4/LICENSE-APACHE +187 -0
  191. package/bin/core-notices/rust/rand_core-0.6.4/LICENSE-MIT +26 -0
  192. package/bin/core-notices/rust/rand_core-0.9.5/COPYRIGHT +12 -0
  193. package/bin/core-notices/rust/rand_core-0.9.5/LICENSE-APACHE +187 -0
  194. package/bin/core-notices/rust/rand_core-0.9.5/LICENSE-MIT +26 -0
  195. package/bin/core-notices/rust/rawpointer-0.2.1/LICENSE-APACHE +201 -0
  196. package/bin/core-notices/rust/rawpointer-0.2.1/LICENSE-MIT +25 -0
  197. package/bin/core-notices/rust/rayon-1.12.0/LICENSE-APACHE +201 -0
  198. package/bin/core-notices/rust/rayon-1.12.0/LICENSE-MIT +25 -0
  199. package/bin/core-notices/rust/rayon-cond-0.4.0/LICENSE-APACHE +201 -0
  200. package/bin/core-notices/rust/rayon-cond-0.4.0/LICENSE-MIT +25 -0
  201. package/bin/core-notices/rust/rayon-core-1.13.0/LICENSE-APACHE +201 -0
  202. package/bin/core-notices/rust/rayon-core-1.13.0/LICENSE-MIT +25 -0
  203. package/bin/core-notices/rust/regex-1.13.1/LICENSE-APACHE +201 -0
  204. package/bin/core-notices/rust/regex-1.13.1/LICENSE-MIT +25 -0
  205. package/bin/core-notices/rust/regex-automata-0.4.18/LICENSE-APACHE +201 -0
  206. package/bin/core-notices/rust/regex-automata-0.4.18/LICENSE-MIT +25 -0
  207. package/bin/core-notices/rust/regex-syntax-0.8.11/LICENSE-APACHE +201 -0
  208. package/bin/core-notices/rust/regex-syntax-0.8.11/LICENSE-MIT +25 -0
  209. package/bin/core-notices/rust/regex-syntax-0.8.11/src/unicode_tables/LICENSE-UNICODE +57 -0
  210. package/bin/core-notices/rust/rustix-1.1.4/COPYRIGHT +29 -0
  211. package/bin/core-notices/rust/rustix-1.1.4/LICENSE-APACHE +201 -0
  212. package/bin/core-notices/rust/rustix-1.1.4/LICENSE-Apache-2.0_WITH_LLVM-exception +220 -0
  213. package/bin/core-notices/rust/rustix-1.1.4/LICENSE-MIT +23 -0
  214. package/bin/core-notices/rust/rustls-pki-types-1.15.1/LICENSE-APACHE +201 -0
  215. package/bin/core-notices/rust/rustls-pki-types-1.15.1/LICENSE-MIT +25 -0
  216. package/bin/core-notices/rust/rustversion-1.0.23/LICENSE-APACHE +176 -0
  217. package/bin/core-notices/rust/rustversion-1.0.23/LICENSE-MIT +23 -0
  218. package/bin/core-notices/rust/ryu-1.0.23/LICENSE-APACHE +176 -0
  219. package/bin/core-notices/rust/ryu-1.0.23/LICENSE-BOOST +23 -0
  220. package/bin/core-notices/rust/security-framework-3.7.0/LICENSE-APACHE +201 -0
  221. package/bin/core-notices/rust/security-framework-3.7.0/LICENSE-MIT +20 -0
  222. package/bin/core-notices/rust/security-framework-sys-2.17.0/LICENSE-APACHE +201 -0
  223. package/bin/core-notices/rust/security-framework-sys-2.17.0/LICENSE-MIT +20 -0
  224. package/bin/core-notices/rust/serde-1.0.229/LICENSE-APACHE +176 -0
  225. package/bin/core-notices/rust/serde-1.0.229/LICENSE-MIT +23 -0
  226. package/bin/core-notices/rust/serde_core-1.0.229/LICENSE-APACHE +176 -0
  227. package/bin/core-notices/rust/serde_core-1.0.229/LICENSE-MIT +23 -0
  228. package/bin/core-notices/rust/serde_derive-1.0.229/LICENSE-APACHE +176 -0
  229. package/bin/core-notices/rust/serde_derive-1.0.229/LICENSE-MIT +23 -0
  230. package/bin/core-notices/rust/serde_json-1.0.151/LICENSE-APACHE +176 -0
  231. package/bin/core-notices/rust/serde_json-1.0.151/LICENSE-MIT +23 -0
  232. package/bin/core-notices/rust/sha2-0.10.9/LICENSE-APACHE +201 -0
  233. package/bin/core-notices/rust/sha2-0.10.9/LICENSE-MIT +27 -0
  234. package/bin/core-notices/rust/shlex-2.0.1/LICENSE-APACHE +13 -0
  235. package/bin/core-notices/rust/shlex-2.0.1/LICENSE-MIT +21 -0
  236. package/bin/core-notices/rust/simd-adler32-0.3.10/LICENSE.md +21 -0
  237. package/bin/core-notices/rust/smallvec-1.16.1/LICENSE-APACHE +201 -0
  238. package/bin/core-notices/rust/smallvec-1.16.1/LICENSE-MIT +25 -0
  239. package/bin/core-notices/rust/socks-0.3.4/LICENSE-APACHE +202 -0
  240. package/bin/core-notices/rust/socks-0.3.4/LICENSE-MIT +19 -0
  241. package/bin/core-notices/rust/spm_precompiled-0.1.4/LICENSE +201 -0
  242. package/bin/core-notices/rust/static_assertions-1.1.0/LICENSE-APACHE +202 -0
  243. package/bin/core-notices/rust/static_assertions-1.1.0/LICENSE-MIT +21 -0
  244. package/bin/core-notices/rust/strsim-0.11.1/LICENSE +23 -0
  245. package/bin/core-notices/rust/subtle-2.6.1/LICENSE +29 -0
  246. package/bin/core-notices/rust/syn-2.0.119/LICENSE-APACHE +176 -0
  247. package/bin/core-notices/rust/syn-2.0.119/LICENSE-MIT +23 -0
  248. package/bin/core-notices/rust/syn-3.0.6/LICENSE-APACHE +176 -0
  249. package/bin/core-notices/rust/syn-3.0.6/LICENSE-MIT +23 -0
  250. package/bin/core-notices/rust/tempfile-3.27.0/LICENSE-APACHE +201 -0
  251. package/bin/core-notices/rust/tempfile-3.27.0/LICENSE-MIT +25 -0
  252. package/bin/core-notices/rust/thiserror-2.0.20/LICENSE-APACHE +176 -0
  253. package/bin/core-notices/rust/thiserror-2.0.20/LICENSE-MIT +23 -0
  254. package/bin/core-notices/rust/thiserror-impl-2.0.20/LICENSE-APACHE +176 -0
  255. package/bin/core-notices/rust/thiserror-impl-2.0.20/LICENSE-MIT +23 -0
  256. package/bin/core-notices/rust/tokenizers-0.23.2/LICENSE +201 -0
  257. package/bin/core-notices/rust/tracing-0.1.44/LICENSE +25 -0
  258. package/bin/core-notices/rust/tracing-core-0.1.36/LICENSE +25 -0
  259. package/bin/core-notices/rust/tracing-core-0.1.36/src/spin/LICENSE +21 -0
  260. package/bin/core-notices/rust/typenum-1.20.1/LICENSE +1 -0
  261. package/bin/core-notices/rust/typenum-1.20.1/LICENSE-APACHE +201 -0
  262. package/bin/core-notices/rust/typenum-1.20.1/LICENSE-MIT +21 -0
  263. package/bin/core-notices/rust/unicode-ident-1.0.26/LICENSE-APACHE +176 -0
  264. package/bin/core-notices/rust/unicode-ident-1.0.26/LICENSE-MIT +23 -0
  265. package/bin/core-notices/rust/unicode-ident-1.0.26/LICENSE-UNICODE +39 -0
  266. package/bin/core-notices/rust/unicode-normalization-alignments-0.1.12/COPYRIGHT +7 -0
  267. package/bin/core-notices/rust/unicode-normalization-alignments-0.1.12/LICENSE-APACHE +201 -0
  268. package/bin/core-notices/rust/unicode-normalization-alignments-0.1.12/LICENSE-MIT +25 -0
  269. package/bin/core-notices/rust/unicode-segmentation-1.13.3/COPYRIGHT +7 -0
  270. package/bin/core-notices/rust/unicode-segmentation-1.13.3/LICENSE-APACHE +201 -0
  271. package/bin/core-notices/rust/unicode-segmentation-1.13.3/LICENSE-MIT +25 -0
  272. package/bin/core-notices/rust/unicode-width-0.2.0/COPYRIGHT +7 -0
  273. package/bin/core-notices/rust/unicode-width-0.2.0/LICENSE-APACHE +201 -0
  274. package/bin/core-notices/rust/unicode-width-0.2.0/LICENSE-MIT +25 -0
  275. package/bin/core-notices/rust/unicode_categories-0.1.1/LICENSE-APACHE +202 -0
  276. package/bin/core-notices/rust/unicode_categories-0.1.1/LICENSE-MIT +19 -0
  277. package/bin/core-notices/rust/ureq-3.4.2/LICENSE-APACHE +201 -0
  278. package/bin/core-notices/rust/ureq-3.4.2/LICENSE-MIT +21 -0
  279. package/bin/core-notices/rust/ureq-proto-0.6.4/LICENSE-APACHE.txt +202 -0
  280. package/bin/core-notices/rust/ureq-proto-0.6.4/LICENSE-MIT.txt +7 -0
  281. package/bin/core-notices/rust/utf8-zero-0.8.1/LICENSE-APACHE +176 -0
  282. package/bin/core-notices/rust/utf8-zero-0.8.1/LICENSE-MIT +23 -0
  283. package/bin/core-notices/rust/version_check-0.9.5/LICENSE-APACHE +201 -0
  284. package/bin/core-notices/rust/version_check-0.9.5/LICENSE-MIT +19 -0
  285. package/bin/core-notices/rust/webpki-root-certs-1.0.9/LICENSE +61 -0
  286. package/bin/core-notices/rust/zerocopy-0.8.57/LICENSE-APACHE +202 -0
  287. package/bin/core-notices/rust/zerocopy-0.8.57/LICENSE-BSD +24 -0
  288. package/bin/core-notices/rust/zerocopy-0.8.57/LICENSE-MIT +26 -0
  289. package/bin/core-notices/rust/zeroize-1.9.0/LICENSE-APACHE +202 -0
  290. package/bin/core-notices/rust/zeroize-1.9.0/LICENSE-MIT +25 -0
  291. package/bin/core-notices/rust/zlib-rs-0.6.8/LICENSE +19 -0
  292. package/bin/core-notices/rust/zmij-1.0.23/LICENSE-MIT +23 -0
  293. package/bin/core-runtime.json +1176 -0
  294. package/bin/libonnxruntime.1.20.1.dylib +0 -0
  295. package/bin/libonnxruntime.dylib +0 -0
  296. package/bin/rsrs +0 -0
  297. package/package.json +22 -4
  298. package/README.md +0 -3
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2022 staoxiao
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,300 @@
1
+ ---
2
+ pipeline_tag: sentence-similarity
3
+ tags:
4
+ - sentence-transformers
5
+ - feature-extraction
6
+ - sentence-similarity
7
+ license: mit
8
+ ---
9
+
10
+ For more details please refer to our github repo: https://github.com/FlagOpen/FlagEmbedding
11
+
12
+ # BGE-M3 ([paper](https://arxiv.org/pdf/2402.03216.pdf), [code](https://github.com/FlagOpen/FlagEmbedding/tree/master/FlagEmbedding/BGE_M3))
13
+
14
+ In this project, we introduce BGE-M3, which is distinguished for its versatility in Multi-Functionality, Multi-Linguality, and Multi-Granularity.
15
+ - Multi-Functionality: It can simultaneously perform the three common retrieval functionalities of embedding model: dense retrieval, multi-vector retrieval, and sparse retrieval.
16
+ - Multi-Linguality: It can support more than 100 working languages.
17
+ - Multi-Granularity: It is able to process inputs of different granularities, spanning from short sentences to long documents of up to 8192 tokens.
18
+
19
+
20
+
21
+ **Some suggestions for retrieval pipeline in RAG**
22
+
23
+ We recommend to use the following pipeline: hybrid retrieval + re-ranking.
24
+ - Hybrid retrieval leverages the strengths of various methods, offering higher accuracy and stronger generalization capabilities.
25
+ A classic example: using both embedding retrieval and the BM25 algorithm.
26
+ Now, you can try to use BGE-M3, which supports both embedding and sparse retrieval.
27
+ This allows you to obtain token weights (similar to the BM25) without any additional cost when generate dense embeddings.
28
+ To use hybrid retrieval, you can refer to [Vespa](https://github.com/vespa-engine/pyvespa/blob/master/docs/sphinx/source/examples/mother-of-all-embedding-models-cloud.ipynb
29
+ ) and [Milvus](https://github.com/milvus-io/pymilvus/blob/master/examples/hello_hybrid_sparse_dense.py).
30
+
31
+ - As cross-encoder models, re-ranker demonstrates higher accuracy than bi-encoder embedding model.
32
+ Utilizing the re-ranking model (e.g., [bge-reranker](https://github.com/FlagOpen/FlagEmbedding/tree/master/FlagEmbedding/reranker), [bge-reranker-v2](https://github.com/FlagOpen/FlagEmbedding/tree/master/FlagEmbedding/llm_reranker)) after retrieval can further filter the selected text.
33
+
34
+
35
+ ## News:
36
+ - 2024/7/1: **We update the MIRACL evaluation results of BGE-M3**. To reproduce the new results, you can refer to: [bge-m3_miracl_2cr](https://huggingface.co/datasets/hanhainebula/bge-m3_miracl_2cr). We have also updated our [paper](https://arxiv.org/pdf/2402.03216) on arXiv.
37
+ <details>
38
+ <summary> Details </summary>
39
+
40
+ The previous test results were lower because we mistakenly removed the passages that have the same id as the query from the search results. After correcting this mistake, the overall performance of BGE-M3 on MIRACL is higher than the previous results, but the experimental conclusion remains unchanged. The other results are not affected by this mistake. To reproduce the previous lower results, you need to add the `--remove-query` parameter when using `pyserini.search.faiss` or `pyserini.search.lucene` to search the passages.
41
+
42
+ </details>
43
+ - 2024/3/20: **Thanks Milvus team!** Now you can use hybrid retrieval of bge-m3 in Milvus: [pymilvus/examples
44
+ /hello_hybrid_sparse_dense.py](https://github.com/milvus-io/pymilvus/blob/master/examples/hello_hybrid_sparse_dense.py).
45
+ - 2024/3/8: **Thanks for the [experimental results](https://towardsdatascience.com/openai-vs-open-source-multilingual-embedding-models-e5ccb7c90f05) from @[Yannael](https://huggingface.co/Yannael). In this benchmark, BGE-M3 achieves top performance in both English and other languages, surpassing models such as OpenAI.**
46
+ - 2024/3/2: Release unified fine-tuning [example](https://github.com/FlagOpen/FlagEmbedding/tree/master/examples/unified_finetune) and [data](https://huggingface.co/datasets/Shitao/bge-m3-data)
47
+ - 2024/2/6: We release the [MLDR](https://huggingface.co/datasets/Shitao/MLDR) (a long document retrieval dataset covering 13 languages) and [evaluation pipeline](https://github.com/FlagOpen/FlagEmbedding/tree/master/C_MTEB/MLDR).
48
+ - 2024/2/1: **Thanks for the excellent tool from Vespa.** You can easily use multiple modes of BGE-M3 following this [notebook](https://github.com/vespa-engine/pyvespa/blob/master/docs/sphinx/source/examples/mother-of-all-embedding-models-cloud.ipynb)
49
+
50
+
51
+ ## Specs
52
+
53
+ - Model
54
+
55
+ | Model Name | Dimension | Sequence Length | Introduction |
56
+ |:----:|:---:|:---:|:---:|
57
+ | [BAAI/bge-m3](https://huggingface.co/BAAI/bge-m3) | 1024 | 8192 | multilingual; unified fine-tuning (dense, sparse, and colbert) from bge-m3-unsupervised|
58
+ | [BAAI/bge-m3-unsupervised](https://huggingface.co/BAAI/bge-m3-unsupervised) | 1024 | 8192 | multilingual; contrastive learning from bge-m3-retromae |
59
+ | [BAAI/bge-m3-retromae](https://huggingface.co/BAAI/bge-m3-retromae) | -- | 8192 | multilingual; extend the max_length of [xlm-roberta](https://huggingface.co/FacebookAI/xlm-roberta-large) to 8192 and further pretrained via [retromae](https://github.com/staoxiao/RetroMAE)|
60
+ | [BAAI/bge-large-en-v1.5](https://huggingface.co/BAAI/bge-large-en-v1.5) | 1024 | 512 | English model |
61
+ | [BAAI/bge-base-en-v1.5](https://huggingface.co/BAAI/bge-base-en-v1.5) | 768 | 512 | English model |
62
+ | [BAAI/bge-small-en-v1.5](https://huggingface.co/BAAI/bge-small-en-v1.5) | 384 | 512 | English model |
63
+
64
+ - Data
65
+
66
+ | Dataset | Introduction |
67
+ |:----------------------------------------------------------:|:-------------------------------------------------:|
68
+ | [MLDR](https://huggingface.co/datasets/Shitao/MLDR) | Docuemtn Retrieval Dataset, covering 13 languages |
69
+ | [bge-m3-data](https://huggingface.co/datasets/Shitao/bge-m3-data) | Fine-tuning data used by bge-m3 |
70
+
71
+
72
+
73
+ ## FAQ
74
+
75
+ **1. Introduction for different retrieval methods**
76
+
77
+ - Dense retrieval: map the text into a single embedding, e.g., [DPR](https://arxiv.org/abs/2004.04906), [BGE-v1.5](https://github.com/FlagOpen/FlagEmbedding)
78
+ - Sparse retrieval (lexical matching): a vector of size equal to the vocabulary, with the majority of positions set to zero, calculating a weight only for tokens present in the text. e.g., BM25, [unicoil](https://arxiv.org/pdf/2106.14807.pdf), and [splade](https://arxiv.org/abs/2107.05720)
79
+ - Multi-vector retrieval: use multiple vectors to represent a text, e.g., [ColBERT](https://arxiv.org/abs/2004.12832).
80
+
81
+
82
+ **2. How to use BGE-M3 in other projects?**
83
+
84
+ For embedding retrieval, you can employ the BGE-M3 model using the same approach as BGE.
85
+ The only difference is that the BGE-M3 model no longer requires adding instructions to the queries.
86
+
87
+ For hybrid retrieval, you can use [Vespa](https://github.com/vespa-engine/pyvespa/blob/master/docs/sphinx/source/examples/mother-of-all-embedding-models-cloud.ipynb
88
+ ) and [Milvus](https://github.com/milvus-io/pymilvus/blob/master/examples/hello_hybrid_sparse_dense.py).
89
+
90
+
91
+ **3. How to fine-tune bge-M3 model?**
92
+
93
+ You can follow the common in this [example](https://github.com/FlagOpen/FlagEmbedding/tree/master/examples/finetune)
94
+ to fine-tune the dense embedding.
95
+
96
+ If you want to fine-tune all embedding function of m3 (dense, sparse and colbert), you can refer to the [unified_fine-tuning example](https://github.com/FlagOpen/FlagEmbedding/tree/master/examples/unified_finetune)
97
+
98
+
99
+
100
+
101
+
102
+
103
+ ## Usage
104
+
105
+ Install:
106
+ ```
107
+ git clone https://github.com/FlagOpen/FlagEmbedding.git
108
+ cd FlagEmbedding
109
+ pip install -e .
110
+ ```
111
+ or:
112
+ ```
113
+ pip install -U FlagEmbedding
114
+ ```
115
+
116
+
117
+
118
+ ### Generate Embedding for text
119
+
120
+ - Dense Embedding
121
+ ```python
122
+ from FlagEmbedding import BGEM3FlagModel
123
+
124
+ model = BGEM3FlagModel('BAAI/bge-m3',
125
+ use_fp16=True) # Setting use_fp16 to True speeds up computation with a slight performance degradation
126
+
127
+ sentences_1 = ["What is BGE M3?", "Defination of BM25"]
128
+ sentences_2 = ["BGE M3 is an embedding model supporting dense retrieval, lexical matching and multi-vector interaction.",
129
+ "BM25 is a bag-of-words retrieval function that ranks a set of documents based on the query terms appearing in each document"]
130
+
131
+ embeddings_1 = model.encode(sentences_1,
132
+ batch_size=12,
133
+ max_length=8192, # If you don't need such a long length, you can set a smaller value to speed up the encoding process.
134
+ )['dense_vecs']
135
+ embeddings_2 = model.encode(sentences_2)['dense_vecs']
136
+ similarity = embeddings_1 @ embeddings_2.T
137
+ print(similarity)
138
+ # [[0.6265, 0.3477], [0.3499, 0.678 ]]
139
+ ```
140
+ You also can use sentence-transformers and huggingface transformers to generate dense embeddings.
141
+ Refer to [baai_general_embedding](https://github.com/FlagOpen/FlagEmbedding/tree/master/FlagEmbedding/baai_general_embedding#usage) for details.
142
+
143
+
144
+ - Sparse Embedding (Lexical Weight)
145
+ ```python
146
+ from FlagEmbedding import BGEM3FlagModel
147
+
148
+ model = BGEM3FlagModel('BAAI/bge-m3', use_fp16=True) # Setting use_fp16 to True speeds up computation with a slight performance degradation
149
+
150
+ sentences_1 = ["What is BGE M3?", "Defination of BM25"]
151
+ sentences_2 = ["BGE M3 is an embedding model supporting dense retrieval, lexical matching and multi-vector interaction.",
152
+ "BM25 is a bag-of-words retrieval function that ranks a set of documents based on the query terms appearing in each document"]
153
+
154
+ output_1 = model.encode(sentences_1, return_dense=True, return_sparse=True, return_colbert_vecs=False)
155
+ output_2 = model.encode(sentences_2, return_dense=True, return_sparse=True, return_colbert_vecs=False)
156
+
157
+ # you can see the weight for each token:
158
+ print(model.convert_id_to_token(output_1['lexical_weights']))
159
+ # [{'What': 0.08356, 'is': 0.0814, 'B': 0.1296, 'GE': 0.252, 'M': 0.1702, '3': 0.2695, '?': 0.04092},
160
+ # {'De': 0.05005, 'fin': 0.1368, 'ation': 0.04498, 'of': 0.0633, 'BM': 0.2515, '25': 0.3335}]
161
+
162
+
163
+ # compute the scores via lexical mathcing
164
+ lexical_scores = model.compute_lexical_matching_score(output_1['lexical_weights'][0], output_2['lexical_weights'][0])
165
+ print(lexical_scores)
166
+ # 0.19554901123046875
167
+
168
+ print(model.compute_lexical_matching_score(output_1['lexical_weights'][0], output_1['lexical_weights'][1]))
169
+ # 0.0
170
+ ```
171
+
172
+ - Multi-Vector (ColBERT)
173
+ ```python
174
+ from FlagEmbedding import BGEM3FlagModel
175
+
176
+ model = BGEM3FlagModel('BAAI/bge-m3', use_fp16=True)
177
+
178
+ sentences_1 = ["What is BGE M3?", "Defination of BM25"]
179
+ sentences_2 = ["BGE M3 is an embedding model supporting dense retrieval, lexical matching and multi-vector interaction.",
180
+ "BM25 is a bag-of-words retrieval function that ranks a set of documents based on the query terms appearing in each document"]
181
+
182
+ output_1 = model.encode(sentences_1, return_dense=True, return_sparse=True, return_colbert_vecs=True)
183
+ output_2 = model.encode(sentences_2, return_dense=True, return_sparse=True, return_colbert_vecs=True)
184
+
185
+ print(model.colbert_score(output_1['colbert_vecs'][0], output_2['colbert_vecs'][0]))
186
+ print(model.colbert_score(output_1['colbert_vecs'][0], output_2['colbert_vecs'][1]))
187
+ # 0.7797
188
+ # 0.4620
189
+ ```
190
+
191
+
192
+ ### Compute score for text pairs
193
+ Input a list of text pairs, you can get the scores computed by different methods.
194
+ ```python
195
+ from FlagEmbedding import BGEM3FlagModel
196
+
197
+ model = BGEM3FlagModel('BAAI/bge-m3', use_fp16=True)
198
+
199
+ sentences_1 = ["What is BGE M3?", "Defination of BM25"]
200
+ sentences_2 = ["BGE M3 is an embedding model supporting dense retrieval, lexical matching and multi-vector interaction.",
201
+ "BM25 is a bag-of-words retrieval function that ranks a set of documents based on the query terms appearing in each document"]
202
+
203
+ sentence_pairs = [[i,j] for i in sentences_1 for j in sentences_2]
204
+
205
+ print(model.compute_score(sentence_pairs,
206
+ max_passage_length=128, # a smaller max length leads to a lower latency
207
+ weights_for_different_modes=[0.4, 0.2, 0.4])) # weights_for_different_modes(w) is used to do weighted sum: w[0]*dense_score + w[1]*sparse_score + w[2]*colbert_score
208
+
209
+ # {
210
+ # 'colbert': [0.7796499729156494, 0.4621465802192688, 0.4523794651031494, 0.7898575067520142],
211
+ # 'sparse': [0.195556640625, 0.00879669189453125, 0.0, 0.1802978515625],
212
+ # 'dense': [0.6259765625, 0.347412109375, 0.349853515625, 0.67822265625],
213
+ # 'sparse+dense': [0.482503205537796, 0.23454029858112335, 0.2332356721162796, 0.5122477412223816],
214
+ # 'colbert+sparse+dense': [0.6013619303703308, 0.3255828022956848, 0.32089319825172424, 0.6232916116714478]
215
+ # }
216
+ ```
217
+
218
+
219
+
220
+
221
+ ## Evaluation
222
+
223
+ We provide the evaluation script for [MKQA](https://github.com/FlagOpen/FlagEmbedding/tree/master/C_MTEB/MKQA) and [MLDR](https://github.com/FlagOpen/FlagEmbedding/tree/master/C_MTEB/MLDR)
224
+
225
+ ### Benchmarks from the open-source community
226
+ ![avatar](./imgs/others.webp)
227
+ The BGE-M3 model emerged as the top performer on this benchmark (OAI is short for OpenAI).
228
+ For more details, please refer to the [article](https://towardsdatascience.com/openai-vs-open-source-multilingual-embedding-models-e5ccb7c90f05) and [Github Repo](https://github.com/Yannael/multilingual-embeddings)
229
+
230
+
231
+ ### Our results
232
+ - Multilingual (Miracl dataset)
233
+
234
+ ![avatar](./imgs/miracl.jpg)
235
+
236
+ - Cross-lingual (MKQA dataset)
237
+
238
+ ![avatar](./imgs/mkqa.jpg)
239
+
240
+ - Long Document Retrieval
241
+ - MLDR:
242
+ ![avatar](./imgs/long.jpg)
243
+ Please note that [MLDR](https://huggingface.co/datasets/Shitao/MLDR) is a document retrieval dataset we constructed via LLM,
244
+ covering 13 languages, including test set, validation set, and training set.
245
+ We utilized the training set from MLDR to enhance the model's long document retrieval capabilities.
246
+ Therefore, comparing baselines with `Dense w.o.long`(fine-tuning without long document dataset) is more equitable.
247
+ Additionally, this long document retrieval dataset will be open-sourced to address the current lack of open-source multilingual long text retrieval datasets.
248
+ We believe that this data will be helpful for the open-source community in training document retrieval models.
249
+
250
+ - NarritiveQA:
251
+ ![avatar](./imgs/nqa.jpg)
252
+
253
+ - Comparison with BM25
254
+
255
+ We utilized Pyserini to implement BM25, and the test results can be reproduced by this [script](https://github.com/FlagOpen/FlagEmbedding/tree/master/C_MTEB/MLDR#bm25-baseline).
256
+ We tested BM25 using two different tokenizers:
257
+ one using Lucene Analyzer and the other using the same tokenizer as M3 (i.e., the tokenizer of xlm-roberta).
258
+ The results indicate that BM25 remains a competitive baseline,
259
+ especially in long document retrieval.
260
+
261
+ ![avatar](./imgs/bm25.jpg)
262
+
263
+
264
+
265
+ ## Training
266
+ - Self-knowledge Distillation: combining multiple outputs from different
267
+ retrieval modes as reward signal to enhance the performance of single mode(especially for sparse retrieval and multi-vec(colbert) retrival)
268
+ - Efficient Batching: Improve the efficiency when fine-tuning on long text.
269
+ The small-batch strategy is simple but effective, which also can used to fine-tune large embedding model.
270
+ - MCLS: A simple method to improve the performance on long text without fine-tuning.
271
+ If you have no enough resource to fine-tuning model with long text, the method is useful.
272
+
273
+ Refer to our [report](https://arxiv.org/pdf/2402.03216.pdf) for more details.
274
+
275
+
276
+
277
+
278
+
279
+
280
+ ## Acknowledgement
281
+
282
+ Thanks to the authors of open-sourced datasets, including Miracl, MKQA, NarritiveQA, etc.
283
+ Thanks to the open-sourced libraries like [Tevatron](https://github.com/texttron/tevatron), [Pyserini](https://github.com/castorini/pyserini).
284
+
285
+
286
+
287
+ ## Citation
288
+
289
+ If you find this repository useful, please consider giving a star :star: and citation
290
+
291
+ ```
292
+ @misc{bge-m3,
293
+ title={BGE M3-Embedding: Multi-Lingual, Multi-Functionality, Multi-Granularity Text Embeddings Through Self-Knowledge Distillation},
294
+ author={Jianlv Chen and Shitao Xiao and Peitian Zhang and Kun Luo and Defu Lian and Zheng Liu},
295
+ year={2024},
296
+ eprint={2402.03216},
297
+ archivePrefix={arXiv},
298
+ primaryClass={cs.CL}
299
+ }
300
+ ```
@@ -0,0 +1,12 @@
1
+ # BGE small Chinese v1.5 preset
2
+
3
+ Upstream: [BAAI/bge-small-zh-v1.5](https://huggingface.co/BAAI/bge-small-zh-v1.5).
4
+ ONNX conversion: [Xenova/bge-small-zh-v1.5](https://huggingface.co/Xenova/bge-small-zh-v1.5/tree/75c43b069aac4d136ba6bc1122f995fedcfd2781).
5
+ MIT license: see the included `FlagEmbedding-LICENSE.txt`.
6
+
7
+ The preset uses 512-dimensional CLS embeddings, L2 normalization, a 512-token
8
+ window and the upstream Chinese retrieval instruction as its query prefix. Documents have
9
+ no prefix. Quantized weights are 24,010,842 bytes with SHA-256
10
+ `15b717c382bcb518ba457b93ea6850ede7f4f1cd8937454aa06972366cd19bcc`.
11
+ The tokenizer is 439,125 bytes with SHA-256
12
+ `48cea5d44424912a6fd1ea647bf4fe50b55ab8b1e5879c3275f80e339e8fae26`.
@@ -0,0 +1,17 @@
1
+ [
2
+ {
3
+ "model": "bge-m3",
4
+ "revision": "5617a9f61b028005a4858fdac845db406aefb181",
5
+ "license": "mit",
6
+ "files": []
7
+ },
8
+ {
9
+ "model": "bge-small-zh-v1.5",
10
+ "repository": "Xenova/bge-small-zh-v1.5",
11
+ "revision": "75c43b069aac4d136ba6bc1122f995fedcfd2781",
12
+ "license": "mit",
13
+ "license_file": "FlagEmbedding-LICENSE.txt",
14
+ "model_card": "bge-small-zh-v1.5-MODEL-CARD.md",
15
+ "files": ["tokenizer.json", "onnx/model_quantized.onnx"]
16
+ }
17
+ ]
@@ -0,0 +1,5 @@
1
+ Respire Core SDK
2
+
3
+ Use and redistribution of the compiled SDK are governed by LICENSE.txt.
4
+ Preserve the accompanying third-party licenses and attribution notices.
5
+ Model weights are distributed separately under their upstream licenses.
@@ -0,0 +1,21 @@
1
+ Copyright (c) Microsoft Corporation.
2
+
3
+ MIT License
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,48 @@
1
+ MICROSOFT SOFTWARE LICENSE TERMS
2
+ MICROSOFT DIRECTX MACHINE LEARNING (DIRECTML)
3
+
4
+ IF YOU LIVE IN (OR ARE A BUSINESS WITH A PRINCIPAL PLACE OF BUSINESS IN) THE UNITED STATES, PLEASE READ THE “BINDING ARBITRATION AND CLASS ACTION WAIVER” SECTION BELOW. IT AFFECTS HOW DISPUTES ARE RESOLVED.
5
+
6
+ These license terms are an agreement between you and Microsoft Corporation (or one of its affiliates). They apply to the software named above and any Microsoft services or software updates (except to the extent such services or updates are accompanied by new or additional terms, in which case those different terms apply prospectively and do not alter your or Microsoft’s rights relating to pre-updated software or services). IF YOU COMPLY WITH THESE LICENSE TERMS, YOU HAVE THE RIGHTS BELOW. BY USING THE SOFTWARE, YOU ACCEPT THESE TERMS.
7
+
8
+ 1. INSTALLATION AND USE RIGHTS.
9
+ a) General. Subject to the terms of this agreement, you may install and use any number of copies of the software, and solely for use on Windows and Xbox. You may copy and distribute the software (i.e. make available for third parties) in applications and services you develop in the build with Machine Learning tools and frameworks, and/or games that run on Windows and Xbox.
10
+ b) Included Microsoft Applications. The software may include other Microsoft applications. These license terms apply to those included applications, if any, unless other license terms are provided with the other Microsoft applications.
11
+ c) Third Party Components. The software may include third party components with separate legal notices or governed by other agreements, as may be described in the ThirdPartyNotices file(s) accompanying the software.
12
+
13
+ 2. DATA.
14
+ a) Data Collection. The software may collect information about you and your use of the software, and send that to Microsoft. Microsoft may use this information to provide services and improve our products and services. You may opt-out of many of these scenarios, but not all, as described in the product documentation. There are also some features in the software that may enable you to collect data from users of your applications. If you use these features to enable data collection in your applications, you must comply with applicable law, including providing appropriate notices to users of your applications. You can learn more about data collection and use in the help documentation and the privacy statement at https://aka.ms/privacy. Your use of the software operates as your consent to these practices.
15
+ b) Processing of Personal Data. To the extent Microsoft is a processor or subprocessor of personal data in connection with the software, Microsoft makes the commitments in the European Union General Data Protection Regulation Terms of the Online Services Terms to all customers effective May 25, 2018, at https://docs.microsoft.com/en-us/legal/gdpr.
16
+
17
+ 3. SCOPE OF LICENSE. The software is licensed, not sold. Microsoft reserves all other rights. Unless applicable law gives you more rights despite this limitation, you will not (and have no right to):
18
+ a) work around any technical limitations in the software that only allow you to use it in certain ways;
19
+ b) reverse engineer, decompile or disassemble the software, or otherwise attempt to derive the source code for the software, except and to the extent required by third party licensing terms governing use of certain open source components that may be included in the software;
20
+ c) remove, minimize, block, or modify any notices of Microsoft or its suppliers in the software;
21
+ d) use the software in any way that is against the law or to create or propagate malware; or
22
+ e) except as expressly stated in Section 1, share, publish, distribute, or lease the software, provide the software as a stand-alone offering for others to use, or transfer the software or this agreement to any third party.
23
+
24
+ 4. EXPORT RESTRICTIONS. You must comply with all domestic and international export laws and regulations that apply to the software, which include restrictions on destinations, end users, and end use. For further information on export restrictions, visit https://aka.ms/exporting.
25
+
26
+ 5. SUPPORT SERVICES. Microsoft is not obligated under this agreement to provide any support services for the software. Any support provided is “as is”, “with all faults”, and without warranty of any kind.
27
+
28
+ 6. UPDATES. The software may periodically check for updates, and download and install them for you. You may obtain updates only from Microsoft or authorized sources. Microsoft may need to update your system to provide you with updates. You agree to receive these automatic updates without any additional notice. Updates may not include or support all existing software features, services, or peripheral devices.
29
+
30
+ 7. BINDING ARBITRATION AND CLASS ACTION WAIVER. This Section applies if you live in (or, if a business, your principal place of business is in) the United States. If you and Microsoft have a dispute, you and Microsoft agree to try for 60 days to resolve it informally. If you and Microsoft can’t, you and Microsoft agree to binding individual arbitration before the American Arbitration Association under the Federal Arbitration Act (“FAA”), and not to sue in court in front of a judge or jury. Instead, a neutral arbitrator will decide. Class action lawsuits, class-wide arbitrations, private attorney-general actions, and any other proceeding where someone acts in a representative capacity are not allowed; nor is combining individual proceedings without the consent of all parties. The complete Arbitration Agreement contains more terms and is at https://aka.ms/arb-agreement-4. You and Microsoft agree to these terms.
31
+
32
+ 8. ENTIRE AGREEMENT. This agreement, and any other terms Microsoft may provide for supplements, updates, or third-party applications, is the entire agreement for the software.
33
+
34
+ 9. APPLICABLE LAW AND PLACE TO RESOLVE DISPUTES. If you acquired the software in the United States or Canada, the laws of the state or province where you live (or, if a business, where your principal place of business is located) govern the interpretation of this agreement, claims for its breach, and all other claims (including consumer protection, unfair competition, and tort claims), regardless of conflict of laws principles, except that the FAA governs everything related to arbitration. If you acquired the software in any other country, its laws apply, except that the FAA governs everything related to arbitration. If U.S. federal jurisdiction exists, you and Microsoft consent to exclusive jurisdiction and venue in the federal court in King County, Washington for all disputes heard in court (excluding arbitration). If not, you and Microsoft consent to exclusive jurisdiction and venue in the Superior Court of King County, Washington for all disputes heard in court (excluding arbitration).
35
+
36
+ 10. CONSUMER RIGHTS; REGIONAL VARIATIONS. This agreement describes certain legal rights. You may have other rights, including consumer rights, under the laws of your state, province, or country. Separate and apart from your relationship with Microsoft, you may also have rights with respect to the party from which you acquired the software. This agreement does not change those other rights if the laws of your state, province, or country do not permit it to do so. For example, if you acquired the software in one of the below regions, or mandatory country law applies, then the following provisions apply to you:
37
+ a) Australia. You have statutory guarantees under the Australian Consumer Law and nothing in this agreement is intended to affect those rights.
38
+ b) Canada. If you acquired this software in Canada, you may stop receiving updates by turning off the automatic update feature, disconnecting your device from the Internet (if and when you re-connect to the Internet, however, the software will resume checking for and installing updates), or uninstalling the software. The product documentation, if any, may also specify how to turn off updates for your specific device or software.
39
+ c) Germany and Austria.
40
+ i. Warranty. The properly licensed software will perform substantially as described in any Microsoft materials that accompany the software. However, Microsoft gives no contractual guarantee in relation to the licensed software.
41
+ ii. Limitation of Liability. In case of intentional conduct, gross negligence, claims based on the Product Liability Act, as well as, in case of death or personal or physical injury, Microsoft is liable according to the statutory law.
42
+ Subject to the foregoing clause ii., Microsoft will only be liable for slight negligence if Microsoft is in breach of such material contractual obligations, the fulfillment of which facilitate the due performance of this agreement, the breach of which would endanger the purpose of this agreement and the compliance with which a party may constantly trust in (so-called "cardinal obligations"). In other cases of slight negligence, Microsoft will not be liable for slight negligence.
43
+
44
+ 11. DISCLAIMER OF WARRANTY. THE SOFTWARE IS LICENSED “AS IS.” YOU BEAR THE RISK OF USING IT. MICROSOFT GIVES NO EXPRESS WARRANTIES, GUARANTEES, OR CONDITIONS. TO THE EXTENT PERMITTED UNDER APPLICABLE LAWS, MICROSOFT EXCLUDES ALL IMPLIED WARRANTIES, INCLUDING MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NON-INFRINGEMENT.
45
+
46
+ 12. LIMITATION ON AND EXCLUSION OF DAMAGES. IF YOU HAVE ANY BASIS FOR RECOVERING DAMAGES DESPITE THE PRECEDING DISCLAIMER OF WARRANTY, YOU CAN RECOVER FROM MICROSOFT AND ITS SUPPLIERS ONLY DIRECT DAMAGES UP TO U.S. $5.00. YOU CANNOT RECOVER ANY OTHER DAMAGES, INCLUDING CONSEQUENTIAL, LOST PROFITS, SPECIAL, INDIRECT OR INCIDENTAL DAMAGES.
47
+ This limitation applies to (a) anything related to the software, services, content (including code) on third party Internet sites, or third party applications; and (b) claims for breach of contract, warranty, guarantee, or condition; strict liability, negligence, or other tort; or any other claim; in each case to the extent permitted by applicable law.
48
+ It also applies even if Microsoft knew or should have known about the possibility of the damages. The above limitation or exclusion may not apply to you because your state, province, or country may not allow the exclusion or limitation of incidental, consequential, or other damages.
@@ -0,0 +1,103 @@
1
+ THIRD PARTY SOFTWARE NOTICES AND INFORMATION
2
+
3
+ Do Not Translate or Localize
4
+
5
+ This software incorporates material from third parties. Microsoft makes certain
6
+ open source code available at https://3rdpartysource.microsoft.com, or you may
7
+ send a check or money order for US $5.00, including the product name, the open
8
+ source component name, platform, and version number, to:
9
+
10
+ Source Code Compliance Team
11
+ Microsoft Corporation
12
+ One Microsoft Way
13
+ Redmond, WA 98052
14
+ USA
15
+
16
+ Notwithstanding any other terms, you may reverse engineer this software to the
17
+ extent required to debug changes to any libraries licensed under the GNU Lesser
18
+ General Public License.
19
+
20
+ _____
21
+
22
+ Microsoft/GSL
23
+
24
+ Copyright (c) 2015 Microsoft Corporation. All rights reserved.
25
+
26
+ This code is licensed under the MIT License (MIT).
27
+
28
+ Permission is hereby granted, free of charge, to any person obtaining a copy
29
+ of this software and associated documentation files (the "Software"), to deal
30
+ in the Software without restriction, including without limitation the rights
31
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
32
+ of the Software, and to permit persons to whom the Software is furnished to do
33
+ so, subject to the following conditions:
34
+
35
+ The above copyright notice and this permission notice shall be included in all
36
+ copies or substantial portions of the Software.
37
+
38
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
39
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
40
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
41
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
42
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
43
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
44
+ THE SOFTWARE.
45
+
46
+ _____
47
+
48
+ http://half.sourceforge.net/LICENSE.txt
49
+
50
+ The MIT License
51
+
52
+ Copyright (c) 2012-2021 Christian Rau
53
+
54
+ Permission is hereby granted, free of charge, to any person obtaining a copy
55
+ of this software and associated documentation files (the "Software"), to deal
56
+ in the Software without restriction, including without limitation the rights
57
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
58
+ copies of the Software, and to permit persons to whom the Software is
59
+ furnished to do so, subject to the following conditions:
60
+
61
+ The above copyright notice and this permission notice shall be included in
62
+ all copies or substantial portions of the Software.
63
+
64
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
65
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
66
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
67
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
68
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
69
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
70
+ THE SOFTWARE.
71
+
72
+ _____
73
+
74
+ BSD License
75
+
76
+ For Zstandard software
77
+
78
+ Copyright (c) 2016-present, Facebook, Inc. All rights reserved.
79
+
80
+ Redistribution and use in source and binary forms, with or without modification,
81
+ are permitted provided that the following conditions are met:
82
+
83
+ * Redistributions of source code must retain the above copyright notice, this
84
+ list of conditions and the following disclaimer.
85
+
86
+ * Redistributions in binary form must reproduce the above copyright notice,
87
+ this list of conditions and the following disclaimer in the documentation
88
+ and/or other materials provided with the distribution.
89
+
90
+ * Neither the name Facebook nor the names of its contributors may be used to
91
+ endorse or promote products derived from this software without specific
92
+ prior written permission.
93
+
94
+ THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
95
+ ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
96
+ WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
97
+ DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
98
+ ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
99
+ (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
100
+ LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
101
+ ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
102
+ (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
103
+ SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) Microsoft Corporation
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.