Metadata-Version: 2.4
Name: ttucs-model-bow
Version: 0.1.1
Summary: Pretrained weights (data only) for ttucs, the Text-to-UCS slate classifier: hashed n-gram bag-of-embeddings model.
Author: Jon Evans
License-Expression: MIT
Project-URL: Homepage, https://github.com/SoundsLikeJonny/ttucs
Project-URL: Model card, https://github.com/SoundsLikeJonny/ttucs/blob/main/MODEL_CARD.md
Keywords: ucs,universal category system,sound effects,metadata,model weights
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Multimedia :: Sound/Audio
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# ttucs-model-bow

These are the pretrained weights for [ttucs](https://github.com/SoundsLikeJonny/ttucs), the Text-to-UCS
slate classifier. The package contains data only: `config.json`, fp16 `weights.safetensors` and a
SHA-256 `manifest.json`. It has no code dependencies and makes no network calls.

You normally don't install it directly: `pip install ttucs` pulls it in. ttucs then finds it offline:

```python
from ttucs import TTUCS

model = TTUCS.from_pretrained()          # resolves the installed ttucs-model-bow weights
print(model.predict("wooden door creak slow, take 3").cat_id)
```

`ttucs info --verify` shows where the weights were loaded from and checks them against the manifest.

## Model

- **Architecture:** hashed word 1–2-gram + char 3–5-gram bag of embeddings (131,072 buckets × 128 dims),
  a residual MLP, then UCS CatID and Category heads. Temperature-calibrated. 738 UCS v8.2.1 CatIDs.
- **Training data:** synthetic descriptions and slates generated from the UCS v8.2.1 list, plus UCS
  label documents. No third-party library data is used, so the weights can be redistributed.
- **Metrics and limitations:** see the
  [model card](https://github.com/SoundsLikeJonny/ttucs/blob/main/MODEL_CARD.md).
- **License:** MIT (weights). The UCS list is a public-domain initiative by Tim Nielsen, Justin Drury,
  Kai Paquin and contributors (<https://universalcategorysystem.com/>).

## Versioning

This package is versioned independently of `ttucs` and bumps only when the weights change. `ttucs`
declares a compatible range (`ttucs-model-bow>=0.1.1,<0.2`). The model's `config.json` records
`min_ttucs_version`, which ttucs checks at load time.

## Changelog

### 0.1.1 - 2026-11-06
- First published weights: synthetic + UCS data only, compact (131,072 × 128), fp16 safetensors, SHA-256 manifest.
