shisa-de 0.1.0__tar.gz

shisa_de-0.1.0/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 2026 Shisa AI
+
+   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.

shisa_de-0.1.0/MANIFEST.in

@@ -0,0 +1 @@
+include docs/READOUT.md

shisa_de-0.1.0/PKG-INFO

@@ -0,0 +1,285 @@
+Metadata-Version: 2.4
+Name: shisa-de
+Version: 0.1.0
+Summary: Talk to Shisa DE-1 decision models: typed questions in, typed answers out
+Author: Shisa AI
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/shisa-ai/shisa-de
+Project-URL: Repository, https://github.com/shisa-ai/shisa-de
+Project-URL: Issues, https://github.com/shisa-ai/shisa-de/issues
+Project-URL: Platform, https://platform.shisa.ai/
+Project-URL: Model, https://huggingface.co/shisa-ai/shisa-de-1
+Keywords: decision-model,classification,system-one,jev,de-1
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx>=0.27
+Requires-Dist: transformers>=5.0
+Requires-Dist: jinja2>=3.1
+Provides-Extra: dev
+Requires-Dist: pytest>=8; extra == "dev"
+Dynamic: license-file
+
+# shisa-de
+
+A Python client for [Shisa DE-1](https://huggingface.co/shisa-ai/shisa-de-1), a
+model for classification and typed decisions. Use it through the hosted
+[Shisa Platform](https://platform.shisa.ai/) or a local OpenAI-compatible server
+serving DE-1.
+
+Give it text, images, or structured data and a set of labels or questions. It returns
+answers, probabilities, and request usage—not generated prose. The client loads
+only the tokenizer; model weights stay on the server.
+
+## Benchmark snapshot
+
+| Benchmark | Shisa DE-1 | Jev |
+| --- | ---: | ---: |
+| [JevBench standard accuracy](https://github.com/fstandhartinger/jevbench) | 98.6% | 98.6% |
+| [JevBench hard accuracy](https://github.com/fstandhartinger/jevbench) | 64.9% | 73.0% |
+| [AG News accuracy](https://huggingface.co/datasets/fancyzhx/ag_news) | 89.5% | 90.0% |
+| [Median latency](https://huggingface.co/shisa-ai/shisa-de-1#evaluation) | 20 ms (local) | 223 ms (hosted) |
+
+## Install
+
+Requires Python 3.10 or newer and Git. Install directly from GitHub:
+
+```bash
+python -m pip install "git+https://github.com/shisa-ai/shisa-de.git"
+```
+
+The package is not published to PyPI. For development, see [Development](#development).
+
+## Use the Shisa Platform
+
+Get an API key from [platform.shisa.ai](https://platform.shisa.ai/) and set it in
+your environment:
+
+```bash
+export SHISA_API_KEY="your-api-key"
+```
+
+No endpoint or model argument is needed:
+
+```python
+from shisa_de import DecisionModel
+
+with DecisionModel() as de:
+    result = de.classify(
+        "WINNER! Claim your free prize now!",
+        {"intent": ["spam", "ham"]},
+    )
+    print(result["intent"])  # spam
+```
+
+The defaults are model `shisa-ai/shisa-de-1` at
+`https://api.shisa.ai/openai`. The tokenizer is loaded lazily from Hugging Face
+when first needed, so the first call may require a download. Nothing is fetched
+at import time. PyTorch and a local GPU are not required for the client.
+
+Check your setup from the command line:
+
+```bash
+shisa-de doctor
+shisa-de ask --state 'WINNER! Claim your free prize now!' --labels spam,ham
+```
+
+`doctor` checks model-list access, the model ID, and the tokenizer's answer
+boundary. `ask` makes an actual decision request.
+
+## Use a local server
+
+First start an OpenAI-compatible server with DE-1 loaded. See the
+[DE-1 model card](https://huggingface.co/shisa-ai/shisa-de-1) for serving guidance.
+Then point this client at it:
+
+```python
+from shisa_de import DecisionModel
+
+with DecisionModel.from_endpoint(
+    "http://127.0.0.1:8021/v1",
+    model="shisa-ai/shisa-de-1",
+    api_key="",  # no authentication; do not use a key from the environment
+) as de:
+    result = de.classify(
+        "I was charged twice. Please refund the duplicate payment.",
+        {"intent": ["refund_request", "order_status", "cancel_order"]},
+    )
+    print(result["intent"])
+```
+
+Both a server root URL and a URL ending in `/v1` are accepted. For an
+authenticated local server, pass its key as `api_key="your-local-key"`.
+If the server uses an alias for the model, pass that alias as `model=` and
+`tokenizer="shisa-ai/shisa-de-1"` to keep using the checkpoint's tokenizer.
+
+For text, the server needs `/v1/completions` with `logprobs` and
+`prompt_logprobs`; `doctor` also needs `/v1/models`. vLLM supports these.
+See the [readout contract](docs/READOUT.md) for the exact requests.
+
+For the CLI, use `--base-url` or set `SHISA_DE_ENDPOINT`. In a shell without
+hosted credentials:
+
+```bash
+export SHISA_DE_ENDPOINT=http://127.0.0.1:8021/v1
+shisa-de doctor
+shisa-de ask --state 'Please refund my duplicate payment.' --labels refund_request,order_status
+```
+
+### Configuration precedence
+
+| Setting | Resolution order |
+| --- | --- |
+| Endpoint | `base_url=` / CLI `--base-url`, then `SHISA_DE_ENDPOINT`, then the hosted default |
+| API key | `api_key=`, then `SHISA_DE_API_KEY`, then `SHISA_API_KEY` |
+| Model | `model=` / CLI `--model`, otherwise `shisa-ai/shisa-de-1` |
+| Tokenizer | `tokenizer=` / CLI `--tokenizer`, otherwise the model ID |
+
+An explicit `api_key=""` disables authentication. Otherwise, environment keys
+are used for local endpoints too. Leave `SHISA_DE_ENDPOINT` and
+`SHISA_DE_API_KEY` unset to use the hosted defaults with only `SHISA_API_KEY`.
+
+## Classify with labels
+
+Each named label set is a separate question. Labels can be plain strings or a
+mapping from labels to descriptions:
+
+```python
+from shisa_de import DecisionModel
+
+with DecisionModel() as de:
+    result = de.classify(
+        {"subject": "Charged twice", "body": "Please refund the duplicate charge."},
+        {"intent": {
+            "refund_request": "The customer wants money returned",
+            "order_status": "The customer wants a delivery update",
+        }},
+        include_probabilities=True,
+    )
+    print(result["intent"]["label"])
+    print(result["intent"]["probabilities"])
+    print(result.usage)
+```
+
+Use `include_confidence=True` for a label and confidence without the full
+probability map. The default result maps each head name directly to its label.
+
+Other label-set forms:
+
+| Form | Behavior |
+| --- | --- |
+| `["a", "b"]` | Choose one label; derive the question from the head name |
+| `{"a": "description", "b": "description"}` | Choose one label using its description |
+| `{"labels": ["a", "b"], "prompt": "Which applies?"}` | Supply your own question |
+| `{"labels": ["a", "b"], "multi_label": True, "cls_threshold": 0.5}` | Ask yes/no for each label; return labels above the threshold |
+| `{"levels": ["low", "medium", "high"]}` | Choose a level on an ordered scale |
+
+## Classify images
+
+Pass a local image path, an HTTP(S) image URL, or a base64 image data URL as
+`image=`. The same API works with the Shisa Platform and a local DE-1 server
+with vision enabled:
+
+```python
+from shisa_de import DecisionModel
+
+with DecisionModel() as de:
+    result = de.classify(
+        {},
+        {"animal": ["cat", "dog", "bird"]},
+        image="photo.jpg",
+        include_probabilities=True,
+    )
+    print(result["animal"]["label"])
+    print(result["animal"]["probabilities"])
+```
+
+`decide(..., image="photo.jpg")` supports typed questions about an image too.
+
+Local files are uploaded; URLs are fetched by the server. Supported formats:
+PNG, JPEG, and WebP. Image probabilities are uncalibrated by default.
+
+The server must support images and token logprobs on `/v1/chat/completions`.
+If an option is missing from the returned logprobs, the client raises an error.
+For larger label sets on a local server, raise its `--max-logprobs` and set
+`DecisionModel(image_top_logprobs=128)` to match.
+
+```bash
+shisa-de ask --image photo.jpg --labels cat,dog,bird --prompt 'What animal is shown?'
+```
+
+## Ask typed questions
+
+`decide` supports yes/no probabilities (`Noul`), named choices (`Choice`), and
+ordered scores (`Score`):
+
+```python
+from shisa_de import Choice, DecisionModel, Noul, Score
+
+with DecisionModel() as de:
+    result = de.decide(
+        "Reply with your full card number and CVV to claim your prize.",
+        {
+            "is_spam": Noul("Is this message spam?"),
+            "asks_for": Choice("What does the sender want?", {
+                "card_details": "Payment card details",
+                "callback": "A support callback",
+                "nothing": "Nothing; it is routine",
+            }),
+            "risk": Score("How risky is acting on this message?", [
+                "Safe", "Suspicious", "Dangerous",
+            ]),
+        },
+    )
+    print(dict(result))
+    print(result.answers["asks_for"].probabilities)
+    print(result.answers["risk"].level)
+    print(result.usage)
+```
+
+- `Noul` returns the probability of yes.
+- `Choice` returns the selected option key.
+- `Score` returns the probability-weighted, zero-based position in the scale.
+  The most likely level is available as `result.answers[name].level`.
+
+Each question has at most 26 options. Each question costs one request; text
+questions add a fallback request for each option missing from the top logprobs.
+Multi-label classification asks one question per label. Questions run
+concurrently; `max_workers=` controls concurrency. `result.usage` records the
+request and token counts.
+
+## Probabilities and calibration
+
+Text calls apply the bundled temperature scaling by default; image calls return
+raw probabilities. Pass `calibrated=False` for raw text probabilities too.
+Each answer records `calibrated` and `temperature`; `result.meta` records the
+readout version and calibration identity. See the [readout documentation](docs/READOUT.md)
+for the scoring and calibration details.
+
+## Development
+
+```bash
+git clone https://github.com/shisa-ai/shisa-de.git
+cd shisa-de
+python -m pip install -e '.[dev]'
+python -m pytest tests/
+```
+
+Offline tests use a stub tokenizer and mock HTTP transport. Live tests spend
+real API requests and are opt-in:
+
+```bash
+SHISA_DE_LIVE=1 python -m pytest tests/test_live.py -v
+```
+
+Live tests use the same endpoint and API-key environment variables as the
+client. `shisa-de explain --labels spam,ham` prints the prompt, token slots,
+logprobs, and final distribution for a live request.
+
+## License
+
+This client library is licensed under [Apache 2.0](LICENSE).
+See the [model card](https://huggingface.co/shisa-ai/shisa-de-1) for the model's
+license and usage requirements.