traceforge-toolkit 0.1.0__py3-none-any.whl

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 (205) hide show
  1. traceforge/__init__.py +72 -0
  2. traceforge/__main__.py +5 -0
  3. traceforge/_generated.py +254 -0
  4. traceforge/adapters/__init__.py +12 -0
  5. traceforge/adapters/base.py +82 -0
  6. traceforge/adapters/genai_otel.py +164 -0
  7. traceforge/adapters/mapped_json.py +297 -0
  8. traceforge/adapters/otel.py +220 -0
  9. traceforge/boundary/__init__.py +46 -0
  10. traceforge/boundary/data/boundary-model.joblib +0 -0
  11. traceforge/boundary/decode.py +87 -0
  12. traceforge/boundary/features.py +137 -0
  13. traceforge/boundary/inference.py +267 -0
  14. traceforge/boundary/inferencer.py +146 -0
  15. traceforge/classify/__init__.py +95 -0
  16. traceforge/classify/cmd.py +109 -0
  17. traceforge/classify/coding.py +213 -0
  18. traceforge/classify/config.py +554 -0
  19. traceforge/classify/core.py +266 -0
  20. traceforge/classify/data/binary_info.yaml +358 -0
  21. traceforge/classify/data/canonical_tools.yaml +251 -0
  22. traceforge/classify/data/effect_overrides.yaml +480 -0
  23. traceforge/classify/data/mcp_profiles.yaml +711 -0
  24. traceforge/classify/data/recommendation_rules.yaml +111 -0
  25. traceforge/classify/data/risk.yaml +534 -0
  26. traceforge/classify/data/shell_defaults.yaml +95 -0
  27. traceforge/classify/data/shell_rules.yaml +1192 -0
  28. traceforge/classify/data/tool_classifications.yaml +215 -0
  29. traceforge/classify/data/verb_inference.yaml +218 -0
  30. traceforge/classify/mcp.py +181 -0
  31. traceforge/classify/phases.py +75 -0
  32. traceforge/classify/powershell.py +93 -0
  33. traceforge/classify/registry.py +138 -0
  34. traceforge/classify/risk.py +553 -0
  35. traceforge/classify/rules.py +215 -0
  36. traceforge/classify/schema.yaml +282 -0
  37. traceforge/classify/shell.py +503 -0
  38. traceforge/classify/tools.py +91 -0
  39. traceforge/classify/workflow.py +32 -0
  40. traceforge/cli/__init__.py +42 -0
  41. traceforge/cli/config_cmd.py +130 -0
  42. traceforge/cli/detect.py +46 -0
  43. traceforge/cli/download_cmd.py +74 -0
  44. traceforge/cli/factory.py +60 -0
  45. traceforge/cli/gate_cmd.py +30 -0
  46. traceforge/cli/init_cmd.py +86 -0
  47. traceforge/cli/replay.py +130 -0
  48. traceforge/cli/runner.py +181 -0
  49. traceforge/cli/score.py +217 -0
  50. traceforge/cli/status.py +65 -0
  51. traceforge/cli/watch.py +297 -0
  52. traceforge/config/__init__.py +80 -0
  53. traceforge/config/defaults.py +149 -0
  54. traceforge/config/loader.py +239 -0
  55. traceforge/config/mappings.py +104 -0
  56. traceforge/config/models.py +579 -0
  57. traceforge/enricher.py +576 -0
  58. traceforge/formatting/__init__.py +12 -0
  59. traceforge/formatting/budget.py +92 -0
  60. traceforge/formatting/density.py +154 -0
  61. traceforge/gate/__init__.py +17 -0
  62. traceforge/gate/client.py +145 -0
  63. traceforge/gate/external.py +305 -0
  64. traceforge/gate/registry.py +108 -0
  65. traceforge/gate/server.py +174 -0
  66. traceforge/gates/__init__.py +8 -0
  67. traceforge/gates/pii.py +352 -0
  68. traceforge/gates/pii_patterns.yaml +228 -0
  69. traceforge/governance/__init__.py +121 -0
  70. traceforge/governance/assessor.py +441 -0
  71. traceforge/governance/budget.py +59 -0
  72. traceforge/governance/canonical.py +56 -0
  73. traceforge/governance/codec.py +414 -0
  74. traceforge/governance/context.py +249 -0
  75. traceforge/governance/drift.py +196 -0
  76. traceforge/governance/emitter.py +234 -0
  77. traceforge/governance/envelope.py +138 -0
  78. traceforge/governance/ifc.py +364 -0
  79. traceforge/governance/integrity.py +162 -0
  80. traceforge/governance/labeler.py +250 -0
  81. traceforge/governance/mcp_drift.py +328 -0
  82. traceforge/governance/monitor.py +539 -0
  83. traceforge/governance/observer.py +276 -0
  84. traceforge/governance/persistence.py +401 -0
  85. traceforge/governance/phase1.py +77 -0
  86. traceforge/governance/pii.py +276 -0
  87. traceforge/governance/pipeline.py +840 -0
  88. traceforge/governance/registry.py +110 -0
  89. traceforge/governance/results.py +183 -0
  90. traceforge/governance/risk_wrapper.py +113 -0
  91. traceforge/governance/rules.py +368 -0
  92. traceforge/governance/scorer.py +262 -0
  93. traceforge/governance/shield.py +318 -0
  94. traceforge/governance/state.py +466 -0
  95. traceforge/governance/types.py +176 -0
  96. traceforge/mappings/__init__.py +1 -0
  97. traceforge/mappings/aider.yaml +216 -0
  98. traceforge/mappings/aider_markdown.yaml +113 -0
  99. traceforge/mappings/amazonq.yaml +56 -0
  100. traceforge/mappings/antigravity.yaml +88 -0
  101. traceforge/mappings/claude.yaml +93 -0
  102. traceforge/mappings/cline.yaml +286 -0
  103. traceforge/mappings/codex.yaml +158 -0
  104. traceforge/mappings/continue_dev.yaml +57 -0
  105. traceforge/mappings/copilot.yaml +266 -0
  106. traceforge/mappings/copilot_markdown.yaml +72 -0
  107. traceforge/mappings/copilot_vscode.yaml +181 -0
  108. traceforge/mappings/crewai.yaml +592 -0
  109. traceforge/mappings/goose.yaml +128 -0
  110. traceforge/mappings/langgraph.yaml +165 -0
  111. traceforge/mappings/maf.yaml +90 -0
  112. traceforge/mappings/maf_transcript.yaml +99 -0
  113. traceforge/mappings/openai_agents.yaml +144 -0
  114. traceforge/mappings/opencode.yaml +473 -0
  115. traceforge/mappings/openhands.yaml +320 -0
  116. traceforge/mappings/pydantic_ai.yaml +183 -0
  117. traceforge/mappings/smolagents.yaml +89 -0
  118. traceforge/mappings/sweagent.yaml +82 -0
  119. traceforge/migrations/__init__.py +1 -0
  120. traceforge/migrations/env.py +60 -0
  121. traceforge/migrations/models.py +145 -0
  122. traceforge/migrations/runner.py +44 -0
  123. traceforge/migrations/script.py.mako +25 -0
  124. traceforge/migrations/versions/0001_initial.py +176 -0
  125. traceforge/migrations/versions/__init__.py +4 -0
  126. traceforge/models.py +29 -0
  127. traceforge/parsers/__init__.py +21 -0
  128. traceforge/parsers/aider.py +416 -0
  129. traceforge/parsers/base.py +226 -0
  130. traceforge/parsers/copilot.py +314 -0
  131. traceforge/phase/__init__.py +50 -0
  132. traceforge/phase/data/phase-model.joblib +0 -0
  133. traceforge/phase/data/potion-base-8M/README.md +99 -0
  134. traceforge/phase/data/potion-base-8M/config.json +13 -0
  135. traceforge/phase/data/potion-base-8M/model.safetensors +0 -0
  136. traceforge/phase/data/potion-base-8M/modules.json +14 -0
  137. traceforge/phase/data/potion-base-8M/tokenizer.json +1 -0
  138. traceforge/phase/event_rows.py +107 -0
  139. traceforge/phase/features.py +468 -0
  140. traceforge/phase/inference.py +279 -0
  141. traceforge/phase/inferencer.py +171 -0
  142. traceforge/phase/segmentation.py +258 -0
  143. traceforge/pipeline.py +891 -0
  144. traceforge/preprocessors/__init__.py +34 -0
  145. traceforge/preprocessors/amazonq.py +224 -0
  146. traceforge/preprocessors/antigravity.py +116 -0
  147. traceforge/preprocessors/claude.py +95 -0
  148. traceforge/preprocessors/cline.py +36 -0
  149. traceforge/preprocessors/codex.py +311 -0
  150. traceforge/preprocessors/continue_dev.py +119 -0
  151. traceforge/preprocessors/copilot_vscode.py +171 -0
  152. traceforge/preprocessors/goose.py +156 -0
  153. traceforge/preprocessors/maf_transcript.py +84 -0
  154. traceforge/preprocessors/openai_agents.py +86 -0
  155. traceforge/preprocessors/opencode.py +85 -0
  156. traceforge/preprocessors/openhands.py +36 -0
  157. traceforge/preprocessors/pydantic_ai.py +62 -0
  158. traceforge/preprocessors/registry.py +24 -0
  159. traceforge/preprocessors/smolagents.py +90 -0
  160. traceforge/py.typed +0 -0
  161. traceforge/sdk/__init__.py +59 -0
  162. traceforge/sdk/gate_policy.py +63 -0
  163. traceforge/sdk/gate_types.py +140 -0
  164. traceforge/sdk/pipeline.py +265 -0
  165. traceforge/sdk/verdict.py +81 -0
  166. traceforge/sinks/__init__.py +23 -0
  167. traceforge/sinks/base.py +95 -0
  168. traceforge/sinks/callback.py +132 -0
  169. traceforge/sinks/console.py +112 -0
  170. traceforge/sinks/factory.py +94 -0
  171. traceforge/sinks/jsonl.py +125 -0
  172. traceforge/sinks/otel_exporter.py +212 -0
  173. traceforge/sinks/parquet.py +260 -0
  174. traceforge/sinks/s3.py +206 -0
  175. traceforge/sinks/sqlite_output.py +234 -0
  176. traceforge/sinks/webhook.py +136 -0
  177. traceforge/sources/__init__.py +18 -0
  178. traceforge/sources/auto_detect.py +173 -0
  179. traceforge/sources/base.py +45 -0
  180. traceforge/sources/file_poll.py +136 -0
  181. traceforge/sources/file_watch.py +221 -0
  182. traceforge/sources/http_poll.py +141 -0
  183. traceforge/sources/replay.py +63 -0
  184. traceforge/sources/sqlite.py +187 -0
  185. traceforge/sources/sse.py +198 -0
  186. traceforge/telemetry/__init__.py +192 -0
  187. traceforge/title/__init__.py +23 -0
  188. traceforge/title/_resolve.py +79 -0
  189. traceforge/title/context.py +295 -0
  190. traceforge/title/data/boilerplate_files.json +14 -0
  191. traceforge/title/heuristics.py +429 -0
  192. traceforge/title/hygiene.py +90 -0
  193. traceforge/title/inference.py +314 -0
  194. traceforge/title/inferencer.py +477 -0
  195. traceforge/title/naming.py +398 -0
  196. traceforge/trace.py +291 -0
  197. traceforge/tracking/__init__.py +30 -0
  198. traceforge/tracking/models.py +115 -0
  199. traceforge/tracking/phase_tracker.py +288 -0
  200. traceforge/types.py +315 -0
  201. traceforge_toolkit-0.1.0.dist-info/METADATA +188 -0
  202. traceforge_toolkit-0.1.0.dist-info/RECORD +205 -0
  203. traceforge_toolkit-0.1.0.dist-info/WHEEL +4 -0
  204. traceforge_toolkit-0.1.0.dist-info/entry_points.txt +2 -0
  205. traceforge_toolkit-0.1.0.dist-info/licenses/LICENSE +21 -0
