glinerel-fast 0.1.0__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.
- glinerel_fast-0.1.0/.gitignore +7 -0
- glinerel_fast-0.1.0/LICENSE +202 -0
- glinerel_fast-0.1.0/PKG-INFO +161 -0
- glinerel_fast-0.1.0/README.md +135 -0
- glinerel_fast-0.1.0/pyproject.toml +44 -0
- glinerel_fast-0.1.0/src/glinerel_fast/__init__.py +6 -0
- glinerel_fast-0.1.0/src/glinerel_fast/cli.py +171 -0
- glinerel_fast-0.1.0/src/glinerel_fast/config.py +134 -0
- glinerel_fast-0.1.0/src/glinerel_fast/decoding.py +264 -0
- glinerel_fast-0.1.0/src/glinerel_fast/hub.py +37 -0
- glinerel_fast-0.1.0/src/glinerel_fast/model.py +152 -0
- glinerel_fast-0.1.0/src/glinerel_fast/network.py +411 -0
- glinerel_fast-0.1.0/src/glinerel_fast/pipeline.py +244 -0
- glinerel_fast-0.1.0/src/glinerel_fast/preprocess.py +225 -0
- glinerel_fast-0.1.0/src/glinerel_fast/py.typed +0 -0
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
|
@@ -0,0 +1,161 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: glinerel-fast
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Fast, lightweight inference for glinerel entity, PII and relation extraction models
|
|
5
|
+
Project-URL: Homepage, https://github.com/VAGOsolutions/glinerel-fast
|
|
6
|
+
Project-URL: Repository, https://github.com/VAGOsolutions/glinerel-fast
|
|
7
|
+
Author: Michele Montebovi
|
|
8
|
+
License-Expression: Apache-2.0
|
|
9
|
+
License-File: LICENSE
|
|
10
|
+
Keywords: anonymization,gliner,inference,ner,pii,pytorch,relation-extraction
|
|
11
|
+
Classifier: Development Status :: 4 - Beta
|
|
12
|
+
Classifier: Intended Audience :: Developers
|
|
13
|
+
Classifier: Intended Audience :: Science/Research
|
|
14
|
+
Classifier: Operating System :: OS Independent
|
|
15
|
+
Classifier: Programming Language :: Python :: 3
|
|
16
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
17
|
+
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
|
|
18
|
+
Classifier: Topic :: Text Processing :: Linguistic
|
|
19
|
+
Requires-Python: >=3.10
|
|
20
|
+
Requires-Dist: huggingface-hub>=0.20
|
|
21
|
+
Requires-Dist: numpy>=1.22
|
|
22
|
+
Requires-Dist: safetensors>=0.4
|
|
23
|
+
Requires-Dist: tokenizers>=0.15
|
|
24
|
+
Requires-Dist: torch>=2.5
|
|
25
|
+
Description-Content-Type: text/markdown
|
|
26
|
+
|
|
27
|
+
# glinerel-fast
|
|
28
|
+
|
|
29
|
+
Fast, lightweight inference for glinerel entity, PII and relation extraction models.
|
|
30
|
+
|
|
31
|
+
* **Same predictions** as the models' reference implementation in float32 (checked on 1,288 texts, model sizes
|
|
32
|
+
72m, 128m and 314m, CPU and Apple GPU).
|
|
33
|
+
* **Faster**: up to 4x lower single-text latency on CPU, up to 2x the reference's speed on the GPU, and 4-7x faster
|
|
34
|
+
loading (see [Performance](#performance)).
|
|
35
|
+
* **Small**: ~1,650 lines of Python on PyTorch, NumPy, `tokenizers` and `safetensors`. No transformers, no model
|
|
36
|
+
conversion: the checkpoint's `model.safetensors` is read directly.
|
|
37
|
+
* **Runs where PyTorch runs**: CPU (Linux, Windows, macOS), NVIDIA / AMD GPUs, Apple silicon GPUs. The best
|
|
38
|
+
available device is picked automatically.
|
|
39
|
+
|
|
40
|
+
## Install
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
pip install glinerel-fast
|
|
44
|
+
```
|
|
45
|
+
|
|
46
|
+
For a specific PyTorch build (CPU-only, a given CUDA version, ROCm), install PyTorch first from
|
|
47
|
+
[pytorch.org](https://pytorch.org/get-started/locally/). Requires Python 3.10+ and PyTorch 2.5+.
|
|
48
|
+
|
|
49
|
+
The models are downloaded from the Hugging Face Hub on first use. If a repository is private, log in first
|
|
50
|
+
(`hf auth login`) or set `HF_TOKEN`.
|
|
51
|
+
|
|
52
|
+
## Quick start
|
|
53
|
+
|
|
54
|
+
```python
|
|
55
|
+
from glinerel_fast import GLiNERel
|
|
56
|
+
|
|
57
|
+
model = GLiNERel.from_pretrained("path/to/glinerel-model") # local folder or Hugging Face repository id
|
|
58
|
+
|
|
59
|
+
model.extract(
|
|
60
|
+
"Hi, I'm Laura Bianchi. Reach me at +39 347 555 0192 or laura.bianchi@example.com.",
|
|
61
|
+
entities=["first name", "last name", "phone number", "email"],
|
|
62
|
+
)
|
|
63
|
+
# {'entities': [{'label': 'first name', 'text': 'Laura', 'start': 8, 'end': 13, 'score': 0.9986},
|
|
64
|
+
# {'label': 'last name', 'text': 'Bianchi', 'start': 14, 'end': 21, 'score': 0.9991},
|
|
65
|
+
# {'label': 'phone number', 'text': '+39 347 555 0192', 'start': 35, 'end': 51, 'score': 0.9986},
|
|
66
|
+
# {'label': 'email', 'text': 'laura.bianchi@example.com', 'start': 55, 'end': 80, 'score': 0.9972}],
|
|
67
|
+
# 'relations': []}
|
|
68
|
+
```
|
|
69
|
+
|
|
70
|
+
### Entities and relations
|
|
71
|
+
|
|
72
|
+
```python
|
|
73
|
+
result = model.extract(
|
|
74
|
+
"Marie Curie was born in Warsaw in 1867. She married Pierre Curie.",
|
|
75
|
+
entities=["person", "location", "date"],
|
|
76
|
+
relations=["born in", "spouse"],
|
|
77
|
+
)
|
|
78
|
+
for r in result["relations"]:
|
|
79
|
+
print(r["head"]["text"], f"--[{r['label']}]-->", r["tail"]["text"], r["score"])
|
|
80
|
+
# Marie Curie --[born in]--> Warsaw 0.9686
|
|
81
|
+
# Marie Curie --[spouse]--> Pierre Curie 0.9479
|
|
82
|
+
```
|
|
83
|
+
|
|
84
|
+
`extract(texts, entities=None, relations=None, *, entity_threshold=0.5, relation_threshold=0.25, batch_size=8,
|
|
85
|
+
trim_punctuation=True, merge_mentions=False)`
|
|
86
|
+
|
|
87
|
+
* `texts`: one string (returns one result) or a list of strings (returns a list in the same order). Pass many texts
|
|
88
|
+
per call: they are sorted by length and batched internally.
|
|
89
|
+
* `entities` / `relations`: a list of labels, or `{label: threshold}` for per-label thresholds.
|
|
90
|
+
* Each result is `{"entities": [{"label", "text", "start", "end", "score"}], "relations": [{"label", "head":
|
|
91
|
+
{"text", "start", "end"}, "tail": {...}, "score"}]}`, with character offsets (`end` exclusive). Entities are sorted
|
|
92
|
+
by position, relations by score.
|
|
93
|
+
* `trim_punctuation=False` keeps the model's word-level spans (`"Warsaw."`); `merge_mentions=True` keeps one relation
|
|
94
|
+
per pair of entity surfaces.
|
|
95
|
+
|
|
96
|
+
### PII redaction
|
|
97
|
+
|
|
98
|
+
```python
|
|
99
|
+
PII = ["first name", "last name", "date of birth", "phone number", "email", "city", "passport number"]
|
|
100
|
+
text = "Hi, I'm Laura Bianchi, born on 3 May 1988. Call me at +39 347 555 0192, I live in Milano."
|
|
101
|
+
|
|
102
|
+
model.predict_entities(text, PII) # GLiNER-style list of entities
|
|
103
|
+
model.redact(text, PII)
|
|
104
|
+
# "Hi, I'm [FIRST_NAME] [LAST_NAME], born on [DATE_OF_BIRTH]. Call me at [PHONE_NUMBER], I live in [CITY]."
|
|
105
|
+
model.redact(text, PII, placeholder="<{label}>")
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
### Devices and precision
|
|
109
|
+
|
|
110
|
+
```python
|
|
111
|
+
GLiNERel.from_pretrained(model, device=None, precision="fp32", threads=None)
|
|
112
|
+
```
|
|
113
|
+
|
|
114
|
+
* `device`: `"cpu"`, `"cuda"`, `"cuda:1"`, `"mps"`; `None` picks CUDA, then MPS, then the CPU.
|
|
115
|
+
* `precision`: `"fp32"` (the reference's predictions), `"bf16"` or `"fp16"` (half-precision matrix products, for
|
|
116
|
+
GPUs; 99.6-100% agreement with fp32).
|
|
117
|
+
* `threads`: CPU threads. On Linux, prefer setting `OMP_NUM_THREADS` before starting Python.
|
|
118
|
+
|
|
119
|
+
Tips: pass many texts per call and, on GPUs, use `batch_size=32` or more. Every label adds a few tokens to every
|
|
120
|
+
text, so ask only for the labels you need. Long texts are not truncated; split very long documents by paragraph.
|
|
121
|
+
|
|
122
|
+
### Command line
|
|
123
|
+
|
|
124
|
+
```bash
|
|
125
|
+
glinerel-fast extract --model path/to/glinerel-model --text "Contact Laura at laura@example.com" \
|
|
126
|
+
--entities person email
|
|
127
|
+
glinerel-fast extract --model path/to/glinerel-model --input texts.jsonl --output out.jsonl \
|
|
128
|
+
--entities person organization --relations "works for"
|
|
129
|
+
glinerel-fast bench --model path/to/glinerel-model # time per text on this machine
|
|
130
|
+
glinerel-fast info # versions, GPUs, default device
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
## Performance
|
|
134
|
+
|
|
135
|
+
Apple M3 Pro, PyTorch 2.14, 64 PII texts with 20 PII labels, time per text. The reference is the models'
|
|
136
|
+
`inference.py` on the same PyTorch and device.
|
|
137
|
+
|
|
138
|
+
| Model size | Device | reference, 1 text | glinerel-fast, 1 text | reference, batch 32 | glinerel-fast, batch 32 | load |
|
|
139
|
+
|---|---|---:|---:|---:|---:|---:|
|
|
140
|
+
| 72m | CPU | 102.5 ms | 26.7 ms (**3.8x**) | 21.5 ms | 17.3 ms (1.2x) | 5.3 s → 0.8 s |
|
|
141
|
+
| 72m | GPU (MPS) | 26.2 ms | 15.2 ms (**1.7x**) | 13.3 ms | 6.6 ms (**2.0x**) | 7.0 s → 0.9 s |
|
|
142
|
+
| 128m | CPU | 155.4 ms | 37.9 ms (**4.1x**) | 30.9 ms | 24.3 ms (1.3x) | 5.4 s → 0.7 s |
|
|
143
|
+
| 128m | GPU (MPS) | 24.4 ms | 17.1 ms (1.4x) | 14.2 ms | 9.2 ms (**1.5x**) | 5.5 s → 1.1 s |
|
|
144
|
+
| 314m | CPU | 231.7 ms | 73.8 ms (**3.1x**) | 48.4 ms | 47.4 ms (1.0x) | 6.8 s → 1.1 s |
|
|
145
|
+
| 314m | GPU (MPS) | 32.6 ms | 23.2 ms (1.4x) | 20.3 ms | 15.1 ms (1.3x) | 7.2 s → 2.0 s |
|
|
146
|
+
|
|
147
|
+
On a Linux CPU (OpenBLAS) the two implementations are bound by the same matrix products and run at about the same
|
|
148
|
+
speed (0.9-1.4x), with the faster loading. NVIDIA GPUs and Windows have not been benchmarked yet.
|
|
149
|
+
|
|
150
|
+
Accuracy against the reference (agreement F1, the reference's predictions as gold; 1,000 PII texts in 5 languages
|
|
151
|
+
and the 288 CoNLL04 test sentences):
|
|
152
|
+
|
|
153
|
+
| Precision | PII entities | CoNLL04 entities | CoNLL04 relations |
|
|
154
|
+
|---|---:|---:|---:|
|
|
155
|
+
| fp32 (CPU, MPS), all three sizes | 1.0000 | 1.0000 | 1.0000 |
|
|
156
|
+
| fp16 (MPS) | 0.9991-0.9998 | 0.9995-1.0000 | 0.9963-1.0000 |
|
|
157
|
+
| *the reference's own bf16 mode, for comparison* | *0.9915-0.9926* | *0.9978-0.9990* | *0.9902-0.9967* |
|
|
158
|
+
|
|
159
|
+
## License
|
|
160
|
+
|
|
161
|
+
Apache-2.0 for this library. The model weights are subject to their own license on the Hugging Face Hub.
|
|
@@ -0,0 +1,135 @@
|
|
|
1
|
+
# glinerel-fast
|
|
2
|
+
|
|
3
|
+
Fast, lightweight inference for glinerel entity, PII and relation extraction models.
|
|
4
|
+
|
|
5
|
+
* **Same predictions** as the models' reference implementation in float32 (checked on 1,288 texts, model sizes
|
|
6
|
+
72m, 128m and 314m, CPU and Apple GPU).
|
|
7
|
+
* **Faster**: up to 4x lower single-text latency on CPU, up to 2x the reference's speed on the GPU, and 4-7x faster
|
|
8
|
+
loading (see [Performance](#performance)).
|
|
9
|
+
* **Small**: ~1,650 lines of Python on PyTorch, NumPy, `tokenizers` and `safetensors`. No transformers, no model
|
|
10
|
+
conversion: the checkpoint's `model.safetensors` is read directly.
|
|
11
|
+
* **Runs where PyTorch runs**: CPU (Linux, Windows, macOS), NVIDIA / AMD GPUs, Apple silicon GPUs. The best
|
|
12
|
+
available device is picked automatically.
|
|
13
|
+
|
|
14
|
+
## Install
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
pip install glinerel-fast
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
For a specific PyTorch build (CPU-only, a given CUDA version, ROCm), install PyTorch first from
|
|
21
|
+
[pytorch.org](https://pytorch.org/get-started/locally/). Requires Python 3.10+ and PyTorch 2.5+.
|
|
22
|
+
|
|
23
|
+
The models are downloaded from the Hugging Face Hub on first use. If a repository is private, log in first
|
|
24
|
+
(`hf auth login`) or set `HF_TOKEN`.
|
|
25
|
+
|
|
26
|
+
## Quick start
|
|
27
|
+
|
|
28
|
+
```python
|
|
29
|
+
from glinerel_fast import GLiNERel
|
|
30
|
+
|
|
31
|
+
model = GLiNERel.from_pretrained("path/to/glinerel-model") # local folder or Hugging Face repository id
|
|
32
|
+
|
|
33
|
+
model.extract(
|
|
34
|
+
"Hi, I'm Laura Bianchi. Reach me at +39 347 555 0192 or laura.bianchi@example.com.",
|
|
35
|
+
entities=["first name", "last name", "phone number", "email"],
|
|
36
|
+
)
|
|
37
|
+
# {'entities': [{'label': 'first name', 'text': 'Laura', 'start': 8, 'end': 13, 'score': 0.9986},
|
|
38
|
+
# {'label': 'last name', 'text': 'Bianchi', 'start': 14, 'end': 21, 'score': 0.9991},
|
|
39
|
+
# {'label': 'phone number', 'text': '+39 347 555 0192', 'start': 35, 'end': 51, 'score': 0.9986},
|
|
40
|
+
# {'label': 'email', 'text': 'laura.bianchi@example.com', 'start': 55, 'end': 80, 'score': 0.9972}],
|
|
41
|
+
# 'relations': []}
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
### Entities and relations
|
|
45
|
+
|
|
46
|
+
```python
|
|
47
|
+
result = model.extract(
|
|
48
|
+
"Marie Curie was born in Warsaw in 1867. She married Pierre Curie.",
|
|
49
|
+
entities=["person", "location", "date"],
|
|
50
|
+
relations=["born in", "spouse"],
|
|
51
|
+
)
|
|
52
|
+
for r in result["relations"]:
|
|
53
|
+
print(r["head"]["text"], f"--[{r['label']}]-->", r["tail"]["text"], r["score"])
|
|
54
|
+
# Marie Curie --[born in]--> Warsaw 0.9686
|
|
55
|
+
# Marie Curie --[spouse]--> Pierre Curie 0.9479
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
`extract(texts, entities=None, relations=None, *, entity_threshold=0.5, relation_threshold=0.25, batch_size=8,
|
|
59
|
+
trim_punctuation=True, merge_mentions=False)`
|
|
60
|
+
|
|
61
|
+
* `texts`: one string (returns one result) or a list of strings (returns a list in the same order). Pass many texts
|
|
62
|
+
per call: they are sorted by length and batched internally.
|
|
63
|
+
* `entities` / `relations`: a list of labels, or `{label: threshold}` for per-label thresholds.
|
|
64
|
+
* Each result is `{"entities": [{"label", "text", "start", "end", "score"}], "relations": [{"label", "head":
|
|
65
|
+
{"text", "start", "end"}, "tail": {...}, "score"}]}`, with character offsets (`end` exclusive). Entities are sorted
|
|
66
|
+
by position, relations by score.
|
|
67
|
+
* `trim_punctuation=False` keeps the model's word-level spans (`"Warsaw."`); `merge_mentions=True` keeps one relation
|
|
68
|
+
per pair of entity surfaces.
|
|
69
|
+
|
|
70
|
+
### PII redaction
|
|
71
|
+
|
|
72
|
+
```python
|
|
73
|
+
PII = ["first name", "last name", "date of birth", "phone number", "email", "city", "passport number"]
|
|
74
|
+
text = "Hi, I'm Laura Bianchi, born on 3 May 1988. Call me at +39 347 555 0192, I live in Milano."
|
|
75
|
+
|
|
76
|
+
model.predict_entities(text, PII) # GLiNER-style list of entities
|
|
77
|
+
model.redact(text, PII)
|
|
78
|
+
# "Hi, I'm [FIRST_NAME] [LAST_NAME], born on [DATE_OF_BIRTH]. Call me at [PHONE_NUMBER], I live in [CITY]."
|
|
79
|
+
model.redact(text, PII, placeholder="<{label}>")
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
### Devices and precision
|
|
83
|
+
|
|
84
|
+
```python
|
|
85
|
+
GLiNERel.from_pretrained(model, device=None, precision="fp32", threads=None)
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
* `device`: `"cpu"`, `"cuda"`, `"cuda:1"`, `"mps"`; `None` picks CUDA, then MPS, then the CPU.
|
|
89
|
+
* `precision`: `"fp32"` (the reference's predictions), `"bf16"` or `"fp16"` (half-precision matrix products, for
|
|
90
|
+
GPUs; 99.6-100% agreement with fp32).
|
|
91
|
+
* `threads`: CPU threads. On Linux, prefer setting `OMP_NUM_THREADS` before starting Python.
|
|
92
|
+
|
|
93
|
+
Tips: pass many texts per call and, on GPUs, use `batch_size=32` or more. Every label adds a few tokens to every
|
|
94
|
+
text, so ask only for the labels you need. Long texts are not truncated; split very long documents by paragraph.
|
|
95
|
+
|
|
96
|
+
### Command line
|
|
97
|
+
|
|
98
|
+
```bash
|
|
99
|
+
glinerel-fast extract --model path/to/glinerel-model --text "Contact Laura at laura@example.com" \
|
|
100
|
+
--entities person email
|
|
101
|
+
glinerel-fast extract --model path/to/glinerel-model --input texts.jsonl --output out.jsonl \
|
|
102
|
+
--entities person organization --relations "works for"
|
|
103
|
+
glinerel-fast bench --model path/to/glinerel-model # time per text on this machine
|
|
104
|
+
glinerel-fast info # versions, GPUs, default device
|
|
105
|
+
```
|
|
106
|
+
|
|
107
|
+
## Performance
|
|
108
|
+
|
|
109
|
+
Apple M3 Pro, PyTorch 2.14, 64 PII texts with 20 PII labels, time per text. The reference is the models'
|
|
110
|
+
`inference.py` on the same PyTorch and device.
|
|
111
|
+
|
|
112
|
+
| Model size | Device | reference, 1 text | glinerel-fast, 1 text | reference, batch 32 | glinerel-fast, batch 32 | load |
|
|
113
|
+
|---|---|---:|---:|---:|---:|---:|
|
|
114
|
+
| 72m | CPU | 102.5 ms | 26.7 ms (**3.8x**) | 21.5 ms | 17.3 ms (1.2x) | 5.3 s → 0.8 s |
|
|
115
|
+
| 72m | GPU (MPS) | 26.2 ms | 15.2 ms (**1.7x**) | 13.3 ms | 6.6 ms (**2.0x**) | 7.0 s → 0.9 s |
|
|
116
|
+
| 128m | CPU | 155.4 ms | 37.9 ms (**4.1x**) | 30.9 ms | 24.3 ms (1.3x) | 5.4 s → 0.7 s |
|
|
117
|
+
| 128m | GPU (MPS) | 24.4 ms | 17.1 ms (1.4x) | 14.2 ms | 9.2 ms (**1.5x**) | 5.5 s → 1.1 s |
|
|
118
|
+
| 314m | CPU | 231.7 ms | 73.8 ms (**3.1x**) | 48.4 ms | 47.4 ms (1.0x) | 6.8 s → 1.1 s |
|
|
119
|
+
| 314m | GPU (MPS) | 32.6 ms | 23.2 ms (1.4x) | 20.3 ms | 15.1 ms (1.3x) | 7.2 s → 2.0 s |
|
|
120
|
+
|
|
121
|
+
On a Linux CPU (OpenBLAS) the two implementations are bound by the same matrix products and run at about the same
|
|
122
|
+
speed (0.9-1.4x), with the faster loading. NVIDIA GPUs and Windows have not been benchmarked yet.
|
|
123
|
+
|
|
124
|
+
Accuracy against the reference (agreement F1, the reference's predictions as gold; 1,000 PII texts in 5 languages
|
|
125
|
+
and the 288 CoNLL04 test sentences):
|
|
126
|
+
|
|
127
|
+
| Precision | PII entities | CoNLL04 entities | CoNLL04 relations |
|
|
128
|
+
|---|---:|---:|---:|
|
|
129
|
+
| fp32 (CPU, MPS), all three sizes | 1.0000 | 1.0000 | 1.0000 |
|
|
130
|
+
| fp16 (MPS) | 0.9991-0.9998 | 0.9995-1.0000 | 0.9963-1.0000 |
|
|
131
|
+
| *the reference's own bf16 mode, for comparison* | *0.9915-0.9926* | *0.9978-0.9990* | *0.9902-0.9967* |
|
|
132
|
+
|
|
133
|
+
## License
|
|
134
|
+
|
|
135
|
+
Apache-2.0 for this library. The model weights are subject to their own license on the Hugging Face Hub.
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["hatchling>=1.24"]
|
|
3
|
+
build-backend = "hatchling.build"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "glinerel-fast"
|
|
7
|
+
version = "0.1.0"
|
|
8
|
+
description = "Fast, lightweight inference for glinerel entity, PII and relation extraction models"
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
requires-python = ">=3.10"
|
|
11
|
+
license = "Apache-2.0"
|
|
12
|
+
license-files = ["LICENSE"]
|
|
13
|
+
authors = [{ name = "Michele Montebovi" }]
|
|
14
|
+
keywords = ["pii", "ner", "relation-extraction", "gliner", "pytorch", "inference", "anonymization"]
|
|
15
|
+
classifiers = [
|
|
16
|
+
"Development Status :: 4 - Beta",
|
|
17
|
+
"Intended Audience :: Developers",
|
|
18
|
+
"Intended Audience :: Science/Research",
|
|
19
|
+
"Operating System :: OS Independent",
|
|
20
|
+
"Programming Language :: Python :: 3",
|
|
21
|
+
"Programming Language :: Python :: 3 :: Only",
|
|
22
|
+
"Topic :: Scientific/Engineering :: Artificial Intelligence",
|
|
23
|
+
"Topic :: Text Processing :: Linguistic",
|
|
24
|
+
]
|
|
25
|
+
dependencies = [
|
|
26
|
+
"torch>=2.5",
|
|
27
|
+
"numpy>=1.22",
|
|
28
|
+
"tokenizers>=0.15",
|
|
29
|
+
"safetensors>=0.4",
|
|
30
|
+
"huggingface_hub>=0.20",
|
|
31
|
+
]
|
|
32
|
+
|
|
33
|
+
[project.urls]
|
|
34
|
+
Homepage = "https://github.com/VAGOsolutions/glinerel-fast"
|
|
35
|
+
Repository = "https://github.com/VAGOsolutions/glinerel-fast"
|
|
36
|
+
|
|
37
|
+
[project.scripts]
|
|
38
|
+
glinerel-fast = "glinerel_fast.cli:main"
|
|
39
|
+
|
|
40
|
+
[tool.hatch.build.targets.wheel]
|
|
41
|
+
packages = ["src/glinerel_fast"]
|
|
42
|
+
|
|
43
|
+
[tool.hatch.build.targets.sdist]
|
|
44
|
+
include = ["src/glinerel_fast", "README.md", "LICENSE", "pyproject.toml"]
|