theclassifier 0.1.0__tar.gz

theclassifier-0.1.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.

theclassifier-0.1.0/MANIFEST.in

@@ -0,0 +1,3 @@
+include RELEASE.md
+recursive-include examples *.jsonl
+recursive-include tests *.py

theclassifier-0.1.0/PKG-INFO

@@ -0,0 +1,215 @@
+Metadata-Version: 2.4
+Name: theclassifier
+Version: 0.1.0
+Summary: Natural language classification on CPU and GPU, with domain adapters and LoRA fine-tuning
+Author: TrueState
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://theclassifier.ai
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: torch<3,>=2.6
+Requires-Dist: transformers<6,>=4.56
+Requires-Dist: peft<1,>=0.17
+Requires-Dist: accelerate<2,>=1
+Requires-Dist: huggingface-hub<2,>=0.34
+Requires-Dist: safetensors>=0.5
+Provides-Extra: serve
+Requires-Dist: fastapi<1,>=0.115; extra == "serve"
+Requires-Dist: uvicorn<1,>=0.30; extra == "serve"
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: httpx; extra == "dev"
+Requires-Dist: build; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Dynamic: license-file
+
+# The Classifier
+
+A general-purpose natural language classifier with domain-specific LoRA adapters.
+Run locally on CPU or NVIDIA GPU, serve the same `/v1/classify` request format as
+the hosted service, or fine-tune an adapter on your own labelled examples.
+
+## Release status
+
+This is the initial 0.1.0 package. The configured model repository is
+`TrueState/theclassifier`. The checkpoints are staged privately; authenticate with
+Hugging Face and obtain repository access before using named-version downloads.
+A local checkpoint also works.
+Model weights are not included in the Python package. This code is Apache-2.0;
+checkpoint and dataset licences are separate.
+
+## Install
+
+From this checkout, until the PyPI release is published:
+
+```sh
+pip install './python[serve]'
+```
+
+After release:
+
+```sh
+pip install 'theclassifier[serve]'
+```
+
+Python 3.10+ is required. Install a PyTorch build suitable for your platform first
+if needed; CUDA support depends on that build and your NVIDIA driver. CPU uses
+float32; CUDA uses bfloat16 when supported, otherwise float32. No FlashAttention
+extension is required. `auto` selects CUDA when available and CPU otherwise.
+Apple MPS is not currently supported.
+
+## Classify locally
+
+```python
+from theclassifier import Classifier
+
+classifier = Classifier()  # general; downloads once, then uses the local cache
+result = classifier.classify(
+    'Please close my account.',
+    choices=['billing', 'cancellation', 'none'],
+    question='What is the customer asking for?',
+)
+print(result['results'][0]['selected'])
+```
+
+Use `Classifier(checkpoint='./checkpoints/general', device='cpu')` to load an
+existing local checkpoint. A checkpoint contains `adapter/`, `tokenizer/` and
+`head.safetensors` (or the existing `head.pt` format). The pretrained backbone is
+resolved from the adapter configuration. A local adapter can still require a
+backbone download if the backbone is not already cached.
+
+The full question format supports multiple decisions and optional criteria:
+
+```python
+result = classifier.classify(
+    'Please close my account.',
+    questions=[{
+        'question': 'What is the customer asking for?',
+        'choices': [
+            {'choice': 'cancellation', 'criteria': 'Requests to close an account.'},
+            {'choice': 'none', 'criteria': 'None of the other choices apply.'},
+        ],
+    }],
+    version='intent',
+)
+```
+
+Versions: `general`, `intent`, `sentiment`, `triage`, `cause`, `codify`,
+`complaints`, `stars`. Selecting a new version checks the Hugging Face cache,
+downloads missing files, then loads the adapter and its scoring head onto the
+shared backbone. Selection and inference are serialized to keep the adapter and
+head paired. A failed download raises an error; it never silently falls back to
+another model.
+
+```python
+classifier.load_adapter('custom', checkpoint='./checkpoints/my-adapter')
+result = classifier.classify('example', choices=['yes', 'no'], version='custom')
+```
+
+Use `model_repo=`, `revision=` and `cache_dir=` or the
+`THECLASSIFIER_MODEL_REPO` environment variable to override download settings.
+Pin `revision` to a commit for reproducibility. `offline=True` disables network
+loading, including the base model. Pre-download adapters with:
+
+```sh
+theclassifier download --version general
+theclassifier download --version intent
+```
+
+These commands download adapters and tokenizers; initialize the classifier once
+online to cache the backbone as well. The repository layout is
+`<version>/adapter/`, `<version>/tokenizer/`, `<version>/head.safetensors`.
+
+Default maximum input length is 2,048 tokens per candidate; longer inputs retain
+the first token and tail, matching the existing prompt format. Set `max_length`
+explicitly for longer records. `batch_size` controls inference candidate chunks.
+This initial portable runtime uses direct candidate scoring, not shared-prefix
+KV caching. It has not been benchmarked against the optimized production server.
+
+## Serve on CPU or GPU
+
+```sh
+theclassifier serve --checkpoint ./checkpoints/general --device cpu
+# On a CUDA machine:
+API_KEY=your-serving-key theclassifier serve --device cuda --host 0.0.0.0
+```
+
+Default binding is `127.0.0.1:8090`. Binding outside localhost requires `API_KEY`.
+Use one process per GPU; run behind a TLS proxy for remote clients. This standalone
+server provides inference and authentication, not the hosted service's billing,
+quotas or rate limiting. Set resource limits in your deployment.
+
+```sh
+curl http://127.0.0.1:8090/v1/classify \
+  -H 'Content-Type: application/json' \
+  -d '{"state":"Close my account","questions":[{"question":"Intent?","choices":[{"choice":"cancel"},{"choice":"none"}]}]}'
+```
+
+Include `Authorization: Bearer YOUR_KEY` when `API_KEY` is configured.
+Responses contain `results` (with `question`, `selected`, `detailed_results`),
+`version`, `input_tokens` and `latency_ms`.
+
+## Fine-tune with LoRA
+
+Each JSONL line is one complete choice menu, with an exact matching answer label:
+
+```json
+{"state":"Close my account","question":"Intent?","choices":[{"choice":"cancel","criteria":"Requests to close an account"},{"choice":"none"}],"answer":"cancel"}
+```
+
+```sh
+# Continue the general checkpoint to create a specialist:
+theclassifier finetune --version general --data train.jsonl \
+  --output checkpoints/my-adapter --device cuda
+
+# Train an adapter and scoring head from the base model:
+theclassifier finetune --base-model Qwen/Qwen3-1.7B-Base \
+  --data train.jsonl --output checkpoints/from-base --rank 16 --alpha 16
+```
+
+Or in Python:
+
+```python
+from theclassifier import finetune
+
+report = finetune(
+    'train.jsonl', 'checkpoints/my-adapter',
+    checkpoint='checkpoints/general', device='auto', epochs=1,
+    learning_rate=2e-4, grad_accum=16,
+)
+```
+
+Training freezes the backbone, learns LoRA updates to `q_proj` and `v_proj`, and
+trains a float32 scalar head using cross-entropy across each menu. Whole menus
+are processed together, gradients accumulate between menus, and gradient
+checkpointing reduces activation memory. Large choice menus may still require
+smaller input lengths or more memory. CPU training is supported but slow.
+
+New adapters default to rank 16, alpha 16 and dropout 0.05. Continuing an existing
+adapter preserves its LoRA configuration. A new AdamW optimizer is created with
+a constant learning rate; this is fine-tuning, not exact training-state resume.
+The optimizer configuration differs from the original research runs. Output
+folders must be empty. Saved files include the adapter, head, tokenizer,
+`classifier.json` and `training.json`. Keep evaluation data separate and evaluate
+before using a new checkpoint; the training loss is not a quality benchmark.
+
+## Development and release
+
+```sh
+cd python
+pip install -e '.[serve,dev]'
+pytest
+python -m build
+python -m twine check dist/*
+# With PyPI credentials configured locally:
+python -m twine upload dist/*
+```
+
+The tests build a tiny random Qwen model locally: no production weights, private
+data or external inference service is needed. All six tests passed on the NVIDIA
+workstation, including CUDA inference. Real v1.1 checkpoints were also smoke-tested
+on CUDA, and the general model was checked on CPU against the original scoring
+implementation. These checks establish execution compatibility, not accuracy.
+Publishing the package does not upload model weights. See `RELEASE.md` for the
+checkpoint and publication steps.

