embedxray 0.1.1__tar.gz
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.
- embedxray-0.1.1/LICENSE +201 -0
- embedxray-0.1.1/PKG-INFO +127 -0
- embedxray-0.1.1/README.md +110 -0
- embedxray-0.1.1/pyproject.toml +34 -0
- embedxray-0.1.1/setup.cfg +4 -0
- embedxray-0.1.1/src/embedxray/__init__.py +46 -0
- embedxray-0.1.1/src/embedxray/evaluator.py +250 -0
- embedxray-0.1.1/src/embedxray/modules/__init__.py +25 -0
- embedxray-0.1.1/src/embedxray/modules/attribution.py +333 -0
- embedxray-0.1.1/src/embedxray/modules/fracture.py +208 -0
- embedxray-0.1.1/src/embedxray/modules/geometry.py +193 -0
- embedxray-0.1.1/src/embedxray/report.py +198 -0
- embedxray-0.1.1/src/embedxray/utils/__init__.py +25 -0
- embedxray-0.1.1/src/embedxray/utils/model.py +66 -0
- embedxray-0.1.1/src/embedxray/utils/quantization.py +54 -0
- embedxray-0.1.1/src/embedxray/utils/tensor_ops.py +130 -0
- embedxray-0.1.1/src/embedxray.egg-info/PKG-INFO +127 -0
- embedxray-0.1.1/src/embedxray.egg-info/SOURCES.txt +24 -0
- embedxray-0.1.1/src/embedxray.egg-info/dependency_links.txt +1 -0
- embedxray-0.1.1/src/embedxray.egg-info/requires.txt +6 -0
- embedxray-0.1.1/src/embedxray.egg-info/top_level.txt +1 -0
- embedxray-0.1.1/tests/test_attribution.py +121 -0
- embedxray-0.1.1/tests/test_evaluator_integration.py +260 -0
- embedxray-0.1.1/tests/test_fracture.py +90 -0
- embedxray-0.1.1/tests/test_geometry.py +71 -0
- embedxray-0.1.1/tests/test_utils.py +192 -0
embedxray-0.1.1/LICENSE
ADDED
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
embedxray-0.1.1/PKG-INFO
ADDED
|
@@ -0,0 +1,127 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: embedxray
|
|
3
|
+
Version: 0.1.1
|
|
4
|
+
Summary: Read-only diagnostic and evaluation library for sentence-transformers embeddings.
|
|
5
|
+
License-Expression: Apache-2.0
|
|
6
|
+
Project-URL: Repository, https://github.com/asysdev/embedxray
|
|
7
|
+
Project-URL: Issues, https://github.com/asysdev/embedxray/issues
|
|
8
|
+
Requires-Python: >=3.10
|
|
9
|
+
Description-Content-Type: text/markdown
|
|
10
|
+
License-File: LICENSE
|
|
11
|
+
Requires-Dist: filelock>=3.10.0
|
|
12
|
+
Requires-Dist: torch>=2.0.0
|
|
13
|
+
Requires-Dist: sentence-transformers>=3.0.0
|
|
14
|
+
Provides-Extra: dev
|
|
15
|
+
Requires-Dist: pytest>=7.4.0; extra == "dev"
|
|
16
|
+
Dynamic: license-file
|
|
17
|
+
|
|
18
|
+
# embedxray
|
|
19
|
+
|
|
20
|
+
Diagnose what your sentence embeddings encode and how much retrieval changes when you compress them. **embedxray** evaluates a [Sentence Transformers](https://www.sbert.net/) model on your own corpus, queries, and contrast pairs. It runs inference without updating model weights and restores the model's training mode after evaluation.
|
|
21
|
+
|
|
22
|
+
| Diagnostic | What it measures |
|
|
23
|
+
| --- | --- |
|
|
24
|
+
| Token attribution | Which tokens align most strongly with the pooled embedding, and how much of their positive contribution comes from boilerplate. |
|
|
25
|
+
| Contrast collisions | How often text pairs you expect to distinguish exceed a cosine similarity threshold. |
|
|
26
|
+
| Embedding geometry | Sampled pairwise cosine, spectral entropy, and the fraction of low-variance dimensions. |
|
|
27
|
+
| Hubness | Whether a small set of documents appears disproportionately often in the nearest neighbors. |
|
|
28
|
+
| Compression sensitivity | Top-k neighbor overlap and vector fidelity across dimension truncation and FP16, INT8, INT4, and binary simulations. |
|
|
29
|
+
|
|
30
|
+
## Installation
|
|
31
|
+
|
|
32
|
+
Requires Python 3.10 or later, PyTorch, and Sentence Transformers. The test suite has passed on CPU with Sentence Transformers 3.0.0 and 6.3.0.
|
|
33
|
+
|
|
34
|
+
Install the package from PyPI once the first release is live.
|
|
35
|
+
|
|
36
|
+
```bash
|
|
37
|
+
python -m pip install embedxray
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
Install the current version directly from GitHub.
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
python -m pip install 'git+https://github.com/asysdev/embedxray.git'
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
## Quickstart
|
|
47
|
+
|
|
48
|
+
Use representative documents and queries from your retrieval workload. The first run of this example downloads the named model if it is missing from the local cache. You can also pass a local model directory to `SentenceTransformer`.
|
|
49
|
+
|
|
50
|
+
```python
|
|
51
|
+
from sentence_transformers import SentenceTransformer
|
|
52
|
+
|
|
53
|
+
from embedxray import EmbeddingXRayEvaluator
|
|
54
|
+
|
|
55
|
+
model = SentenceTransformer("sentence-transformers/all-MiniLM-L6-v2")
|
|
56
|
+
|
|
57
|
+
evaluator = EmbeddingXRayEvaluator(
|
|
58
|
+
corpus_texts=[
|
|
59
|
+
"Reset your password using the link on the sign-in page.",
|
|
60
|
+
"Add a recovery phone number in your account settings.",
|
|
61
|
+
"Update your payment method from the billing dashboard.",
|
|
62
|
+
"Export past invoices from the billing dashboard.",
|
|
63
|
+
"Contact support if your account is locked.",
|
|
64
|
+
],
|
|
65
|
+
query_texts=["How do I reset my password?", "Where can I download an invoice?"],
|
|
66
|
+
contrast_pairs=[
|
|
67
|
+
("Two-factor authentication is enabled.", "Two-factor authentication is disabled."),
|
|
68
|
+
],
|
|
69
|
+
k=2,
|
|
70
|
+
matryoshka_dims=[384, 128, 64],
|
|
71
|
+
cliff_threshold=0.95,
|
|
72
|
+
)
|
|
73
|
+
|
|
74
|
+
report = evaluator.evaluate_report(model, output_path="xray_out")
|
|
75
|
+
print(f"X-Ray health score: {report.health_score:.1f}/100")
|
|
76
|
+
print(report.fracture["fracture_cliff_config"])
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
Call `evaluator(model)` to get a flat metric dictionary for logging or a Sentence Transformers trainer. The default primary metric is `xray_health_score`. The most recent structured report is available as `evaluator.last_report`.
|
|
80
|
+
|
|
81
|
+
## Evaluation options
|
|
82
|
+
|
|
83
|
+
| Option | Behavior |
|
|
84
|
+
| --- | --- |
|
|
85
|
+
| `query_texts` | With no queries supplied, the corpus is queried against itself and each row excludes itself. An explicit empty list skips retrieval. |
|
|
86
|
+
| `contrast_pairs` | Supply pairs that should be distinguishable. A collision occurs above `collision_threshold`, which defaults to `0.90`. |
|
|
87
|
+
| `attribution_texts` | Defaults to the first 64 corpus entries. Supply representative text for attribution, or an empty list to skip it. |
|
|
88
|
+
| `matryoshka_dims`, `quantization_modes` | Select prefix dimensions and simulated precisions. Each selected dimension includes an FP32 result. |
|
|
89
|
+
| `k`, `chunk_size` | Set the neighbor count and similarity block size. See `report.metadata["actual_k"]` for the effective count after clamping to the eligible corpus size. |
|
|
90
|
+
|
|
91
|
+
## Reading the results
|
|
92
|
+
|
|
93
|
+
- **Health score** is a 0–100 summary of geometry, dimension health, hubness, compression stability, and attribution or contrast collisions. Compare runs on the same corpus, queries, and settings. Use labeled retrieval metrics such as Recall@k or nDCG to measure relevance.
|
|
94
|
+
- **Overlap@k** is the average fraction of the full-dimensional FP32 neighbor set retained by a configuration. **Self-similarity drift** reports mean cosine similarity between original and simulated vectors at the same dimension. Values closer to 1 indicate better directional preservation.
|
|
95
|
+
- **Fracture cliff** is the lowest estimated vector payload among configurations that reach the overlap threshold. The simulation estimates vector payload from dimension and precision. Index overhead, calibration metadata, padding, and retrieval latency are outside that estimate.
|
|
96
|
+
- **Unavailable measurements** appear as `null` in the structured report and are omitted from flat attribution and overlap metrics. Attribution samples include an `unavailable_reason` when token features cannot be aligned. When overlap cannot be measured, the cliff uses the full FP32 storage estimate.
|
|
97
|
+
|
|
98
|
+
When `output_path` is supplied, the evaluator writes these files.
|
|
99
|
+
|
|
100
|
+
| File | Contents |
|
|
101
|
+
| --- | --- |
|
|
102
|
+
| `xray_report.md` | Human-readable diagnostic summary and compression grid. |
|
|
103
|
+
| `xray_report.json` | Structured scores, per-sample token evidence, and details of offending contrast pairs. This file can contain original input text. |
|
|
104
|
+
| `xray_evaluation_results.csv` | An appended flat metric row with epoch and step columns. |
|
|
105
|
+
|
|
106
|
+
Use `name` to label report filenames and prefix metric keys. Use `write_csv=False` or `write_report=False` to disable the corresponding exports.
|
|
107
|
+
|
|
108
|
+
## Using precomputed embeddings
|
|
109
|
+
|
|
110
|
+
Run geometry or compression diagnostics directly on PyTorch tensors shaped `(samples, dimensions)`. For example, use `evaluate_fracture(corpus_embeddings, query_embeddings, k=10)` to inspect the compression grid. The corresponding geometry entry points are `compute_anisotropy`, `compute_dimension_health`, and `compute_hubness`, all exported from `embedxray`.
|
|
111
|
+
|
|
112
|
+
Retrieval uses exact batched similarity comparisons. Runtime increases with the number of query–corpus pairs and compression configurations.
|
|
113
|
+
|
|
114
|
+
## Development
|
|
115
|
+
|
|
116
|
+
```bash
|
|
117
|
+
git clone https://github.com/asysdev/embedxray.git
|
|
118
|
+
cd embedxray
|
|
119
|
+
python -m pip install -e '.[dev]'
|
|
120
|
+
HF_HUB_OFFLINE=1 TRANSFORMERS_OFFLINE=1 python -m pytest
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
The tests use synthetic embeddings and locally constructed models, so they run without downloading model weights.
|
|
124
|
+
|
|
125
|
+
## License
|
|
126
|
+
|
|
127
|
+
[Apache License 2.0](https://github.com/asysdev/embedxray/blob/main/LICENSE)
|
|
@@ -0,0 +1,110 @@
|
|
|
1
|
+
# embedxray
|
|
2
|
+
|
|
3
|
+
Diagnose what your sentence embeddings encode and how much retrieval changes when you compress them. **embedxray** evaluates a [Sentence Transformers](https://www.sbert.net/) model on your own corpus, queries, and contrast pairs. It runs inference without updating model weights and restores the model's training mode after evaluation.
|
|
4
|
+
|
|
5
|
+
| Diagnostic | What it measures |
|
|
6
|
+
| --- | --- |
|
|
7
|
+
| Token attribution | Which tokens align most strongly with the pooled embedding, and how much of their positive contribution comes from boilerplate. |
|
|
8
|
+
| Contrast collisions | How often text pairs you expect to distinguish exceed a cosine similarity threshold. |
|
|
9
|
+
| Embedding geometry | Sampled pairwise cosine, spectral entropy, and the fraction of low-variance dimensions. |
|
|
10
|
+
| Hubness | Whether a small set of documents appears disproportionately often in the nearest neighbors. |
|
|
11
|
+
| Compression sensitivity | Top-k neighbor overlap and vector fidelity across dimension truncation and FP16, INT8, INT4, and binary simulations. |
|
|
12
|
+
|
|
13
|
+
## Installation
|
|
14
|
+
|
|
15
|
+
Requires Python 3.10 or later, PyTorch, and Sentence Transformers. The test suite has passed on CPU with Sentence Transformers 3.0.0 and 6.3.0.
|
|
16
|
+
|
|
17
|
+
Install the package from PyPI once the first release is live.
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
python -m pip install embedxray
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
Install the current version directly from GitHub.
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
python -m pip install 'git+https://github.com/asysdev/embedxray.git'
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## Quickstart
|
|
30
|
+
|
|
31
|
+
Use representative documents and queries from your retrieval workload. The first run of this example downloads the named model if it is missing from the local cache. You can also pass a local model directory to `SentenceTransformer`.
|
|
32
|
+
|
|
33
|
+
```python
|
|
34
|
+
from sentence_transformers import SentenceTransformer
|
|
35
|
+
|
|
36
|
+
from embedxray import EmbeddingXRayEvaluator
|
|
37
|
+
|
|
38
|
+
model = SentenceTransformer("sentence-transformers/all-MiniLM-L6-v2")
|
|
39
|
+
|
|
40
|
+
evaluator = EmbeddingXRayEvaluator(
|
|
41
|
+
corpus_texts=[
|
|
42
|
+
"Reset your password using the link on the sign-in page.",
|
|
43
|
+
"Add a recovery phone number in your account settings.",
|
|
44
|
+
"Update your payment method from the billing dashboard.",
|
|
45
|
+
"Export past invoices from the billing dashboard.",
|
|
46
|
+
"Contact support if your account is locked.",
|
|
47
|
+
],
|
|
48
|
+
query_texts=["How do I reset my password?", "Where can I download an invoice?"],
|
|
49
|
+
contrast_pairs=[
|
|
50
|
+
("Two-factor authentication is enabled.", "Two-factor authentication is disabled."),
|
|
51
|
+
],
|
|
52
|
+
k=2,
|
|
53
|
+
matryoshka_dims=[384, 128, 64],
|
|
54
|
+
cliff_threshold=0.95,
|
|
55
|
+
)
|
|
56
|
+
|
|
57
|
+
report = evaluator.evaluate_report(model, output_path="xray_out")
|
|
58
|
+
print(f"X-Ray health score: {report.health_score:.1f}/100")
|
|
59
|
+
print(report.fracture["fracture_cliff_config"])
|
|
60
|
+
```
|
|
61
|
+
|
|
62
|
+
Call `evaluator(model)` to get a flat metric dictionary for logging or a Sentence Transformers trainer. The default primary metric is `xray_health_score`. The most recent structured report is available as `evaluator.last_report`.
|
|
63
|
+
|
|
64
|
+
## Evaluation options
|
|
65
|
+
|
|
66
|
+
| Option | Behavior |
|
|
67
|
+
| --- | --- |
|
|
68
|
+
| `query_texts` | With no queries supplied, the corpus is queried against itself and each row excludes itself. An explicit empty list skips retrieval. |
|
|
69
|
+
| `contrast_pairs` | Supply pairs that should be distinguishable. A collision occurs above `collision_threshold`, which defaults to `0.90`. |
|
|
70
|
+
| `attribution_texts` | Defaults to the first 64 corpus entries. Supply representative text for attribution, or an empty list to skip it. |
|
|
71
|
+
| `matryoshka_dims`, `quantization_modes` | Select prefix dimensions and simulated precisions. Each selected dimension includes an FP32 result. |
|
|
72
|
+
| `k`, `chunk_size` | Set the neighbor count and similarity block size. See `report.metadata["actual_k"]` for the effective count after clamping to the eligible corpus size. |
|
|
73
|
+
|
|
74
|
+
## Reading the results
|
|
75
|
+
|
|
76
|
+
- **Health score** is a 0–100 summary of geometry, dimension health, hubness, compression stability, and attribution or contrast collisions. Compare runs on the same corpus, queries, and settings. Use labeled retrieval metrics such as Recall@k or nDCG to measure relevance.
|
|
77
|
+
- **Overlap@k** is the average fraction of the full-dimensional FP32 neighbor set retained by a configuration. **Self-similarity drift** reports mean cosine similarity between original and simulated vectors at the same dimension. Values closer to 1 indicate better directional preservation.
|
|
78
|
+
- **Fracture cliff** is the lowest estimated vector payload among configurations that reach the overlap threshold. The simulation estimates vector payload from dimension and precision. Index overhead, calibration metadata, padding, and retrieval latency are outside that estimate.
|
|
79
|
+
- **Unavailable measurements** appear as `null` in the structured report and are omitted from flat attribution and overlap metrics. Attribution samples include an `unavailable_reason` when token features cannot be aligned. When overlap cannot be measured, the cliff uses the full FP32 storage estimate.
|
|
80
|
+
|
|
81
|
+
When `output_path` is supplied, the evaluator writes these files.
|
|
82
|
+
|
|
83
|
+
| File | Contents |
|
|
84
|
+
| --- | --- |
|
|
85
|
+
| `xray_report.md` | Human-readable diagnostic summary and compression grid. |
|
|
86
|
+
| `xray_report.json` | Structured scores, per-sample token evidence, and details of offending contrast pairs. This file can contain original input text. |
|
|
87
|
+
| `xray_evaluation_results.csv` | An appended flat metric row with epoch and step columns. |
|
|
88
|
+
|
|
89
|
+
Use `name` to label report filenames and prefix metric keys. Use `write_csv=False` or `write_report=False` to disable the corresponding exports.
|
|
90
|
+
|
|
91
|
+
## Using precomputed embeddings
|
|
92
|
+
|
|
93
|
+
Run geometry or compression diagnostics directly on PyTorch tensors shaped `(samples, dimensions)`. For example, use `evaluate_fracture(corpus_embeddings, query_embeddings, k=10)` to inspect the compression grid. The corresponding geometry entry points are `compute_anisotropy`, `compute_dimension_health`, and `compute_hubness`, all exported from `embedxray`.
|
|
94
|
+
|
|
95
|
+
Retrieval uses exact batched similarity comparisons. Runtime increases with the number of query–corpus pairs and compression configurations.
|
|
96
|
+
|
|
97
|
+
## Development
|
|
98
|
+
|
|
99
|
+
```bash
|
|
100
|
+
git clone https://github.com/asysdev/embedxray.git
|
|
101
|
+
cd embedxray
|
|
102
|
+
python -m pip install -e '.[dev]'
|
|
103
|
+
HF_HUB_OFFLINE=1 TRANSFORMERS_OFFLINE=1 python -m pytest
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
The tests use synthetic embeddings and locally constructed models, so they run without downloading model weights.
|
|
107
|
+
|
|
108
|
+
## License
|
|
109
|
+
|
|
110
|
+
[Apache License 2.0](https://github.com/asysdev/embedxray/blob/main/LICENSE)
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["setuptools>=77.0.3", "wheel"]
|
|
3
|
+
build-backend = "setuptools.build_meta"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "embedxray"
|
|
7
|
+
version = "0.1.1"
|
|
8
|
+
description = "Read-only diagnostic and evaluation library for sentence-transformers embeddings."
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
requires-python = ">=3.10"
|
|
11
|
+
license = "Apache-2.0"
|
|
12
|
+
license-files = ["LICENSE"]
|
|
13
|
+
dependencies = [
|
|
14
|
+
"filelock>=3.10.0",
|
|
15
|
+
"torch>=2.0.0",
|
|
16
|
+
"sentence-transformers>=3.0.0",
|
|
17
|
+
]
|
|
18
|
+
|
|
19
|
+
[project.optional-dependencies]
|
|
20
|
+
dev = [
|
|
21
|
+
"pytest>=7.4.0",
|
|
22
|
+
]
|
|
23
|
+
|
|
24
|
+
[project.urls]
|
|
25
|
+
Repository = "https://github.com/asysdev/embedxray"
|
|
26
|
+
Issues = "https://github.com/asysdev/embedxray/issues"
|
|
27
|
+
|
|
28
|
+
[tool.setuptools.packages.find]
|
|
29
|
+
where = ["src"]
|
|
30
|
+
|
|
31
|
+
[tool.pytest.ini_options]
|
|
32
|
+
testpaths = ["tests"]
|
|
33
|
+
pythonpath = ["src", "tests"]
|
|
34
|
+
addopts = "-v"
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
"""embedxray: Diagnostic and evaluation library for sentence-transformers."""
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
from embedxray.evaluator import EmbeddingXRayEvaluator
|
|
6
|
+
from embedxray.modules import (
|
|
7
|
+
compute_anisotropy,
|
|
8
|
+
compute_dimension_health,
|
|
9
|
+
compute_hubness,
|
|
10
|
+
compute_pair_collisions,
|
|
11
|
+
compute_token_attribution,
|
|
12
|
+
evaluate_fracture,
|
|
13
|
+
)
|
|
14
|
+
from embedxray.report import XRayReport, compute_composite_health_score
|
|
15
|
+
from embedxray.utils import (
|
|
16
|
+
binarize_embeddings,
|
|
17
|
+
chunked_topk_binary,
|
|
18
|
+
chunked_topk_cosine,
|
|
19
|
+
safe_l2_normalize,
|
|
20
|
+
safe_svdvals,
|
|
21
|
+
simulate_fp16,
|
|
22
|
+
simulate_int4,
|
|
23
|
+
simulate_int8,
|
|
24
|
+
)
|
|
25
|
+
|
|
26
|
+
__version__ = "0.1.1"
|
|
27
|
+
|
|
28
|
+
__all__ = [
|
|
29
|
+
"EmbeddingXRayEvaluator",
|
|
30
|
+
"XRayReport",
|
|
31
|
+
"compute_composite_health_score",
|
|
32
|
+
"compute_token_attribution",
|
|
33
|
+
"compute_pair_collisions",
|
|
34
|
+
"compute_anisotropy",
|
|
35
|
+
"compute_dimension_health",
|
|
36
|
+
"compute_hubness",
|
|
37
|
+
"evaluate_fracture",
|
|
38
|
+
"safe_l2_normalize",
|
|
39
|
+
"safe_svdvals",
|
|
40
|
+
"chunked_topk_cosine",
|
|
41
|
+
"simulate_fp16",
|
|
42
|
+
"simulate_int8",
|
|
43
|
+
"simulate_int4",
|
|
44
|
+
"binarize_embeddings",
|
|
45
|
+
"chunked_topk_binary",
|
|
46
|
+
]
|