Metadata-Version: 2.5
Name: psannlm
Version: 1.1.0rc1
Summary: PSANN-LM: language modeling and training utilities for PSANN
Project-URL: Homepage, https://github.com/Nickm1128/psann
Project-URL: Repository, https://github.com/Nickm1128/psann
Project-URL: Issues, https://github.com/Nickm1128/psann/issues
Project-URL: Documentation, https://github.com/Nickm1128/psann/tree/main/docs
Project-URL: Changelog, https://github.com/Nickm1128/psann/blob/main/CHANGELOG.md
Project-URL: Security, https://github.com/Nickm1128/psann/blob/main/SECURITY.md
Author: Nicholas Milinkovich
License: MIT License
        
        Copyright (c) 2025 Nicholas Milinkovich
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
License-File: LICENSE
Keywords: language-modeling,psann,pytorch,sine,transformers
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.11
Requires-Dist: datasets>=2.14
Requires-Dist: packaging<27,>=24
Requires-Dist: psann<1.2,>=1.1.0rc1
Requires-Dist: sentencepiece>=0.1.99
Requires-Dist: tokenizers>=0.13
Description-Content-Type: text/markdown

# psannlm – PSANN Language Modeling

This package hosts the PSANN-LM core library plus the standalone training CLI.

- Importable module: `psannlm` (e.g. `python -m psannlm` or `python -m psannlm.train`).
- Depends on `psann>=1.1.0rc1,<1.2` for shared utilities. Import fails clearly when
  the installed core is outside that supported line.
- Reports the LM wheel's own version through `psannlm.__version__`; it does not alias
  `psann.__version__`.
- Includes the LM APIs previously hosted under `psann.lm` (now a stub in `psann`).
- Intended to be published as its own wheel (`psannlm`) so users can opt into LM tooling separately from the core `psann` estimators.
- `psannlm.train` remains the canonical LM training entrypoint and now delegates
  to the internal `psannlm/_train/` package for tokenizer setup, dataset
  wiring, export helpers, and CLI orchestration.

For end-to-end usage patterns, configuration examples, and evaluation flows, see the top-level documentation in `docs/lm.md` and the scripts under `scripts/` (for example `scripts/train_psann_lm.py` and `scripts/run_lm_eval_psann.py`).
