ovos-media-classifier 0.0.2a1__tar.gz

ovos_media_classifier-0.0.2a1/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 2024 OpenVoiceOS
+
+   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.

ovos_media_classifier-0.0.2a1/PKG-INFO

@@ -0,0 +1,260 @@
+Metadata-Version: 2.4
+Name: ovos-media-classifier
+Version: 0.0.2a1
+Summary: Pluggable media-type classification for OCP (Open Conversation Platform).
+Author-email: JarbasAI <jarbasai@mailfence.com>
+License: Apache-2.0
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: ovos-utils>=0.0.38
+Requires-Dist: mediavocab<2.0.0,>=1.3.0a2
+Requires-Dist: ovos-spec-tools>=0.6.0a1
+Provides-Extra: onnx
+Requires-Dist: onnxruntime; extra == "onnx"
+Requires-Dist: numpy; extra == "onnx"
+Provides-Extra: ner
+Requires-Dist: ahocorasick-ner>=0.0.1; extra == "ner"
+Provides-Extra: media-servers
+Requires-Dist: requests; extra == "media-servers"
+Provides-Extra: online
+Requires-Dist: metadatarr>=0.5.0a1; extra == "online"
+Provides-Extra: huggingface
+Requires-Dist: datasets; extra == "huggingface"
+Provides-Extra: train
+Requires-Dist: scikit-learn; extra == "train"
+Requires-Dist: skl2onnx; extra == "train"
+Requires-Dist: onnx; extra == "train"
+Requires-Dist: onnxruntime; extra == "train"
+Requires-Dist: numpy; extra == "train"
+Requires-Dist: pandas; extra == "train"
+Requires-Dist: torch; extra == "train"
+Requires-Dist: gensim; extra == "train"
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Requires-Dist: pytest-cov; extra == "test"
+Requires-Dist: metadatarr>=0.5.0a1; extra == "test"
+Dynamic: license-file
+
+# ovos-media-classifier
+
+[![License: Apache-2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+[![Python](https://img.shields.io/badge/python-3.10%2B-blue)](https://www.python.org/)
+
+> ⚠️ **Work in progress — pre-release software.** Under active development, not
+> yet deployed in OpenVoiceOS, and APIs may change without notice. Published in
+> the open for transparency; do not depend on it in production yet.
+
+**A self-describing, pluggable media-intent classifier for voice assistants.**
+Given a spoken request — *"play some music"*, *"watch an anime"*, *"read me a
+chapter of Dune"* — it answers, fast and offline, **what kind of media is wanted**
+so the **OVOS Common Play (OCP)** pipeline can route it to the right provider and
+player.
+
+It is a **router, not a resolver.** It gates (*is this a media request at all?*),
+routes by `media_type` / `playback_type` (which `MediaProvider`s to call, which to
+skip), applies content policy (`adult` → drop adult providers), and hands the
+providers a [`mediavocab.Signals`](https://github.com/TigreGotico/mediavocab) as
+**search context**. It does **not** resolve a title to a stream — the providers
+do that — so `Signals.title` carries the raw query by design. The honest measure
+of a router is whether it routes real speech correctly: see the
+[routing eval](docs/routing-eval.md).
+
+It is the single home for OCP's media-command NLP. It is **multi-task** — every
+request is classified along several orthogonal [axes](docs/classification-model.md)
+at once rather than into one label:
+
+- **domain** — is this a media request at all (`ocp_play` / `ocp_control` / `not_ocp`)
+- **media_type** — the concrete `mediavocab.MediaType` leaf (`music`, `movie`, `podcast`, …)
+- **playback_type** — the modality (`audio` / `video` / `paged` / `interactive`)
+- **structure** — the temporal shape (`single` / `episodic` / `continuous` / `collection`)
+- **explicitness** — `clean` / `adult`
+- **tags** — a multi-label, namespaced descriptive axis: `genre:rock` / `mood:chill` / `era:1980s`
+- **qualifiers** — result-narrowing filters: `black_and_white` / `silent` / `live` / `subtitled` / …
+- **content-form genres** — `adult` / `anime` / `animation` / `asmr` (drives the content filter)
+
+The supervision comes from translatable `.intent` templates slot-filled with
+**real entity metadata** (IMDb, MusicBrainz, AniList, LibriVox, …), and the trained
+backend ships as a **rules → learned-context → learned-context+NER ladder** in
+self-describing ONNX bundles — each rung a drop-in upgrade over the last.
+
+## Quickstart
+
+```bash
+pip install ovos-media-classifier
+```
+
+```python
+from ovos_media_classifier import load_media_classifier
+
+clf = load_media_classifier()                  # bundled .voc keyword classifier — zero deps
+clf.classify("play some music", "en-us")       # -> (<MediaType.MUSIC: 'music'>, 0.6)
+```
+
+That is the whole minimum: install, load, classify. The default needs no model
+files and no ML dependencies — it runs fully offline.
+
+The full multi-axis result, and a provider-ready `mediavocab.Signals`:
+
+```python
+clf.classify_full("i want to watch an anime", "en-us").as_dict()
+# {'media_type': 'episodic_series', 'playback_type': 'video', 'structure': 'episodic',
+#  'domain': 'ocp_play', 'genres': ['anime'], 'confidence': 0.6, 'control_intent': None}
+
+clf.classify_tags("play some 80s rock", "en-us")  # -> ['genre:rock', 'era:1980s']  (trained backend)
+
+clf.to_signals("play some music", "en-us")        # -> mediavocab.Signals (hand to a MediaProvider)
+```
+
+(`classify_full().as_dict()` carries the single-label axes plus the content-form
+`genres`; the multi-label `tags` / `qualifiers` axes are read with their own
+`classify_tags()` / `classify_qualifiers()` methods. On the zero-dep keyword
+default `tags` is empty — it is the trained ONNX backend that fills it.)
+
+`classify_full` is **context-aware**: the minimal call is `classify_full(query,
+lang)`, and two optional arguments thread per-query context with no retraining —
+`player_status` (now-playing state, for control / *"play something else"*
+follow-ups) and `ner_list` (the user's live entities, for NER matching and the
+embedding router's runtime injection). See
+[contextual classification](docs/contextual-classification.md).
+
+## Benchmark
+
+The headline result is the **lift across the ladder** — the deterministic keyword
+rules, then a model on context (keyword) features only, then the same model once a
+NER store has surfaced the user's entities. Per-axis, on the held-out
+**test split (34,700 synthetic utterances)**:
+
+| axis (metric) | rules | learned-context | learned-context+NER |
+|---|---|---|---|
+| domain (acc) | 0.833 | 0.866 | **0.986** |
+| media_type (acc) | 0.629 | 0.778 | **0.964** |
+| playback_type (acc) | 0.702 | 0.895 | **0.988** |
+| structure (acc) | 0.708 | 0.907 | **0.990** |
+| explicitness (acc) | 0.988 | 0.989 | **0.997** |
+| content_form_genres (macro-F1) | 0.706 | 0.738 | **0.975** |
+| qualifiers (macro-F1) | 0.000 | 0.746 | **0.906** |
+| tags (macro-F1) | 0.000 | 0.547 | **0.581** |
+
+Content filter (driven by the `content_form_genres` axis), same ladder:
+
+| rung | adult recall | hentai recall | false-block | median ms | p95 ms | bundle |
+|---|---|---|---|---|---|---|
+| rules | 0.481 | 0.510 | 0.000 | 0.32 | 0.50 | — |
+| learned-context | 0.481 | 0.510 | 0.000 | 0.21 | 0.25 | 176 KiB |
+| learned-context+NER | **0.922** | **0.936** | 0.001 | 0.21 | 0.26 | 289 KiB |
+
+Sub-millisecond, in a 289 KiB bundle. **Honesty notes:** these are on the
+*synthetic* eval split — they measure the model's *capability* given populated
+features, not field accuracy on arbitrary speech (the keyword floor is ~0.29 on a
+neutral real-text split). The **keyword backend is the zero-dependency default**;
+the context+NER column requires a wired-in NER store to surface the `ner_*`
+features. And `tags` stays low by design (~0.58) — see [limitations](docs/model.md#6-limitations).
+Full table and method: [docs/model.md](docs/model.md) ·
+[benchmarks/](benchmarks/README.md).
+
+## Axes vs. tags
+
+The single-label heads above are **axes** — exactly one answer per query (a request
+*is* `audio`, *is* `episodic`). The open-vocabulary descriptive signals — **genre,
+mood and era** — are not axes: a query can carry several at once, and they all live
+in slot *value text* (the decade is *in* the year, the mood is *in* the activity
+phrase). So they are folded into one **multi-label, namespaced `tags` head**
+(`genre:` / `mood:` / `era:`) instead of three starved single-label heads.
+`classify_content_genres()` / `classify_mood()` / `classify_era()` read the
+matching slice. This framing is what keeps the axis count honest while still
+modelling the descriptive signal — [classification-model.md](docs/classification-model.md).
+
+## Backends
+
+`load_media_classifier(config)` returns one classifier. They all implement the same
+`AbstractMediaClassifier` contract, so callers never care which ran, and any load
+failure falls back to the keyword default.
+
+| Backend | What it is | Install |
+|---|---|---|
+| **keyword** (`.voc`) | zero-dependency phrase matching — high-precision, abstains when unsure; the offline default | core |
+| **NER** | Aho-Corasick exact match over the user's [entity lists](docs/entity-lists.md) (their real library) | `[ner]` |
+| **embedding-router** (hybrid) | learned [open-vocab router](docs/embedding-router.md): keyword stays the floor, the router fills keyword's abstains using a gazetteer + the user's injected library | `[onnx]` |
+| **ONNX** | the trained multi-task per-axis heads, loaded from a self-describing bundle | `[onnx]` |
+| **external** | any classifier registered under `opm.media.classifier` | a plugin |
+
+```bash
+pip install ovos-media-classifier[ner]     # entity-list matching (the user's library)
+pip install ovos-media-classifier[onnx]    # trained ONNX + embedding-router backends
+```
+
+**The keyword backend is the floor; a learned backend has to earn its place.** The
+zero-dep keyword classifier is deliberately high-precision and *abstains* to
+GENERIC when it has no cue — a safe outcome, because an abstain still lets every
+provider search. The [embedding-router hybrid](docs/embedding-router.md) keeps
+keyword as the first pass and only fills those abstains, resolving open-vocabulary
+titles by injecting the **user's own library** as entities at runtime (no
+retraining). That entity injection is what lowers mis-route *below* the keyword
+floor — see the [routing eval](docs/routing-eval.md).
+
+> **Live routing uses a bounded entity set.** Entity / gazetteer matching cost
+> scales with the number of injected titles, so **live** classification runs on a
+> bounded set — the user's library plus a capped popular [gazetteer](docs/metadatarr-routing.md)
+> (default ~1000 titles/type, p95 a few ms). A **1M-entity set (e.g. full
+> MusicBrainz) is for OFFLINE tagging only, never live classification.** The
+> optional online `metadatarr.resolve` layer (~seconds per title) is for offline
+> tagging or a long-running agent — **off by default**, never in the live OCP
+> pipeline.
+
+See [docs/backends.md](docs/backends.md). To write your own backend or train your
+own bundle (including adding a brand-new axis end-to-end), see
+[docs/extending.md](docs/extending.md).
+
+## Content filtering
+
+A **detect-to-block** moderation layer recognises sensitive requests so OVOS can
+refuse them. It reads the `content_form_genres` axis, so `adult` can be flagged
+**independently of the media-type leaf** (a single leaf mistake never unblocks it).
+`adult` is **blocked by default** (lift it with `allow_adult_content`); the adult /
+hentai data exists for detection only, never for provision.
+
+```python
+from ovos_media_classifier import ContentFilter
+ContentFilter().check(clf, "play some porn", "en-us")   # (True, 'blocked genre: adult')
+```
+
+See [content filtering](docs/content-filtering.md).
+
+## Command vs content classification
+
+This package classifies a **voice command** (*what does the user want?*). That is a
+different problem from `mediavocab.text.classify`, which classifies a piece of
+**catalog content** (*what kind of item is this?*). They share the
+`mediavocab.MediaType` vocabulary but answer opposite questions — do not substitute
+one for the other. See
+[taxonomy.md](docs/taxonomy.md#query-vs-content-classification).
+
+## Documentation
+
+**Start at [docs/index.md](docs/index.md)** for the audience-routing table, or read
+the [glossary](docs/glossary.md) first if the terms are new.
+
+- New here → [glossary](docs/glossary.md) · [index](docs/index.md) · [examples/](examples/)
+- API reference → [stable API](docs/stable-api.md)
+- The model → [classification model](docs/classification-model.md) · [the trained model](docs/model.md) · [taxonomy](docs/taxonomy.md) · [hierarchical experiment](docs/hierarchical.md)
+- The data → [dataset](docs/dataset.md) · [data sources](docs/data-sources.md) · [dataset plots](docs/plots/dataset/)
+- Tuning backends → [backends](docs/backends.md) · [embedding-router](docs/embedding-router.md) · [entity lists](docs/entity-lists.md) · [contextual classification](docs/contextual-classification.md) · [open-vocab routing](docs/metadatarr-routing.md)
+- Moderation → [content filtering](docs/content-filtering.md)
+- Writing / training a classifier → [extending](docs/extending.md) · [external plugins](docs/external-plugins.md)
+- Measuring → [routing eval](docs/routing-eval.md) (the source of truth) · [benchmarks](benchmarks/README.md)
+
+## Credits
+
+Media-metadata datasets by **TigreGotico** on
+[Hugging Face](https://huggingface.co/collections/TigreGotico/media-metadata).
+
+## License
+
+Apache-2.0.
+</content>
+</invoke>