cjm-transcript-graph-schema 0.0.2__tar.gz

cjm_transcript_graph_schema-0.0.2/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2022, fastai
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

cjm_transcript_graph_schema-0.0.2/MANIFEST.in

@@ -0,0 +1,5 @@
+include pyproject.toml
+include LICENSE
+include CONTRIBUTING.md
+include README.md
+recursive-exclude * __pycache__

cjm_transcript_graph_schema-0.0.2/PKG-INFO

@@ -0,0 +1,288 @@
+Metadata-Version: 2.4
+Name: cjm-transcript-graph-schema
+Version: 0.0.2
+Summary: Audio-transcript layer schema for context graphs: Source, AudioSegment, Transcript, and Segment nodes with deterministic identity tuples and graph-node mapping, shared by the transcription, decomposition, and correction workflow cores.
+Author-email: "Christian J. Mills" <9126128+cj-mills@users.noreply.github.com>
+License: Apache-2.0
+Project-URL: Repository, https://github.com/cj-mills/cjm-transcript-graph-schema
+Project-URL: Documentation, https://cj-mills.github.io/cjm-transcript-graph-schema/
+Keywords: nbdev
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: cjm-context-graph-layer>=0.0.2
+Requires-Dist: cjm-context-graph-primitives>=0.0.7
+Dynamic: license-file
+
+# cjm-transcript-graph-schema
+
+
+<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
+
+## Install
+
+``` bash
+pip install cjm_transcript_graph_schema
+```
+
+## Project Structure
+
+    nbs/
+    └── schema.ipynb # The audio-transcript layer schema (where-graph-begins locked layer schema): `Source -> AudioSegment(coarse, owns the model-input WAV) -> Transcript(per-transcriber variants)` emitted by transcription, extended with the fine `Segment` spine by decomposition. Deterministic identity tuples per the stage-5 ratified rule; `Document` from the pre-CR-18 era dissolves into `Source`.
+
+Total: 1 notebook
+
+## Module Dependencies
+
+``` mermaid
+graph LR
+    schema["schema<br/>schema"]
+```
+
+No cross-module dependencies detected.
+
+## CLI Reference
+
+No CLI commands found in this project.
+
+## Module Overview
+
+Detailed documentation for each module in the project:
+
+### schema (`schema.ipynb`)
+
+> The audio-transcript layer schema (where-graph-begins locked layer
+> schema):
+> `Source -> AudioSegment(coarse, owns the model-input WAV) -> Transcript(per-transcriber variants)`
+> emitted by transcription, extended with the fine `Segment` spine by
+> decomposition. Deterministic identity tuples per the stage-5 ratified
+> rule; `Document` from the pre-CR-18 era dissolves into `Source`.
+
+#### Import
+
+``` python
+from cjm_transcript_graph_schema.schema import (
+    TranscriptGraphLabels,
+    source_node_id,
+    audio_segment_node_id,
+    transcript_node_id,
+    segment_node_id,
+    SourceNode,
+    AudioSegmentNode,
+    TranscriptNode,
+    TranscriptSliceRef,
+    SegmentNode
+)
+```
+
+#### Functions
+
+``` python
+def source_node_id(
+    content_hash: str,  # Content hash of the source media file ("algo:hexdigest")
+) -> str:  # Deterministic Source node id
+    "Source identity = the ingested file's content hash (Thread-1 ingested-root identity)."
+```
+
+``` python
+def audio_segment_node_id(
+    source_id: str,  # Owning Source node id
+    start: float,    # Boundary start (source-coordinate seconds)
+    end: float,      # Boundary end (source-coordinate seconds)
+) -> str:  # Deterministic AudioSegment node id
+    """
+    AudioSegment identity = (source, boundary range).
+    
+    Conversion-config-independent: the model-input WAV is payload/provenance,
+    not identity — the boundary computation is pure and deterministic, so
+    re-derivation reproduces the id.
+    """
+```
+
+``` python
+def transcript_node_id(
+    audio_segment_id: str,  # Owning AudioSegment node id
+    transcriber: str,       # Transcriber capability name (e.g. "cjm-transcription-plugin-whisper")
+    config_hash: str,       # Transcriber config hash
+) -> str:  # Deterministic Transcript node id
+    """
+    Transcript identity = (audio segment, transcriber, config) — MIRRORS the
+    capability cache key UNIQUE(audio_path, config_hash), so the graph node is
+    the durable face of the cached row (the structural E13 fix).
+    """
+```
+
+``` python
+def segment_node_id(
+    audio_segment_id: str,  # Owning AudioSegment node id
+    vad_config_hash: str,   # VAD capability config hash (skeleton identity input)
+    chunk_start: float,     # VAD chunk start (chunk-local seconds within the AudioSegment)
+    chunk_end: float,       # VAD chunk end (chunk-local seconds)
+) -> str:  # Deterministic Segment node id
+    """
+    Fine Segment identity = audio-side only (audio segment, VAD config, chunk
+    range) — so the skeleton's ids are SHARED across transcribers by
+    construction (C4 "store agreement once" falls out of identity design).
+    """
+```
+
+#### Classes
+
+``` python
+class TranscriptGraphLabels:
+    "Node labels of the audio-transcript layer schema."
+    
+    def all(cls) -> list:  # All schema labels
+        "All schema labels."
+```
+
+``` python
+@dataclass
+class SourceNode:
+    "The provenance root: one ingested media file."
+    
+    content_hash: str  # Content hash over the file ("algo:hexdigest"; the identity input)
+    path: str  # Original media path (location, may dangle; identity is the hash)
+    title: Optional[str]  # Display title; None = path stem
+    media_type: str = 'audio'  # Media type
+    
+    def id(self) -> str:  # Deterministic node id
+            """Deterministic node id."""
+            return source_node_id(self.content_hash)
+    
+        def to_graph_node(self) -> Dict[str, Any]:  # Node wire dict
+        "Deterministic node id."
+    
+    def to_graph_node(self) -> Dict[str, Any]:  # Node wire dict
+            """Build the Source node wire dict (root_kind=ingested; FileRef provenance)."""
+            return {
+                "id": self.id,
+        "Build the Source node wire dict (root_kind=ingested; FileRef provenance)."
+```
+
+``` python
+@dataclass
+class AudioSegmentNode:
+    """
+    Coarse ~5-min spine member. Owns the model-input WAV (E14: the audio of
+    record) as payload/provenance — the WAV is NOT its own node.
+    
+    Provenance note (deliberate): the SourceRef anchors the owned model-input
+    WAV artifact (hash_file-verifiable). A hash over the sliced ORIGINAL source
+    bytes is not materializable without extracting per-range artifacts (decoded
+    ranges are not byte ranges); the structural chain to the Source rides the
+    PART_OF edge + the start/end properties.
+    """
+    
+    source: str  # Owning Source node id
+    index: int  # Position in the coarse spine (0-based)
+    start: float  # Boundary start (source-coordinate seconds)
+    end: float  # Boundary end (source-coordinate seconds)
+    model_input_path: str  # The 16kHz mono WAV consumed by transcription/VAD/FA
+    model_input_hash: str  # Content hash over that WAV
+    segment_path: Optional[str]  # Source-codec cut file (archival pointer)
+    
+    def id(self) -> str:  # Deterministic node id
+            """Deterministic node id."""
+            return audio_segment_node_id(self.source, self.start, self.end)
+    
+        def to_graph_node(self) -> Dict[str, Any]:  # Node wire dict
+        "Deterministic node id."
+    
+    def to_graph_node(self) -> Dict[str, Any]:  # Node wire dict
+            """Build the AudioSegment node wire dict."""
+            props: Dict[str, Any] = {
+        "Build the AudioSegment node wire dict."
+```
+
+``` python
+@dataclass
+class TranscriptNode:
+    """
+    One transcriber's text for one AudioSegment (per-transcriber variants at
+    the coarse layer — cross-transcriber divergence lives here, C4/C14).
+    """
+    
+    audio_segment: str  # Owning AudioSegment node id
+    transcriber: str  # Transcriber capability name
+    config_hash: str  # Transcriber config hash
+    text: str  # The transcript text (stored ONCE here; fine Segments slice into it)
+    audio_hash: str  # Content hash of the consumed model-input WAV
+    metadata: Dict[str, Any] = field(...)  # Transcriber-reported metadata
+    asserted_at: Optional[float]  # Derivation timestamp; None = now
+    
+    def id(self) -> str:  # Deterministic node id
+            """Deterministic node id."""
+            return transcript_node_id(self.audio_segment, self.transcriber, self.config_hash)
+    
+        def to_graph_node(self) -> Dict[str, Any]:  # Node wire dict
+        "Deterministic node id."
+    
+    def to_graph_node(self) -> Dict[str, Any]:  # Node wire dict
+            """Build the Transcript node wire dict (capability attribution included)."""
+            props: Dict[str, Any] = {
+        "Build the Transcript node wire dict (capability attribution included)."
+    
+    def derived_edge(self) -> Dict[str, Any]:  # Edge wire dict
+        "DERIVED_FROM edge: this Transcript derives from its AudioSegment."
+```
+
+``` python
+@dataclass
+class TranscriptSliceRef:
+    """
+    One per-transcriber char-range reference for a fine Segment: where this
+    segment's text lives inside a Transcript node's text (Thread-1
+    slices-until-promoted — variants are slices, never duplicated fine text).
+    """
+    
+    transcript: str  # Transcript node id
+    start_char: int  # Slice start into the Transcript's text
+    end_char: int  # Slice end
+    text: str  # The sliced text (content-hashed for the ref)
+    
+    def to_source_ref(self) -> Dict[str, Any]:  # SourceRef wire dict
+        "Build the slice-shaped provenance ref."
+```
+
+``` python
+@dataclass
+class SegmentNode:
+    """
+    Fine spine member: one VAD chunk — IMMUTABLE audio range + CORRECTABLE
+    text (the immutable-audio/mutable-text spine seam).
+    
+    Layer-0 `text` is the ACCURACY transcriber's alignment; the designation is
+    per-segment provenance, not global config (`text_from` names the
+    authoritative Transcript; every transcriber's char range rides
+    `text_slices`, the authoritative one included).
+    """
+    
+    audio_segment: str  # Owning AudioSegment node id
+    vad_config_hash: str  # VAD config hash (skeleton identity input)
+    chunk_start: float  # VAD chunk start (chunk-local seconds within the AudioSegment WAV)
+    chunk_end: float  # VAD chunk end (chunk-local seconds)
+    index: int  # Source-wide fine-spine index (0-based)
+    start_time: float  # Source-coordinate start (navigation)
+    end_time: float  # Source-coordinate end
+    text: str = ''  # Layer-0 text (accuracy alignment; "" = no aligned words, D14 class)
+    audio_hash: str = ''  # Content hash of the owning AudioSegment's model-input WAV
+    source: Optional[str]  # Source node id (convenience for direct filters)
+    text_from: Optional[str]  # Authoritative Transcript node id (None when text is empty)
+    text_slices: List[TranscriptSliceRef] = field(...)  # All per-transcriber slice refs
+    
+    def id(self) -> str:  # Deterministic node id
+            """Deterministic node id (audio-side identity; shared across transcribers)."""
+            return segment_node_id(self.audio_segment, self.vad_config_hash,
+                                   self.chunk_start, self.chunk_end)
+    
+        def to_graph_node(self) -> Dict[str, Any]:  # Node wire dict
+        "Deterministic node id (audio-side identity; shared across transcribers)."
+    
+    def to_graph_node(self) -> Dict[str, Any]:  # Node wire dict
+            """Build the Segment node wire dict (audio ref + per-transcriber text slice refs)."""
+            props: Dict[str, Any] = {
+        "Build the Segment node wire dict (audio ref + per-transcriber text slice refs)."
+```