theclassifier-0.1.0/README.md

@@ -0,0 +1,189 @@
+# The Classifier
+
+A general-purpose natural language classifier with domain-specific LoRA adapters.
+Run locally on CPU or NVIDIA GPU, serve the same `/v1/classify` request format as
+the hosted service, or fine-tune an adapter on your own labelled examples.
+
+## Release status
+
+This is the initial 0.1.0 package. The configured model repository is
+`TrueState/theclassifier`. The checkpoints are staged privately; authenticate with
+Hugging Face and obtain repository access before using named-version downloads.
+A local checkpoint also works.
+Model weights are not included in the Python package. This code is Apache-2.0;
+checkpoint and dataset licences are separate.
+
+## Install
+
+From this checkout, until the PyPI release is published:
+
+```sh
+pip install './python[serve]'
+```
+
+After release:
+
+```sh
+pip install 'theclassifier[serve]'
+```
+
+Python 3.10+ is required. Install a PyTorch build suitable for your platform first
+if needed; CUDA support depends on that build and your NVIDIA driver. CPU uses
+float32; CUDA uses bfloat16 when supported, otherwise float32. No FlashAttention
+extension is required. `auto` selects CUDA when available and CPU otherwise.
+Apple MPS is not currently supported.
+
+## Classify locally
+
+```python
+from theclassifier import Classifier
+
+classifier = Classifier()  # general; downloads once, then uses the local cache
+result = classifier.classify(
+    'Please close my account.',
+    choices=['billing', 'cancellation', 'none'],
+    question='What is the customer asking for?',
+)
+print(result['results'][0]['selected'])
+```
+
+Use `Classifier(checkpoint='./checkpoints/general', device='cpu')` to load an
+existing local checkpoint. A checkpoint contains `adapter/`, `tokenizer/` and
+`head.safetensors` (or the existing `head.pt` format). The pretrained backbone is
+resolved from the adapter configuration. A local adapter can still require a
+backbone download if the backbone is not already cached.
+
+The full question format supports multiple decisions and optional criteria:
+
+```python
+result = classifier.classify(
+    'Please close my account.',
+    questions=[{
+        'question': 'What is the customer asking for?',
+        'choices': [
+            {'choice': 'cancellation', 'criteria': 'Requests to close an account.'},
+            {'choice': 'none', 'criteria': 'None of the other choices apply.'},
+        ],
+    }],
+    version='intent',
+)
+```
+
+Versions: `general`, `intent`, `sentiment`, `triage`, `cause`, `codify`,
+`complaints`, `stars`. Selecting a new version checks the Hugging Face cache,
+downloads missing files, then loads the adapter and its scoring head onto the
+shared backbone. Selection and inference are serialized to keep the adapter and
+head paired. A failed download raises an error; it never silently falls back to
+another model.
+
+```python
+classifier.load_adapter('custom', checkpoint='./checkpoints/my-adapter')
+result = classifier.classify('example', choices=['yes', 'no'], version='custom')
+```
+
+Use `model_repo=`, `revision=` and `cache_dir=` or the
+`THECLASSIFIER_MODEL_REPO` environment variable to override download settings.
+Pin `revision` to a commit for reproducibility. `offline=True` disables network
+loading, including the base model. Pre-download adapters with:
+
+```sh
+theclassifier download --version general
+theclassifier download --version intent
+```
+
+These commands download adapters and tokenizers; initialize the classifier once
+online to cache the backbone as well. The repository layout is
+`<version>/adapter/`, `<version>/tokenizer/`, `<version>/head.safetensors`.
+
+Default maximum input length is 2,048 tokens per candidate; longer inputs retain
+the first token and tail, matching the existing prompt format. Set `max_length`
+explicitly for longer records. `batch_size` controls inference candidate chunks.
+This initial portable runtime uses direct candidate scoring, not shared-prefix
+KV caching. It has not been benchmarked against the optimized production server.
+
+## Serve on CPU or GPU
+
+```sh
+theclassifier serve --checkpoint ./checkpoints/general --device cpu
+# On a CUDA machine:
+API_KEY=your-serving-key theclassifier serve --device cuda --host 0.0.0.0
+```
+
+Default binding is `127.0.0.1:8090`. Binding outside localhost requires `API_KEY`.
+Use one process per GPU; run behind a TLS proxy for remote clients. This standalone
+server provides inference and authentication, not the hosted service's billing,
+quotas or rate limiting. Set resource limits in your deployment.
+
+```sh
+curl http://127.0.0.1:8090/v1/classify \
+  -H 'Content-Type: application/json' \
+  -d '{"state":"Close my account","questions":[{"question":"Intent?","choices":[{"choice":"cancel"},{"choice":"none"}]}]}'
+```
+
+Include `Authorization: Bearer YOUR_KEY` when `API_KEY` is configured.
+Responses contain `results` (with `question`, `selected`, `detailed_results`),
+`version`, `input_tokens` and `latency_ms`.
+
+## Fine-tune with LoRA
+
+Each JSONL line is one complete choice menu, with an exact matching answer label:
+
+```json
+{"state":"Close my account","question":"Intent?","choices":[{"choice":"cancel","criteria":"Requests to close an account"},{"choice":"none"}],"answer":"cancel"}
+```
+
+```sh
+# Continue the general checkpoint to create a specialist:
+theclassifier finetune --version general --data train.jsonl \
+  --output checkpoints/my-adapter --device cuda
+
+# Train an adapter and scoring head from the base model:
+theclassifier finetune --base-model Qwen/Qwen3-1.7B-Base \
+  --data train.jsonl --output checkpoints/from-base --rank 16 --alpha 16
+```
+
+Or in Python:
+
+```python
+from theclassifier import finetune
+
+report = finetune(
+    'train.jsonl', 'checkpoints/my-adapter',
+    checkpoint='checkpoints/general', device='auto', epochs=1,
+    learning_rate=2e-4, grad_accum=16,
+)
+```
+
+Training freezes the backbone, learns LoRA updates to `q_proj` and `v_proj`, and
+trains a float32 scalar head using cross-entropy across each menu. Whole menus
+are processed together, gradients accumulate between menus, and gradient
+checkpointing reduces activation memory. Large choice menus may still require
+smaller input lengths or more memory. CPU training is supported but slow.
+
+New adapters default to rank 16, alpha 16 and dropout 0.05. Continuing an existing
+adapter preserves its LoRA configuration. A new AdamW optimizer is created with
+a constant learning rate; this is fine-tuning, not exact training-state resume.
+The optimizer configuration differs from the original research runs. Output
+folders must be empty. Saved files include the adapter, head, tokenizer,
+`classifier.json` and `training.json`. Keep evaluation data separate and evaluate
+before using a new checkpoint; the training loss is not a quality benchmark.
+
+## Development and release
+
+```sh
+cd python
+pip install -e '.[serve,dev]'
+pytest
+python -m build
+python -m twine check dist/*
+# With PyPI credentials configured locally:
+python -m twine upload dist/*
+```
+
+The tests build a tiny random Qwen model locally: no production weights, private
+data or external inference service is needed. All six tests passed on the NVIDIA
+workstation, including CUDA inference. Real v1.1 checkpoints were also smoke-tested
+on CUDA, and the general model was checked on CPU against the original scoring
+implementation. These checks establish execution compatibility, not accuracy.
+Publishing the package does not upload model weights. See `RELEASE.md` for the
+checkpoint and publication steps.

