cjm-capability-whisper 0.0.41__tar.gz

cjm_capability_whisper-0.0.41/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_capability_whisper-0.0.41/MANIFEST.in

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

cjm_capability_whisper-0.0.41/PKG-INFO

@@ -0,0 +1,288 @@
+Metadata-Version: 2.4
+Name: cjm-capability-whisper
+Version: 0.0.41
+Summary: An OpenAI Whisper speech-to-text capability for the cjm-substrate runtime that provides local transcription with configurable model selection and parameter control.
+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-capability-whisper
+Project-URL: Documentation, https://cj-mills.github.io/cjm-capability-whisper
+Keywords: nbdev,jupyter,notebook,python
+Classifier: Natural Language :: English
+Classifier: Intended Audience :: Developers
+Classifier: Development Status :: 3 - Alpha
+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: fastcore
+Requires-Dist: pandas
+Requires-Dist: cjm-substrate>=0.0.50
+Requires-Dist: cjm-capability-primitives>=0.0.9
+Requires-Dist: openai-whisper
+Requires-Dist: torch
+Requires-Dist: numpy
+Requires-Dist: soundfile
+Requires-Dist: cjm-substrate-torch-utils>=0.0.11
+Dynamic: license-file
+
+# cjm-capability-whisper
+
+
+<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
+
+## Install
+
+``` bash
+pip install cjm_capability_whisper
+```
+
+## Project Structure
+
+    nbs/
+    └── capability.ipynb # Capability implementation for OpenAI Whisper transcription
+
+Total: 1 notebook across 1 directory
+
+## Module Dependencies
+
+``` mermaid
+graph LR
+    capability[capability<br/>Whisper Capability]
+```
+
+No cross-module dependencies detected.
+
+## CLI Reference
+
+No CLI commands found in this project.
+
+## Module Overview
+
+Detailed documentation for each module in the project:
+
+### Whisper Capability (`capability.ipynb`)
+
+> Capability implementation for OpenAI Whisper transcription
+
+#### Import
+
+``` python
+from cjm_capability_whisper.capability import (
+    WHISPER_AVAILABLE,
+    WhisperCapabilityConfig,
+    WhisperLocalCapability
+)
+```
+
+#### Functions
+
+``` python
+@patch
+def _apply_config(
+    self:WhisperLocalCapability,
+    config: Optional[Any] = None # Configuration dataclass, dict, or None
+) -> None
+    """
+    CR-4: apply config values + derive config-dependent state (device,
+    model_dir). No heavy-resource work. Called by initialize (first-time) and by
+    the substrate's reconfigure delta path. Model release on a model/device/
+    model_dir/compile_model change is handled declaratively via RELOAD_TRIGGER
+    -> _release_model (fired by the substrate BEFORE this re-applies config).
+    """
+```
+
+``` python
+@patch
+def _release_model(self:WhisperLocalCapability) -> None
+    """
+    CR-4: release the loaded model + free CUDA cache. RELOAD_TRIGGER target for
+    model/device/model_dir/compile_model; on_disable / cleanup delegate here.
+    Idempotent via cjm-substrate-torch-utils' release_model (no-op when already None).
+    """
+```
+
+``` python
+@patch
+def _load_model(self:WhisperLocalCapability) -> None:
+    """Load the Whisper model (lazy loading)."""
+    if self.model is None
+    "Load the Whisper model (lazy loading)."
+```
+
+``` python
+@patch
+def _prepare_audio(
+    self:WhisperLocalCapability,
+    audio: Union[str, Path] # Path to a decodable audio file
+) -> str: # The audio file path
+    """
+    Validate the audio input and return it as a path string.
+    
+    The caller (orchestration / proxy) guarantees a model-ready audio file;
+    in-memory preparation is no longer a capability responsibility.
+    """
+```
+
+``` python
+@patch
+def is_available(self:WhisperLocalCapability) -> bool: # True if Whisper and its dependencies are available
+    "Check if Whisper is available."
+```
+
+``` python
+@patch
+def prefetch(self:WhisperLocalCapability) -> None
+    """
+    CR-4 (SG-19): eagerly load the model so the first execute() doesn't pay
+    the download/load cost. Idempotent via _load_model's None-guard.
+    """
+```
+
+``` python
+@patch
+def on_disable(self:WhisperLocalCapability) -> None
+    """
+    CR-2: release the GPU model when the operator disables the capability (the
+    worker stays alive); lazy reload on the next execute after re-enable.
+    """
+```
+
+``` python
+@patch
+def cleanup(self:WhisperLocalCapability) -> None
+    "Release resources on unload."
+```
+
+#### Classes
+
+``` python
+@dataclass
+class WhisperCapabilityConfig:
+    "Configuration for Whisper transcription capability."
+    
+    model: str = field(...)
+    device: str = field(...)
+    language: Optional[str] = field(...)
+    task: str = field(...)
+    temperature: float = field(...)
+    temperature_increment_on_fallback: Optional[float] = field(...)
+    beam_size: int = field(...)
+    best_of: int = field(...)
+    patience: float = field(...)
+    length_penalty: Optional[float] = field(...)
+    suppress_tokens: str = field(...)
+    initial_prompt: Optional[str] = field(...)
+    condition_on_previous_text: bool = field(...)
+    fp16: bool = field(...)
+    compression_ratio_threshold: float = field(...)
+    logprob_threshold: float = field(...)
+    no_speech_threshold: float = field(...)
+    word_timestamps: bool = field(...)
+    prepend_punctuations: str = field(...)
+    append_punctuations: str = field(...)
+    threads: int = field(...)
+    model_dir: Optional[str] = field(...)
+    compile_model: bool = field(...)
+```
+
+``` python
+class WhisperLocalCapability:
+    def __init__(self):
+        """Initialize the Whisper capability with default configuration."""
+        self.logger = logging.getLogger(f"{__name__}.{type(self).__name__}")
+        self.config: WhisperCapabilityConfig = None
+    """
+    OpenAI Whisper transcription capability (stage 8: pure-compute tool capability).
+    
+    Native-surface model (PILLAR 1c): this tool is PURE COMPUTE — `transcribe`
+    loads the model, runs inference, and builds the typed `TranscriptionResult`.
+    The cache-check + persistence bookends + the per-call `force` control live in
+    the generic transcription adapter (cjm-transcription-adapter-interface); the
+    result DTO lives in cjm-capability-primitives; identity is derived from the
+    installed distribution. No `get_plugin_metadata`, no `self.storage`.
+    """
+    
+    def __init__(self):
+            """Initialize the Whisper capability with default configuration."""
+            self.logger = logging.getLogger(f"{__name__}.{type(self).__name__}")
+            self.config: WhisperCapabilityConfig = None
+        "Initialize the Whisper capability with default configuration."
+    
+    def name(self) -> str: # Capability name identifier
+            """Capability identity, derived from the installed distribution (PILLAR 1c).
+    
+            Runtime-derived: in the worker / in-env introspection `__package__`
+            resolves; the manifest records the same value independently (the
+            dual-mode generator reads it from the distribution)."""
+            from importlib.metadata import metadata, packages_distributions
+            dist = (packages_distributions().get(__package__) or [__package__.replace("_", "-")])[0]
+            return metadata(dist)["Name"]
+    
+        @property
+        def version(self) -> str: # Capability version string
+        "Capability identity, derived from the installed distribution (PILLAR 1c).
+
+Runtime-derived: in the worker / in-env introspection `__package__`
+resolves; the manifest records the same value independently (the
+dual-mode generator reads it from the distribution)."
+    
+    def version(self) -> str: # Capability version string
+            """Get the capability version string."""
+            from cjm_capability_whisper import __version__
+            return __version__
+    
+        def get_current_config(self) -> Dict[str, Any]: # Current configuration as dictionary
+        "Get the capability version string."
+    
+    def get_current_config(self) -> Dict[str, Any]: # Current configuration as dictionary
+            """Return current configuration state."""
+            if not self.config
+        "Return current configuration state."
+    
+    def get_config_schema(self) -> Dict[str, Any]: # JSON Schema for configuration
+            """Return JSON Schema for UI generation."""
+            return dataclass_to_jsonschema(WhisperCapabilityConfig)
+    
+        @staticmethod
+        def get_config_dataclass() -> WhisperCapabilityConfig: # Configuration dataclass
+        "Return JSON Schema for UI generation."
+    
+    def get_config_dataclass() -> WhisperCapabilityConfig: # Configuration dataclass
+            """Return dataclass describing the capability's configuration options."""
+            return WhisperCapabilityConfig
+    
+        def initialize(
+            self,
+            config: Optional[Any] = None # Configuration dataclass, dict, or None
+        ) -> None
+        "Return dataclass describing the capability's configuration options."
+    
+    def initialize(
+            self,
+            config: Optional[Any] = None # Configuration dataclass, dict, or None
+        ) -> None
+        "First-time setup. CR-4: the manual model/device diff-and-reload is replaced
+by declarative RELOAD_TRIGGER metadata; the substrate's reconfigure path fires
+_release_model then re-applies config via _apply_config."
+    
+    def transcribe(
+            self,
+            audio: Union[str, Path], # Path to MODEL-READY audio (converted upstream)
+            **kwargs # Provenance (source_start_time/source_end_time) stamped into metadata
+        ) -> TranscriptionResult: # Typed transcription output
+        "Transcribe model-ready audio using Whisper — PURE COMPUTE.
+
+Stage 8 / PILLAR 1c: the cache-check + persistence bookends moved to the
+generic transcription adapter; this method loads the model, runs
+inference, and builds the typed result. Model params come from
+`self.config` (the CR-15 per-call override path is gone — the tool runs
+its effective config, no metadata lie); `source_start_time` /
+`source_end_time` ride the provenance kwarg channel into metadata."
+```
+
+#### Variables
+
+``` python
+WHISPER_AVAILABLE
+```