bolo-speech 0.2.0__tar.gz

bolo_speech-0.2.0/.gitignore

@@ -0,0 +1,61 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.eggs/
+build/
+dist/
+.venv/
+venv/
+.venvs/
+.mypy_cache/
+.ruff_cache/
+.pytest_cache/
+.coverage
+htmlcov/
+.tox/
+
+# Node / web console sources (the built bundle in server/src/bolo/_ui/ IS committed)
+node_modules/
+ui/dist/
+ui/.vite/
+ui/coverage/
+ui/playwright-report/
+ui/test-results/
+*.tsbuildinfo
+npm-debug.log*
+
+# Models, caches and data
+/.bolo-cache/
+/.cache/
+/models/
+*.onnx
+*.ort
+*.bin
+*.gguf
+*.safetensors
+*.part
+
+# Editors and OS
+.idea/
+.vscode/
+*.swp
+.DS_Store
+
+# Local configuration and secrets
+bolo.toml
+.env
+.env.*
+
+# Working notes that are not part of the project
+CONTRACT.md
+SERVER_STATUS.md
+
+# internal working notes
+docs/_*
+
+# vendored WebAssembly build of uccharan (needed to build the console)
+!ui/src/vendor/uccharan/dist/
+
+# wheels for local Docker builds (deploy/wheels/README.md)
+deploy/wheels/*.whl

bolo_speech-0.2.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 [yyyy] [name of copyright owner]
+
+   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.

bolo_speech-0.2.0/NOTICE

@@ -0,0 +1,150 @@
+bolo
+Copyright 2026 The bolo Authors
+
+This product is licensed under the Apache License, Version 2.0 (see LICENSE).
+
+bolo's own source code contains no third-party source code, except the copy
+of uccharan in ui/src/vendor/uccharan (see "Web console: speech synthesis in
+the browser" below). It talks to the
+following components, which are installed separately as Python dependencies
+or optional extras and keep their own licences:
+
+  Runtime dependencies
+    FastAPI (MIT), Starlette (BSD-3-Clause), Uvicorn (BSD-3-Clause),
+    python-multipart (Apache-2.0), NumPy (BSD-3-Clause), httpx (BSD-3-Clause),
+    PyYAML (MIT), psutil (BSD-3-Clause),
+    soundfile (BSD-3-Clause; its wheels bundle libsndfile, LGPL-2.1-or-later,
+      with libFLAC, libogg, libvorbis, libopus (BSD-style), mpg123 (LGPL-2.1)
+      and LAME (LGPL-2.0-or-later)),
+    soxr (the Python binding and libsoxr are LGPL-2.1-or-later).
+
+  Optional inference engines
+    sherpa-onnx (Apache-2.0)        https://github.com/k2-fsa/sherpa-onnx
+    ONNX Runtime (MIT), bundled in the sherpa-onnx wheel
+    faster-whisper (MIT)            https://github.com/SYSTRAN/faster-whisper
+    CTranslate2 (MIT)               https://github.com/OpenNMT/CTranslate2
+    useful-moonshine-onnx (MIT), pywhispercpp / whisper.cpp (MIT)
+    kokoro-onnx (MIT; depends on phonemizer, GPL-3.0-or-later; not part of
+      the "all" extra)
+
+  Phonemiser
+    uccharan (Apache-2.0; English data derived from CMUdict, BSD-2-Clause;
+      Kokoro English dictionaries from misaki, Apache-2.0)
+                                    https://github.com/cb-Sigma/uccharan
+      optional "uccharan" extra, part of "all"
+
+  Optional protocol and codec libraries
+    wyoming (MIT)                   https://github.com/OHF-Voice/wyoming
+    PyAV (BSD-3-Clause; its wheels bundle FFmpeg libraries, LGPL-2.1-or-later)
+
+  Speaker diarization uses the pyannote segmentation-3.0 model (MIT) in its
+  ONNX export and a 3D-Speaker ERes2Net speaker-embedding model (Apache-2.0),
+  both run by sherpa-onnx. Model files are downloaded by the user, not
+  distributed with bolo.
+
+  The optional diarization model "nemotron-3-diarization" is NVIDIA
+  Nemotron-3-Diarization (https://huggingface.co/nvidia/Nemotron-3-Diarization),
+  licensed under the OpenMDW License Agreement, version 1.1
+  (https://openmdw.ai/license/1-1/), in the int8 ONNX conversion published
+  by the onnx-community organisation on Hugging Face
+  (https://huggingface.co/onnx-community/Nemotron-3-Diarization-ONNX). It is
+  downloaded by the user on request, run by ONNX Runtime (MIT), and not
+  distributed with bolo. Whoever redistributes the model files (for example
+  inside a container image) must, under OpenMDW-1.1, include a copy of that
+  agreement and keep the copyright and origin notices that come with the
+  model. OpenMDW-1.1 also ends the licence of anyone who sues claiming that
+  the model infringes a patent or copyright. bolo's NumPy implementation of
+  the model's chunked inference (server/src/bolo/engines/nemotron.py: the
+  speaker cache and chunk loop) follows the reference implementation in
+  Hugging Face transformers (models/nemotron3_diarization, Apache-2.0,
+  Copyright 2026 The HuggingFace Inc. team); its log-mel front-end
+  (server/src/bolo/audio/features.py) is bolo's own implementation of NeMo's
+  published preprocessing.
+
+  eSpeak NG (GPL-3.0-or-later, https://github.com/espeak-ng/espeak-ng) is an
+  OPTIONAL component. It is NOT bundled with bolo, not linked into it, not a
+  dependency of the "all" extra and not in the default container images. It
+  is installed only when the operator asks for it (the console, "bolo
+  components install espeak-ng", the "espeak" extra, which pulls the
+  third-party espeakng-loader wheel, or the system package manager) and
+  after accepting its licence. Piper-format voices, KittenTTS, Matcha-TTS
+  (English) and the non-English Kokoro voices need it; the default voice
+  (Kokoro, English) does not. See docs/models.md, "Licences and the
+  espeak-ng question".
+
+API compatibility
+    The routes under "speaches-compatible" mirror the HTTP interface of
+    speaches (https://github.com/speaches-ai/speaches, MIT licence,
+    Copyright (c) 2024 Fedir Zadniprovskyi) so that its clients keep
+    working. The interface was re-implemented from its route definitions;
+    no speaches source code is included.
+
+Models
+    Models are not distributed with bolo. They are downloaded on request
+    from their publishers, under the licences recorded for each entry in
+    the catalog (server/src/bolo/catalog/*.yaml).
+
+Fonts
+    The web console bundles Inter and JetBrains Mono, and Noto Sans
+    (Devanagari, Bengali, Tamil, Telugu, Gujarati, Kannada, Malayalam,
+    Gurmukhi, Oriya) and Noto Naskh Arabic for text in those scripts, all
+    under the SIL Open Font License 1.1, from the @fontsource packages.
+    The word "बोलो" in the logo is outlined from Hind SemiBold
+    (Copyright (c) 2014 Indian Type Foundry, SIL Open Font License 1.1);
+    the font itself is not distributed.
+
+Voices converted by this project
+    The archives published as assets of the "voices-v1" release of this
+    repository are format conversions (PyTorch checkpoint to ONNX, made
+    with tools/voices/export_syspin.py) of the VITS voices published by
+    the SYSPIN project, SPIRE Lab, Indian Institute of Science (IISc),
+    Bengaluru (https://huggingface.co/SYSPIN). The model weights are under
+    the MIT licence; they were trained on the SYSPIN text-to-speech
+    corpus, licensed CC-BY-4.0. Each archive contains LICENSE and
+    ATTRIBUTION files naming the source repository and revision. The
+    archives are not part of the bolo package.
+
+    The same release (and, when published there, Hugging Face repositories
+    under codebucketsolutions/) may also carry format conversions of Meta's
+    MMS-TTS voices (https://huggingface.co/facebook/mms-tts, made with
+    tools/voices/export_mms.py and MMS's VITS inference code, MIT, Copyright
+    (c) 2021 Jaehyeon Kim). Those weights are licensed CC-BY-NC-4.0:
+    NON-COMMERCIAL use only. Each archive contains the licence text and the
+    attribution.
+
+    The optional end-of-turn model is Smart Turn v3 by the Pipecat project
+    (https://huggingface.co/pipecat-ai/smart-turn-v3, BSD-2-Clause),
+    downloaded on request like any other model. bolo's Whisper-style
+    feature computation (server/src/bolo/audio/features.py) is its own
+    implementation of the published algorithm.
+
+Web console: speech synthesis in the browser
+    The console (and the live demo) can run text-to-speech voices in the
+    page with ONNX Runtime Web (MIT, https://github.com/microsoft/onnxruntime),
+    loaded from jsDelivr at run time, not bundled.
+
+    ui/src/vendor/uccharan is a copy of the WebAssembly build of uccharan
+    0.1.0, a text-to-phoneme library (Apache-2.0, Copyright 2026 Abhinav
+    Gautam and the uccharan contributors, https://github.com/cb-Sigma/uccharan),
+    with its LICENSE, NOTICE and DATA_LICENSES.md. Its English data file
+    (en-us.ucd) is derived from the CMU Pronouncing Dictionary, Copyright (C)
+    1993-2015 Carnegie Mellon University, BSD-2-Clause-style licence; the full
+    text is in ui/src/vendor/uccharan/NOTICE. uccharan contains no eSpeak NG
+    code or data; no GPL component is used for speech synthesis in the browser.
+
+    The live demo serves, next to the page (under voices/), copies of these
+    voices with their weights stored at reduced precision (8-bit and 16-bit;
+    not retrained), made by ui/scripts/voices/build.py:
+      - SYSPIN VITS voices (Hindi, Maithili, Bhojpuri, Marathi, Kannada and
+        Indian English) by the SYSPIN project, SPIRE Lab, Indian Institute of
+        Science, Bengaluru: weights MIT, training data the SYSPIN corpus,
+        CC-BY-4.0 (see "Voices converted by this project" above);
+      - the Piper voice en_US "amy" (low) from rhasspy/piper-voices (MIT),
+        trained on the Amy dataset of Mycroft's mimic3-voices.
+    Each voice directory carries its licence and attribution files. The
+    voices are not part of the bolo package or of the git repository.
+
+Built-in audio samples
+    The files in server/src/bolo/samples/*.wav were synthesised with bolo
+    using the models named in server/src/bolo/samples/index.json. The live
+    demo bundles a copy of hi-short.wav.