cjm-sentence-segmentation-adapter-interface 0.0.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.
- cjm_sentence_segmentation_adapter_interface-0.0.1/LICENSE +201 -0
- cjm_sentence_segmentation_adapter_interface-0.0.1/PKG-INFO +43 -0
- cjm_sentence_segmentation_adapter_interface-0.0.1/README.md +27 -0
- cjm_sentence_segmentation_adapter_interface-0.0.1/cjm_sentence_segmentation_adapter_interface/__init__.py +1 -0
- cjm_sentence_segmentation_adapter_interface-0.0.1/cjm_sentence_segmentation_adapter_interface/adapter.py +63 -0
- cjm_sentence_segmentation_adapter_interface-0.0.1/cjm_sentence_segmentation_adapter_interface/generic.py +25 -0
- cjm_sentence_segmentation_adapter_interface-0.0.1/cjm_sentence_segmentation_adapter_interface.egg-info/PKG-INFO +43 -0
- cjm_sentence_segmentation_adapter_interface-0.0.1/cjm_sentence_segmentation_adapter_interface.egg-info/SOURCES.txt +12 -0
- cjm_sentence_segmentation_adapter_interface-0.0.1/cjm_sentence_segmentation_adapter_interface.egg-info/dependency_links.txt +1 -0
- cjm_sentence_segmentation_adapter_interface-0.0.1/cjm_sentence_segmentation_adapter_interface.egg-info/requires.txt +2 -0
- cjm_sentence_segmentation_adapter_interface-0.0.1/cjm_sentence_segmentation_adapter_interface.egg-info/top_level.txt +1 -0
- cjm_sentence_segmentation_adapter_interface-0.0.1/pyproject.toml +29 -0
- cjm_sentence_segmentation_adapter_interface-0.0.1/setup.cfg +4 -0
- cjm_sentence_segmentation_adapter_interface-0.0.1/tests/test_adapter.py +50 -0
|
@@ -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 2022, fastai
|
|
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.
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: cjm-sentence-segmentation-adapter-interface
|
|
3
|
+
Version: 0.0.1
|
|
4
|
+
Summary: Typed sentence-segmentation task-adapter interface — SentenceSegmentationAdapter ABC + GenericSentenceSegmentationAdapter (thin pass-through around a pure-compute segmenter tool) and the SentenceSegmentationToolProtocol. The SentenceSegmentationResult data noun lives in cjm-capability-primitives.
|
|
5
|
+
Author-email: "Christian J. Mills" <9126128+cj-mills@users.noreply.github.com>
|
|
6
|
+
License: Apache-2.0
|
|
7
|
+
Project-URL: Repository, https://github.com/cj-mills/cjm-sentence-segmentation-adapter-interface
|
|
8
|
+
Classifier: Programming Language :: Python :: 3
|
|
9
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
10
|
+
Requires-Python: >=3.12
|
|
11
|
+
Description-Content-Type: text/markdown
|
|
12
|
+
License-File: LICENSE
|
|
13
|
+
Requires-Dist: cjm-substrate>=0.0.58
|
|
14
|
+
Requires-Dist: cjm-capability-primitives>=0.0.11
|
|
15
|
+
Dynamic: license-file
|
|
16
|
+
|
|
17
|
+
# cjm-sentence-segmentation-adapter-interface
|
|
18
|
+
|
|
19
|
+
<!-- generated from the context graph by `cjm-context-graph readme` — do not edit by hand; edit the graph (the urge to hand-edit = move it on-graph) -->
|
|
20
|
+
|
|
21
|
+
Typed sentence-segmentation task-adapter interface for the cjm-substrate runtime. The task noun: segment_text(text) -> ordered (start_char, end_char) sentence spans over the ORIGINAL punctuated text — callers (the transcript decomposition pipeline's sentence-split stage) map sentence boundaries onto forced-alignment word spans, then onto word-gap cut times, so preserving the caller's character offsets is the whole contract. Ships the SentenceSegmentationToolProtocol structural contract, the SentenceSegmentationAdapter ABC (task_name sentence_segmentation), and the deliberately bookend-free GenericSentenceSegmentationAdapter (rule-based segmentation is deterministic sub-millisecond CPU work — no cache DB, unlike the VAD/FA generic adapters). The SentenceSpan/SentenceSegmentationResult data nouns live in cjm-capability-primitives (wire kind sentence_segmentation.result). First adapter: cjm-capability-pysbd; wtpsplit/SaT is the planned second if unpunctuated transcriber output creates demand.
|
|
22
|
+
|
|
23
|
+
## Modules
|
|
24
|
+
|
|
25
|
+
- **`cjm_sentence_segmentation_adapter_interface.__init__`**
|
|
26
|
+
- **`cjm_sentence_segmentation_adapter_interface.adapter`** — The typed sentence-segmentation task contract — the `SentenceSegmentationAdapter` ABC + the `SentenceSegmentationToolProtocol` structural contract (capability-unit Option C; B.5 work item 81e43606).
|
|
27
|
+
- **`cjm_sentence_segmentation_adapter_interface.generic`** — The generic (tool-agnostic) sentence-segmentation adapter — a thin typed pass-through to the bound tool's pure-compute `segment_text`. Reused across every tool capability satisfying `SentenceSegmentationToolProtocol`, exactly as `GenericVADAdapter` is reused across VAD tools.
|
|
28
|
+
|
|
29
|
+
## API
|
|
30
|
+
|
|
31
|
+
### `cjm_sentence_segmentation_adapter_interface.adapter`
|
|
32
|
+
|
|
33
|
+
- `SentenceSegmentationAdapter` _class_ — Typed sentence-segmentation task adapter: original punctuated text in,
|
|
34
|
+
- `SentenceSegmentationToolProtocol` _class_ — Structural contract for sentence-segmentation tool capabilities.
|
|
35
|
+
|
|
36
|
+
### `cjm_sentence_segmentation_adapter_interface.generic`
|
|
37
|
+
|
|
38
|
+
- `GenericSentenceSegmentationAdapter` _class_ — Generic sentence-segmentation adapter: invoke the pure-compute tool.
|
|
39
|
+
|
|
40
|
+
## Dependencies
|
|
41
|
+
|
|
42
|
+
**Depends on:** `cjm-capability-primitives`, `cjm-substrate`
|
|
43
|
+
**Used by:** `cjm-capability-pysbd`
|
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# cjm-sentence-segmentation-adapter-interface
|
|
2
|
+
|
|
3
|
+
<!-- generated from the context graph by `cjm-context-graph readme` — do not edit by hand; edit the graph (the urge to hand-edit = move it on-graph) -->
|
|
4
|
+
|
|
5
|
+
Typed sentence-segmentation task-adapter interface for the cjm-substrate runtime. The task noun: segment_text(text) -> ordered (start_char, end_char) sentence spans over the ORIGINAL punctuated text — callers (the transcript decomposition pipeline's sentence-split stage) map sentence boundaries onto forced-alignment word spans, then onto word-gap cut times, so preserving the caller's character offsets is the whole contract. Ships the SentenceSegmentationToolProtocol structural contract, the SentenceSegmentationAdapter ABC (task_name sentence_segmentation), and the deliberately bookend-free GenericSentenceSegmentationAdapter (rule-based segmentation is deterministic sub-millisecond CPU work — no cache DB, unlike the VAD/FA generic adapters). The SentenceSpan/SentenceSegmentationResult data nouns live in cjm-capability-primitives (wire kind sentence_segmentation.result). First adapter: cjm-capability-pysbd; wtpsplit/SaT is the planned second if unpunctuated transcriber output creates demand.
|
|
6
|
+
|
|
7
|
+
## Modules
|
|
8
|
+
|
|
9
|
+
- **`cjm_sentence_segmentation_adapter_interface.__init__`**
|
|
10
|
+
- **`cjm_sentence_segmentation_adapter_interface.adapter`** — The typed sentence-segmentation task contract — the `SentenceSegmentationAdapter` ABC + the `SentenceSegmentationToolProtocol` structural contract (capability-unit Option C; B.5 work item 81e43606).
|
|
11
|
+
- **`cjm_sentence_segmentation_adapter_interface.generic`** — The generic (tool-agnostic) sentence-segmentation adapter — a thin typed pass-through to the bound tool's pure-compute `segment_text`. Reused across every tool capability satisfying `SentenceSegmentationToolProtocol`, exactly as `GenericVADAdapter` is reused across VAD tools.
|
|
12
|
+
|
|
13
|
+
## API
|
|
14
|
+
|
|
15
|
+
### `cjm_sentence_segmentation_adapter_interface.adapter`
|
|
16
|
+
|
|
17
|
+
- `SentenceSegmentationAdapter` _class_ — Typed sentence-segmentation task adapter: original punctuated text in,
|
|
18
|
+
- `SentenceSegmentationToolProtocol` _class_ — Structural contract for sentence-segmentation tool capabilities.
|
|
19
|
+
|
|
20
|
+
### `cjm_sentence_segmentation_adapter_interface.generic`
|
|
21
|
+
|
|
22
|
+
- `GenericSentenceSegmentationAdapter` _class_ — Generic sentence-segmentation adapter: invoke the pure-compute tool.
|
|
23
|
+
|
|
24
|
+
## Dependencies
|
|
25
|
+
|
|
26
|
+
**Depends on:** `cjm-capability-primitives`, `cjm-substrate`
|
|
27
|
+
**Used by:** `cjm-capability-pysbd`
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
__version__ = "0.0.1"
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
"""The typed sentence-segmentation task contract — the `SentenceSegmentationAdapter` ABC + the `SentenceSegmentationToolProtocol` structural contract (capability-unit Option C; B.5 work item 81e43606)."""
|
|
2
|
+
|
|
3
|
+
from abc import abstractmethod
|
|
4
|
+
from typing import Any, ClassVar, Dict, Protocol, runtime_checkable
|
|
5
|
+
|
|
6
|
+
from cjm_capability_primitives.sentence_segmentation import SentenceSegmentationResult
|
|
7
|
+
from cjm_substrate.core.adapter import TaskAdapter
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
# Canonical home (stage 8 / PILLAR 1c): the data noun lives in
|
|
11
|
+
# cjm-capability-primitives, so the pure-compute tool depends on it, never on
|
|
12
|
+
# this adapter machinery.
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
@runtime_checkable
|
|
16
|
+
class SentenceSegmentationToolProtocol(Protocol):
|
|
17
|
+
"""Structural contract for sentence-segmentation tool capabilities.
|
|
18
|
+
|
|
19
|
+
Pure compute: `segment_text` reads the original (punctuated) text and
|
|
20
|
+
returns ordered character spans over it. `get_current_config` supplies the
|
|
21
|
+
effective config whose canonical hash joins downstream identity composites
|
|
22
|
+
(the decomp skeleton hash)."""
|
|
23
|
+
def segment_text(self, text: str, **kwargs) -> SentenceSegmentationResult: ...
|
|
24
|
+
def get_current_config(self) -> Dict[str, Any]: ...
|
|
25
|
+
|
|
26
|
+
|
|
27
|
+
class SentenceSegmentationAdapter(TaskAdapter):
|
|
28
|
+
"""Typed sentence-segmentation task adapter: original punctuated text in,
|
|
29
|
+
`SentenceSegmentationResult` (ordered char spans over that text) out.
|
|
30
|
+
|
|
31
|
+
Input contract: the caller passes the ORIGINAL text whose offsets it needs
|
|
32
|
+
preserved — spans in the result always index into exactly that string
|
|
33
|
+
(a tool that normalizes internally must map spans back).
|
|
34
|
+
|
|
35
|
+
Unlike the VAD/FA adapters there are NO cache/persist bookends here:
|
|
36
|
+
rule-based segmentation is deterministic sub-millisecond CPU work with no
|
|
37
|
+
model-load cost to amortize, so a cache DB would cost more than the
|
|
38
|
+
compute it saves. A future model-backed segmenter (wtpsplit/SaT) that
|
|
39
|
+
changes that calculus adds bookends in its own generic adapter revision.
|
|
40
|
+
|
|
41
|
+
Implementations run in-worker beside their tool capability and are
|
|
42
|
+
constructed with the bound tool instance: `AdapterClass(tool)`. The result
|
|
43
|
+
DTO is wire-registered ("sentence_segmentation.result"): returned values
|
|
44
|
+
cross the worker boundary typed.
|
|
45
|
+
"""
|
|
46
|
+
|
|
47
|
+
task_name: ClassVar[str] = "sentence_segmentation"
|
|
48
|
+
required_tool_protocol: ClassVar[type] = SentenceSegmentationToolProtocol
|
|
49
|
+
|
|
50
|
+
def __init__(
|
|
51
|
+
self,
|
|
52
|
+
tool: SentenceSegmentationToolProtocol, # The bound tool capability instance (worker-side binding)
|
|
53
|
+
):
|
|
54
|
+
self.tool = tool
|
|
55
|
+
|
|
56
|
+
@abstractmethod
|
|
57
|
+
def segment_text(
|
|
58
|
+
self,
|
|
59
|
+
text: str, # The original (punctuated) text to segment
|
|
60
|
+
**kwargs, # Provenance + tool options
|
|
61
|
+
) -> SentenceSegmentationResult: # Ordered sentence spans over `text`
|
|
62
|
+
"""Segment text into ordered sentence character spans."""
|
|
63
|
+
...
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
"""The generic (tool-agnostic) sentence-segmentation adapter — a thin typed pass-through to the bound tool's pure-compute `segment_text`. Reused across every tool capability satisfying `SentenceSegmentationToolProtocol`, exactly as `GenericVADAdapter` is reused across VAD tools."""
|
|
2
|
+
|
|
3
|
+
from cjm_capability_primitives.sentence_segmentation import SentenceSegmentationResult
|
|
4
|
+
|
|
5
|
+
from .adapter import SentenceSegmentationAdapter
|
|
6
|
+
|
|
7
|
+
|
|
8
|
+
class GenericSentenceSegmentationAdapter(SentenceSegmentationAdapter):
|
|
9
|
+
"""Generic sentence-segmentation adapter: invoke the pure-compute tool.
|
|
10
|
+
|
|
11
|
+
Works against ANY tool satisfying `SentenceSegmentationToolProtocol`.
|
|
12
|
+
Deliberately bookend-free (no cache DB, no force control): rule-based
|
|
13
|
+
segmentation is deterministic and cheaper than a cache lookup, and the
|
|
14
|
+
caller (the decomp pipeline) already folds the result into its own
|
|
15
|
+
persisted skeleton identity. If a model-backed segmenter ever makes
|
|
16
|
+
caching worthwhile, the bookends land here without touching any tool.
|
|
17
|
+
"""
|
|
18
|
+
|
|
19
|
+
def segment_text(
|
|
20
|
+
self,
|
|
21
|
+
text: str, # The original (punctuated) text to segment
|
|
22
|
+
**kwargs, # Provenance + tool options
|
|
23
|
+
) -> SentenceSegmentationResult: # Ordered sentence spans over `text`
|
|
24
|
+
"""Invoke the bound tool's pure-compute `segment_text`."""
|
|
25
|
+
return self.tool.segment_text(text, **kwargs)
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: cjm-sentence-segmentation-adapter-interface
|
|
3
|
+
Version: 0.0.1
|
|
4
|
+
Summary: Typed sentence-segmentation task-adapter interface — SentenceSegmentationAdapter ABC + GenericSentenceSegmentationAdapter (thin pass-through around a pure-compute segmenter tool) and the SentenceSegmentationToolProtocol. The SentenceSegmentationResult data noun lives in cjm-capability-primitives.
|
|
5
|
+
Author-email: "Christian J. Mills" <9126128+cj-mills@users.noreply.github.com>
|
|
6
|
+
License: Apache-2.0
|
|
7
|
+
Project-URL: Repository, https://github.com/cj-mills/cjm-sentence-segmentation-adapter-interface
|
|
8
|
+
Classifier: Programming Language :: Python :: 3
|
|
9
|
+
Classifier: Programming Language :: Python :: 3 :: Only
|
|
10
|
+
Requires-Python: >=3.12
|
|
11
|
+
Description-Content-Type: text/markdown
|
|
12
|
+
License-File: LICENSE
|
|
13
|
+
Requires-Dist: cjm-substrate>=0.0.58
|
|
14
|
+
Requires-Dist: cjm-capability-primitives>=0.0.11
|
|
15
|
+
Dynamic: license-file
|
|
16
|
+
|
|
17
|
+
# cjm-sentence-segmentation-adapter-interface
|
|
18
|
+
|
|
19
|
+
<!-- generated from the context graph by `cjm-context-graph readme` — do not edit by hand; edit the graph (the urge to hand-edit = move it on-graph) -->
|
|
20
|
+
|
|
21
|
+
Typed sentence-segmentation task-adapter interface for the cjm-substrate runtime. The task noun: segment_text(text) -> ordered (start_char, end_char) sentence spans over the ORIGINAL punctuated text — callers (the transcript decomposition pipeline's sentence-split stage) map sentence boundaries onto forced-alignment word spans, then onto word-gap cut times, so preserving the caller's character offsets is the whole contract. Ships the SentenceSegmentationToolProtocol structural contract, the SentenceSegmentationAdapter ABC (task_name sentence_segmentation), and the deliberately bookend-free GenericSentenceSegmentationAdapter (rule-based segmentation is deterministic sub-millisecond CPU work — no cache DB, unlike the VAD/FA generic adapters). The SentenceSpan/SentenceSegmentationResult data nouns live in cjm-capability-primitives (wire kind sentence_segmentation.result). First adapter: cjm-capability-pysbd; wtpsplit/SaT is the planned second if unpunctuated transcriber output creates demand.
|
|
22
|
+
|
|
23
|
+
## Modules
|
|
24
|
+
|
|
25
|
+
- **`cjm_sentence_segmentation_adapter_interface.__init__`**
|
|
26
|
+
- **`cjm_sentence_segmentation_adapter_interface.adapter`** — The typed sentence-segmentation task contract — the `SentenceSegmentationAdapter` ABC + the `SentenceSegmentationToolProtocol` structural contract (capability-unit Option C; B.5 work item 81e43606).
|
|
27
|
+
- **`cjm_sentence_segmentation_adapter_interface.generic`** — The generic (tool-agnostic) sentence-segmentation adapter — a thin typed pass-through to the bound tool's pure-compute `segment_text`. Reused across every tool capability satisfying `SentenceSegmentationToolProtocol`, exactly as `GenericVADAdapter` is reused across VAD tools.
|
|
28
|
+
|
|
29
|
+
## API
|
|
30
|
+
|
|
31
|
+
### `cjm_sentence_segmentation_adapter_interface.adapter`
|
|
32
|
+
|
|
33
|
+
- `SentenceSegmentationAdapter` _class_ — Typed sentence-segmentation task adapter: original punctuated text in,
|
|
34
|
+
- `SentenceSegmentationToolProtocol` _class_ — Structural contract for sentence-segmentation tool capabilities.
|
|
35
|
+
|
|
36
|
+
### `cjm_sentence_segmentation_adapter_interface.generic`
|
|
37
|
+
|
|
38
|
+
- `GenericSentenceSegmentationAdapter` _class_ — Generic sentence-segmentation adapter: invoke the pure-compute tool.
|
|
39
|
+
|
|
40
|
+
## Dependencies
|
|
41
|
+
|
|
42
|
+
**Depends on:** `cjm-capability-primitives`, `cjm-substrate`
|
|
43
|
+
**Used by:** `cjm-capability-pysbd`
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
LICENSE
|
|
2
|
+
README.md
|
|
3
|
+
pyproject.toml
|
|
4
|
+
cjm_sentence_segmentation_adapter_interface/__init__.py
|
|
5
|
+
cjm_sentence_segmentation_adapter_interface/adapter.py
|
|
6
|
+
cjm_sentence_segmentation_adapter_interface/generic.py
|
|
7
|
+
cjm_sentence_segmentation_adapter_interface.egg-info/PKG-INFO
|
|
8
|
+
cjm_sentence_segmentation_adapter_interface.egg-info/SOURCES.txt
|
|
9
|
+
cjm_sentence_segmentation_adapter_interface.egg-info/dependency_links.txt
|
|
10
|
+
cjm_sentence_segmentation_adapter_interface.egg-info/requires.txt
|
|
11
|
+
cjm_sentence_segmentation_adapter_interface.egg-info/top_level.txt
|
|
12
|
+
tests/test_adapter.py
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
cjm_sentence_segmentation_adapter_interface
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["setuptools>=64"]
|
|
3
|
+
build-backend = "setuptools.build_meta"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "cjm-sentence-segmentation-adapter-interface"
|
|
7
|
+
dynamic = ["version"]
|
|
8
|
+
description = "Typed sentence-segmentation task-adapter interface — SentenceSegmentationAdapter ABC + GenericSentenceSegmentationAdapter (thin pass-through around a pure-compute segmenter tool) and the SentenceSegmentationToolProtocol. The SentenceSegmentationResult data noun lives in cjm-capability-primitives."
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
requires-python = ">=3.12"
|
|
11
|
+
license = {text = "Apache-2.0"}
|
|
12
|
+
authors = [{name = "Christian J. Mills", email = "9126128+cj-mills@users.noreply.github.com"}]
|
|
13
|
+
classifiers = [
|
|
14
|
+
"Programming Language :: Python :: 3",
|
|
15
|
+
"Programming Language :: Python :: 3 :: Only",
|
|
16
|
+
]
|
|
17
|
+
dependencies = [
|
|
18
|
+
"cjm-substrate>=0.0.58",
|
|
19
|
+
"cjm-capability-primitives>=0.0.11",
|
|
20
|
+
]
|
|
21
|
+
|
|
22
|
+
[project.urls]
|
|
23
|
+
Repository = "https://github.com/cj-mills/cjm-sentence-segmentation-adapter-interface"
|
|
24
|
+
|
|
25
|
+
[tool.setuptools.dynamic]
|
|
26
|
+
version = {attr = "cjm_sentence_segmentation_adapter_interface.__version__"}
|
|
27
|
+
|
|
28
|
+
[tool.setuptools.packages.find]
|
|
29
|
+
include = ["cjm_sentence_segmentation_adapter_interface*"]
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
"""Tests for the sentence-segmentation adapter interface — protocol conformance + the generic pass-through."""
|
|
2
|
+
from typing import Any, Dict
|
|
3
|
+
|
|
4
|
+
from cjm_capability_primitives.sentence_segmentation import (SentenceSegmentationResult,
|
|
5
|
+
SentenceSpan)
|
|
6
|
+
from cjm_sentence_segmentation_adapter_interface.adapter import (
|
|
7
|
+
SentenceSegmentationAdapter, SentenceSegmentationToolProtocol)
|
|
8
|
+
from cjm_sentence_segmentation_adapter_interface.generic import (
|
|
9
|
+
GenericSentenceSegmentationAdapter)
|
|
10
|
+
|
|
11
|
+
|
|
12
|
+
class FakeSegmenterTool:
|
|
13
|
+
"""Minimal tool satisfying the structural protocol: splits on '. '."""
|
|
14
|
+
|
|
15
|
+
def __init__(self):
|
|
16
|
+
self.calls = 0
|
|
17
|
+
|
|
18
|
+
def segment_text(self, text: str, **kwargs) -> SentenceSegmentationResult:
|
|
19
|
+
self.calls += 1
|
|
20
|
+
spans, start = [], 0
|
|
21
|
+
while start < len(text):
|
|
22
|
+
end = text.find(". ", start)
|
|
23
|
+
end = len(text) if end < 0 else end + 1
|
|
24
|
+
spans.append(SentenceSpan(start_char=start, end_char=end))
|
|
25
|
+
start = end + 1
|
|
26
|
+
return SentenceSegmentationResult(spans=spans,
|
|
27
|
+
metadata={"sentence_count": len(spans)})
|
|
28
|
+
|
|
29
|
+
def get_current_config(self) -> Dict[str, Any]:
|
|
30
|
+
return {"language": "en"}
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
def test_fake_tool_satisfies_protocol():
|
|
34
|
+
assert isinstance(FakeSegmenterTool(), SentenceSegmentationToolProtocol)
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
def test_adapter_declares_task_contract():
|
|
38
|
+
assert SentenceSegmentationAdapter.task_name == "sentence_segmentation"
|
|
39
|
+
assert (SentenceSegmentationAdapter.required_tool_protocol
|
|
40
|
+
is SentenceSegmentationToolProtocol)
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
def test_generic_adapter_passes_through():
|
|
44
|
+
tool = FakeSegmenterTool()
|
|
45
|
+
adapter = GenericSentenceSegmentationAdapter(tool)
|
|
46
|
+
text = "First sentence. Second one?"
|
|
47
|
+
result = adapter.segment_text(text)
|
|
48
|
+
assert tool.calls == 1
|
|
49
|
+
assert [text[s.start_char:s.end_char] for s in result.spans] == [
|
|
50
|
+
"First sentence.", "Second one?"]
|