theclassifier-0.1.0/RELEASE.md

@@ -0,0 +1,69 @@
+# Release checklist
+
+## Package
+
+The initial package is `theclassifier==0.1.0`, under Apache-2.0. Build and inspect
+only this directory, not the parent application repository:
+
+```sh
+python -m pytest
+python -m build
+python -m twine check dist/*
+```
+
+Inspect the wheel and sdist file lists. They should contain package source,
+documentation, licence and tests, with no credentials, training data or model
+weights. Confirm ownership of the PyPI name at upload time: an earlier 404 is not
+a reservation. Authenticate locally with a PyPI API token or configure a trusted
+publisher; do not put credentials in source files or chat.
+
+```sh
+python -m twine upload dist/*
+```
+
+No PyPI upload has been performed by the build process. Hugging Face authentication
+has been verified, and the release checkpoints are staged privately in
+TrueState/theclassifier pending public weight-licence confirmation.
+
+## Checkpoints
+
+The default repository is `TrueState/theclassifier` with one directory per version:
+
+```
+general/adapter/adapter_config.json
+general/adapter/adapter_model.safetensors
+general/tokenizer/...
+general/head.safetensors
+intent/adapter/...
+intent/tokenizer/...
+intent/head.safetensors
+# likewise sentiment, triage, cause, codify, complaints, stars
+```
+
+Existing `head.pt` checkpoints work; prefer safetensors for new public releases.
+Only upload the intended release adapters, heads and tokenizers. Do not upload
+logs, datasets, local cache folders or credentials. Verify that every adapter's
+`base_model_name_or_path` points to `Qwen/Qwen3-1.7B-Base` (or the actual public
+backbone used), not a private workstation path. Include model cards describing
+training, evaluation and limitations. The user selected Apache-2.0 for package
+code; verify and choose weight licensing separately before publishing weights.
+
+After authentication via `hf auth login`, create the model repository and upload
+an explicitly staged release folder using `hf upload`. Add the model card, then
+verify all versions from a fresh cache and rerun the CUDA tests. Pin a tested Hub
+commit with `revision=` for reproducible deployments. The package's default
+`main` uses the existing local cached revision when available, without checking
+for upstream changes on each classification.
+
+## Validation status
+
+The automated tests use a tiny local random Qwen3 model to exercise real CPU
+inference, LoRA training, checkpoint reload and HTTP serving. They are functional
+tests, not evidence of production classification quality or latency. All six tests passed on the CUDA workstation. The actual general model also
+passed CPU parity against the original scorer, all seven specialists loaded
+and ran on CUDA, and one real-checkpoint LoRA update saved and reloaded on CUDA.
+All eight versions were downloaded from the private Hugging Face repository into
+a fresh cache, matched against the staged files using SHA-256, and resolved
+successfully offline. Verified Hub revision:
+`b5c3072a4b83d14d7dbaf6a358a2ece01b173596`.
+These are functional smoke tests, not a new quality or throughput benchmark.