@@ -0,0 +1,314 @@
1
+ """CopilotPreParser — extracts structured events from Copilot CLI data.
2
+
3
+ Copilot CLI stores data in two locations:
4
+ 1. session-store.db: turns table with user_message + assistant_response (markdown)
5
+ 2. process-*.log: raw API messages with structured tool_use/tool_result JSON
6
+
7
+ This parser handles BOTH:
8
+ - Markdown parsing (via MarkdownPreParser base): extracts tool calls and
9
+ structured blocks from rendered assistant_response text
10
+ - Log line parsing (parse_log_line): extracts structured API events from
11
+ embedded JSON in process logs
12
+
13
+ Output: Structured event dicts suitable for copilot_markdown.yaml mapping.
14
+ """
15
+
16
+ from __future__ import annotations
17
+
18
+ from collections.abc import Iterator
19
+ from dataclasses import dataclass
20
+ from datetime import datetime, timezone
21
+ from typing import Any
22
+
23
+ import tree_sitter as ts
24
+
25
+ from traceforge.parsers.base import (
26
+ MD_LANGUAGE,
27
+ Block,
28
+ MarkdownPreParser,
29
+ node_text,
30
+ try_parse_json,
31
+ )
32
+
33
+ # ─── Tree-sitter queries for Copilot response structure ──────────────────────
34
+
35
+ _BLOCK_QUERY = ts.Query(
36
+ MD_LANGUAGE,
37
+ """
38
+ (atx_heading (atx_h1_marker) (inline) @h1_text) @h1
39
+ (atx_heading (atx_h2_marker) (inline) @h2_text) @h2
40
+ (atx_heading (atx_h3_marker) (inline) @h3_text) @h3
41
+ (fenced_code_block
42
+ (info_string) @lang
43
+ (code_fence_content) @code_content) @fenced
44
+ (paragraph) @para
45
+ (pipe_table) @table
46
+ (block_quote) @blockquote
47
+ (thematic_break) @hr
48
+ (list) @list_block
49
+ """,
50
+ )
51
+
52
+ # Pattern indices
53
+ _PAT_H1 = 0
54
+ _PAT_H2 = 1
55
+ _PAT_H3 = 2
56
+ _PAT_FENCED = 3
57
+ _PAT_PARA = 4
58
+ _PAT_TABLE = 5
59
+ _PAT_BQ = 6
60
+ _PAT_HR = 7
61
+ _PAT_LIST = 8
62
+
63
+ # ─── Log line patterns ───────────────────────────────────────────────────────
64
+
65
+ # (removed in #45) The process-log path — parse_log_line + api_*/telemetry/
66
+ # session_event extraction — targeted an obsolete Anthropic streaming log format
67
+ # the current Copilot CLI no longer emits. The canonical high-fidelity path is
68
+ # copilot.yaml over ~/.copilot/session-state/<id>/events.jsonl. Only the SQLite
69
+ # turns path (parse_turn) remains here as a thin fallback.
70
+
71
+
72
+ # ─── Turn state ──────────────────────────────────────────────────────────────
73
+
74
+
75
+ @dataclass
76
+ class _TurnState:
77
+ """Tracks state within a single turn parse."""
78
+
79
+ session_id: str
80
+ turn_index: int | None = None
81
+ timestamp: str = ""
82
+ sequence: int = 0
83
+
84
+
85
+ # ─── Main parser ─────────────────────────────────────────────────────────────
86
+
87
+
88
+ class CopilotPreParser(MarkdownPreParser):
89
+ """Extracts structured events from Copilot CLI stored data.
90
+
91
+ Two parsing modes:
92
+ 1. parse_turn(row_dict) — for SqliteSource rows from the turns table
93
+ (uses MarkdownPreParser infrastructure for AST extraction)
94
+ 2. parse_log_line(line) — for FileWatchSource lines from process logs
95
+ (parses structured JSON from raw API messages)
96
+ """
97
+
98
+ def __init__(self) -> None:
99
+ super().__init__()
100
+ self._turn_state: _TurnState | None = None
101
+
102
+ # ─── Base class hooks (for markdown AST parsing) ─────────────────────
103
+
104
+ def _get_query(self) -> ts.Query:
105
+ return _BLOCK_QUERY
106
+
107
+ def _classify_match(
108
+ self, pattern_index: int, captures: dict[str, list[ts.Node]], source: bytes
109
+ ) -> list[Block]:
110
+ blocks: list[Block] = []
111
+
112
+ if pattern_index in (_PAT_H1, _PAT_H2, _PAT_H3):
113
+ level = {_PAT_H1: 1, _PAT_H2: 2, _PAT_H3: 3}[pattern_index]
114
+ cap_prefix = {_PAT_H1: "h1", _PAT_H2: "h2", _PAT_H3: "h3"}[pattern_index]
115
+ text_nodes = captures.get(f"{cap_prefix}_text", [])
116
+ heading_nodes = captures.get(cap_prefix, [])
117
+ if heading_nodes and text_nodes:
118
+ blocks.append(
119
+ Block(
120
+ role="heading",
121
+ byte_pos=heading_nodes[0].start_byte,
122
+ text=node_text(text_nodes[0], source).strip(),
123
+ level=level,
124
+ )
125
+ )
126
+ elif pattern_index == _PAT_FENCED:
127
+ fenced_nodes = captures.get("fenced", [])
128
+ lang_nodes = captures.get("lang", [])
129
+ code_nodes = captures.get("code_content", [])
130
+ if fenced_nodes and code_nodes:
131
+ lang = node_text(lang_nodes[0], source).strip() if lang_nodes else ""
132
+ blocks.append(
133
+ Block(
134
+ role="code",
135
+ byte_pos=fenced_nodes[0].start_byte,
136
+ text=node_text(code_nodes[0], source),
137
+ lang=lang,
138
+ )
139
+ )
140
+ elif pattern_index == _PAT_PARA:
141
+ para_nodes = captures.get("para", [])
142
+ for node in para_nodes:
143
+ if node.parent and node.parent.type in ("document", "section"):
144
+ blocks.append(
145
+ Block(
146
+ role="text",
147
+ byte_pos=node.start_byte,
148
+ text=node_text(node, source).strip(),
149
+ node=node,
150
+ )
151
+ )
152
+ elif pattern_index == _PAT_TABLE:
153
+ table_nodes = captures.get("table", [])
154
+ for node in table_nodes:
155
+ blocks.append(
156
+ Block(
157
+ role="table",
158
+ byte_pos=node.start_byte,
159
+ text=node_text(node, source).strip(),
160
+ node=node,
161
+ )
162
+ )
163
+ elif pattern_index == _PAT_BQ:
164
+ bq_nodes = captures.get("blockquote", [])
165
+ for node in bq_nodes:
166
+ blocks.append(
167
+ Block(
168
+ role="quote",
169
+ byte_pos=node.start_byte,
170
+ text=node_text(node, source).strip(),
171
+ node=node,
172
+ )
173
+ )
174
+ elif pattern_index == _PAT_HR:
175
+ hr_nodes = captures.get("hr", [])
176
+ for node in hr_nodes:
177
+ blocks.append(Block(role="hr", byte_pos=node.start_byte))
178
+ elif pattern_index == _PAT_LIST:
179
+ list_nodes = captures.get("list_block", [])
180
+ for node in list_nodes:
181
+ if node.parent and node.parent.type in ("document", "section"):
182
+ blocks.append(
183
+ Block(
184
+ role="list",
185
+ byte_pos=node.start_byte,
186
+ text=node_text(node, source).strip(),
187
+ node=node,
188
+ )
189
+ )
190
+
191
+ return blocks
192
+
193
+ def _process_blocks(self, blocks: list[Block], source: bytes) -> Iterator[dict[str, Any]]:
194
+ """Convert sorted blocks into event dicts."""
195
+ for block in blocks:
196
+ yield from self._emit_block_event(block)
197
+
198
+ def _emit_block_event(self, block: Block) -> Iterator[dict[str, Any]]:
199
+ """Convert a single block into event dicts."""
200
+ state = self._turn_state
201
+
202
+ if block.role == "code":
203
+ lang = block.lang.lower()
204
+ if lang in ("powershell", "bash", "sh", "python", "cmd"):
205
+ yield self._turn_event(
206
+ state,
207
+ "tool_call",
208
+ {
209
+ "tool_name": lang,
210
+ "command": block.text.strip(),
211
+ },
212
+ )
213
+ elif lang in ("json", "yaml", "toml"):
214
+ parsed = try_parse_json(block.text)
215
+ if parsed:
216
+ yield self._turn_event(
217
+ state,
218
+ "structured_output",
219
+ {
220
+ "format": lang,
221
+ "data": parsed,
222
+ },
223
+ )
224
+ else:
225
+ yield self._turn_event(
226
+ state,
227
+ "code_block",
228
+ {
229
+ "language": lang,
230
+ "content": block.text.strip(),
231
+ },
232
+ )
233
+ else:
234
+ yield self._turn_event(
235
+ state,
236
+ "code_block",
237
+ {
238
+ "language": lang or "unknown",
239
+ "content": block.text.strip(),
240
+ },
241
+ )
242
+ elif block.role == "text":
243
+ if block.text:
244
+ yield self._turn_event(state, "assistant_text", {"content": block.text})
245
+ elif block.role == "heading":
246
+ yield self._turn_event(
247
+ state,
248
+ "section_heading",
249
+ {
250
+ "level": block.level,
251
+ "title": block.text,
252
+ },
253
+ )
254
+ elif block.role == "table":
255
+ yield self._turn_event(state, "table_output", {"content": block.text})
256
+ elif block.role == "quote":
257
+ yield self._turn_event(state, "quoted_output", {"content": block.text})
258
+ elif block.role == "list":
259
+ if block.text:
260
+ yield self._turn_event(state, "assistant_text", {"content": block.text})
261
+
262
+ # ─── Mode 1: Parse a turn row from SQLite ────────────────────────────
263
+
264
+ def parse_turn(self, row: dict[str, Any]) -> Iterator[dict[str, Any]]:
265
+ """Parse a row from the Copilot turns table into event dicts.
266
+
267
+ Expected row keys: session_id, turn_index, user_message,
268
+ assistant_response, timestamp
269
+ """
270
+ session_id = row.get("session_id", "unknown")
271
+ turn_index = row.get("turn_index")
272
+ timestamp = row.get("timestamp", datetime.now(timezone.utc).isoformat())
273
+
274
+ self._turn_state = _TurnState(
275
+ session_id=session_id,
276
+ turn_index=turn_index,
277
+ timestamp=timestamp,
278
+ )
279
+
280
+ # Emit user message event
281
+ user_msg = row.get("user_message")
282
+ if user_msg:
283
+ yield self._turn_event(
284
+ self._turn_state,
285
+ "user_message",
286
+ {
287
+ "content": user_msg,
288
+ "turn_index": turn_index,
289
+ },
290
+ )
291
+
292
+ # Parse assistant response with tree-sitter (uses base class infra)
293
+ assistant_resp = row.get("assistant_response")
294
+ if assistant_resp:
295
+ source = assistant_resp.encode("utf-8")
296
+ tree = self._ts_parser.parse(source)
297
+ blocks = self._extract_blocks(tree, source)
298
+ yield from self._process_blocks(blocks, source)
299
+
300
+ # ─── Event construction ──────────────────────────────────────────────
301
+
302
+ @staticmethod
303
+ def _turn_event(
304
+ state: _TurnState | None, event_type: str, payload: dict[str, Any]
305
+ ) -> dict[str, Any]:
306
+ event: dict[str, Any] = {
307
+ "type": event_type,
308
+ "timestamp": state.timestamp if state else datetime.now(timezone.utc).isoformat(),
309
+ "session_id": state.session_id if state else "unknown",
310
+ }
311
+ if state and state.turn_index is not None:
312
+ event["turn_index"] = state.turn_index
313
+ event.update(payload)
314
+ return event
@@ -0,0 +1,50 @@
1
+ """The trained, session-aware phase classifier — production inference.
2
+
3
+ The per-event workflow-stage (planning / implementation / verification /
4
+ exploration) predictor. Unlike the deterministic majority-vote
5
+ :class:`traceforge.tracking.PhaseTracker` (whose segmentation output is now just
6
+ one *feature* among many), this is a supervised classifier trained on the
7
+ labelling corpus and is the only phase producer in this path.
8
+
9
+ Public API:
10
+
11
+ * :class:`PhaseInferencer` — apply a trained bundle to live ``SessionEvent``s
12
+ and stamp ``metadata.phase``.
13
+ * :func:`load` — load a persisted bundle (env var / packaged default).
14
+ * :func:`featurize_session_events` — the portable, causal session featuriser
15
+ (shared with the research training pipeline).
16
+ * :class:`SegmentationParams`, :class:`NeighborParams` — feature hyperparameters.
17
+
18
+ Requires ``model2vec`` + ``scikit-learn`` (core dependencies), imported
19
+ lazily so the base package stays quick to import.
20
+ """
21
+
22
+ from __future__ import annotations
23
+
24
+ from .event_rows import event_to_feature_row
25
+ from .features import (
26
+ NeighborParams,
27
+ feature_set_blocks,
28
+ featurize_session_events,
29
+ )
30
+ from .inference import (
31
+ DEFAULT_FEATURE_SET,
32
+ PhaseModel,
33
+ load,
34
+ predict_session,
35
+ )
36
+ from .inferencer import PhaseInferencer
37
+ from .segmentation import SegmentationParams
38
+
39
+ __all__ = [
40
+ "DEFAULT_FEATURE_SET",
41
+ "NeighborParams",
42
+ "PhaseInferencer",
43
+ "PhaseModel",
44
+ "SegmentationParams",
45
+ "event_to_feature_row",
46
+ "feature_set_blocks",
47
+ "featurize_session_events",
48
+ "load",
49
+ "predict_session",
50
+ ]
Binary file
@@ -0,0 +1,99 @@
1
+ ---
2
+ library_name: model2vec
3
+ license: mit
4
+ model_name: potion-base-8M
5
+ tags:
6
+ - embeddings
7
+ - static-embeddings
8
+ - sentence-transformers
9
+ ---
10
+
11
+ # potion-base-8M Model Card
12
+
13
+ This [Model2Vec](https://github.com/MinishLab/model2vec) model is a distilled version of a Sentence Transformer. It uses static embeddings, allowing text embeddings to be computed orders of magnitude faster on both GPU and CPU. It is designed for applications where computational resources are limited or where real-time performance is critical. Model2Vec models are the smallest, fastest, and most performant static embedders available. The distilled models are up to 50 times smaller and 500 times faster than traditional Sentence Transformers.
14
+
15
+
16
+ ## Installation
17
+
18
+ Install model2vec using pip:
19
+ ```
20
+ pip install model2vec
21
+ ```
22
+
23
+ ## Usage
24
+
25
+ ### Using Model2Vec
26
+
27
+ The [Model2Vec library](https://github.com/MinishLab/model2vec) is the fastest and most lightweight way to run Model2Vec models.
28
+
29
+ Load this model using the `from_pretrained` method:
30
+ ```python
31
+ from model2vec import StaticModel
32
+
33
+ # Load a pretrained Model2Vec model
34
+ model = StaticModel.from_pretrained("potion-base-8M")
35
+
36
+ # Compute text embeddings
37
+ embeddings = model.encode(["Example sentence"])
38
+ ```
39
+
40
+ ### Using Sentence Transformers
41
+
42
+ You can also use the [Sentence Transformers library](https://github.com/UKPLab/sentence-transformers) to load and use the model:
43
+
44
+ ```python
45
+ from sentence_transformers import SentenceTransformer
46
+
47
+ # Load a pretrained Sentence Transformer model
48
+ model = SentenceTransformer("potion-base-8M")
49
+
50
+ # Compute text embeddings
51
+ embeddings = model.encode(["Example sentence"])
52
+ ```
53
+
54
+ ### Distilling a Model2Vec model
55
+
56
+ You can distill a Model2Vec model from a Sentence Transformer model using the `distill` method. First, install the `distill` extra with `pip install model2vec[distill]`. Then, run the following code:
57
+
58
+ ```python
59
+ from model2vec.distill import distill
60
+
61
+ # Distill a Sentence Transformer model, in this case the BAAI/bge-base-en-v1.5 model
62
+ m2v_model = distill(model_name="BAAI/bge-base-en-v1.5", pca_dims=256)
63
+
64
+ # Save the model
65
+ m2v_model.save_pretrained("m2v_model")
66
+ ```
67
+
68
+ ## How it works
69
+
70
+ Model2vec creates a small, fast, and powerful model that outperforms other static embedding models by a large margin on all tasks we could find, while being much faster to create than traditional static embedding models such as GloVe. Best of all, you don't need any data to distill a model using Model2Vec.
71
+
72
+ It works by passing a vocabulary through a sentence transformer model, then reducing the dimensionality of the resulting embeddings using PCA, and finally weighting the embeddings using [SIF weighting](https://openreview.net/pdf?id=SyK00v5xx). During inference, we simply take the mean of all token embeddings occurring in a sentence.
73
+
74
+ ## Additional Resources
75
+
76
+ - [Model2Vec Repo](https://github.com/MinishLab/model2vec)
77
+ - [Model2Vec Base Models](https://huggingface.co/collections/minishlab/model2vec-base-models-66fd9dd9b7c3b3c0f25ca90e)
78
+ - [Model2Vec Results](https://github.com/MinishLab/model2vec/tree/main/results)
79
+ - [Model2Vec Docs](https://minish.ai/packages/model2vec/introduction)
80
+
81
+
82
+ ## Library Authors
83
+
84
+ Model2Vec was developed by the [Minish Lab](https://github.com/MinishLab) team consisting of [Stephan Tulkens](https://github.com/stephantul) and [Thomas van Dongen](https://github.com/Pringled).
85
+
86
+ ## Citation
87
+
88
+ Please cite the [Model2Vec repository](https://github.com/MinishLab/model2vec) if you use this model in your work.
89
+ ```
90
+ @software{minishlab2024model2vec,
91
+ author = {Stephan Tulkens and {van Dongen}, Thomas},
92
+ title = {Model2Vec: Fast State-of-the-Art Static Embeddings},
93
+ year = {2024},
94
+ publisher = {Zenodo},
95
+ doi = {10.5281/zenodo.17270888},
96
+ url = {https://github.com/MinishLab/model2vec},
97
+ license = {MIT}
98
+ }
99
+ ```
@@ -0,0 +1,13 @@
1
+ {
2
+ "model_type": "model2vec",
3
+ "architectures": [
4
+ "StaticModel"
5
+ ],
6
+ "tokenizer_name": "baai/bge-base-en-v1.5",
7
+ "apply_pca": 256,
8
+ "apply_zipf": true,
9
+ "hidden_dim": 256,
10
+ "seq_length": 1000000,
11
+ "normalize": true,
12
+ "embedding_dtype": "float32"
13
+ }
@@ -0,0 +1,14 @@
1
+ [
2
+ {
3
+ "idx": 0,
4
+ "name": "0",
5
+ "path": ".",
6
+ "type": "sentence_transformers.models.StaticEmbedding"
7
+ },
8
+ {
9
+ "idx": 1,
10
+ "name": "1",
11
+ "path": "1_Normalize",
12
+ "type": "sentence_transformers.models.Normalize"
13
+ }
14
+ ]