xyran 1.0.0__tar.gz

xyran-1.0.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 [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.

xyran-1.0.0/MANIFEST.in

@@ -0,0 +1,6 @@
+include README.md
+include LICENSE
+include THIRD_PARTY_NOTICES.md
+include PUBLISHING.md
+recursive-include src/xyran/models *.onnx *.json
+recursive-include src/xyran/third_party *.txt

xyran-1.0.0/PKG-INFO

@@ -0,0 +1,255 @@
+Metadata-Version: 2.4
+Name: xyran
+Version: 1.0.0
+Summary: Fast, local-first content safety SDK with bundled Owen-S ONNX inference.
+Author: Xyran Contributors
+License-Expression: Apache-2.0
+Keywords: moderation,nsfw,content-safety,onnx,offline,image-classification
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: THIRD_PARTY_NOTICES.md
+License-File: src/xyran/third_party/OWEN_MODEL_MIT_LICENSE.txt
+Requires-Dist: numpy<3,>=1.26
+Requires-Dist: Pillow<13,>=10.4
+Requires-Dist: pyvips[binary]<4,>=3.2
+Requires-Dist: onnxruntime-gpu[cuda,cudnn]<2,>=1.29; (sys_platform == "win32" and platform_machine == "AMD64") or (sys_platform == "linux" and platform_machine == "x86_64")
+Requires-Dist: onnxruntime<2,>=1.29; sys_platform == "darwin" or (sys_platform == "win32" and platform_machine != "AMD64") or (sys_platform == "linux" and platform_machine != "x86_64")
+Dynamic: license-file
+
+# Xyran V1
+
+**Fast, local-first content safety for Python.**
+
+Xyran is an offline image moderation SDK with bundled Owen-S ONNX inference.
+After installation, inference requires no API key, cloud moderation service,
+telemetry, Hugging Face login, or model download.
+
+V1 uses the MIT-licensed `OwenElliott/image-safety-classifier-s` ONNX model and
+ships the pinned ONNX file inside the Python wheel.
+
+## Install
+
+```bash
+pip install xyran
+```
+
+On Windows x64 and Linux x86_64, the package intentionally installs
+`onnxruntime-gpu[cuda,cudnn]` so NVIDIA CUDA can work out of the box while the
+same runtime can fall back to CPU. On macOS and non-x64 Windows/Linux targets,
+the CPU ONNX Runtime package is selected.
+
+> ONNX Runtime's CPU and GPU Python distributions share the same import
+> namespace. Use a clean virtual environment for the most predictable install.
+
+## 30-second usage
+
+```python
+from xyran import Moderator
+
+mod = Moderator()  # model/session resident by default
+result = mod.scan("image.jpg")
+
+print(result.decision)      # ALLOW / REVIEW / BLOCK
+print(result.scores.sexual)
+print(result.scores.graphic)
+print(result.scores.safe)
+print(result.provider)
+```
+
+Reuse one `Moderator` instance for repeated scans:
+
+```python
+from xyran import Moderator
+
+mod = Moderator()
+
+for path in ["1.jpg", "2.jpg", "3.jpg"]:
+    result = mod.scan(path)
+    print(path, result.decision, result.scores)
+
+mod.close()
+```
+
+## V1 defaults
+
+```text
+preprocess     BlurPad + Lanczos3
+input          224 x 224 (generated internally)
+tiling         disabled
+resident       true
+device         auto
+runtime        ONNX Runtime
+network        not required after pip install
+telemetry      disabled
+cloud API      none
+```
+
+The default BlurPad + Lanczos3 preprocessing preserves the source aspect ratio,
+places the fitted sharp image over a blurred full-canvas background, and sends a
+single 224x224 image to Owen-S. It was selected from Xyran's internal
+preprocessing experiments; this is not a claim that it is universally optimal
+for every dataset.
+
+## Optional Warp Linear path
+
+The final benchmark kept a second preprocessing path because its error pattern
+was complementary on some hard cases:
+
+```python
+mod = Moderator(preprocess="warp")
+```
+
+Mappings:
+
+```text
+blurpad -> BlurPad + Lanczos3  (default)
+warp    -> pyvips Warp + Linear
+```
+
+No tiling is used in V1 inference.
+
+## Model residency
+
+Default:
+
+```python
+mod = Moderator(resident=True)
+```
+
+The ONNX session is created once and remains resident until `close()`/`unload()`.
+This is recommended for servers, desktop apps and repeated scanning.
+
+Memory-sensitive mode:
+
+```python
+mod = Moderator(resident=False)
+```
+
+The model is loaded for an operation and released afterwards.
+
+Explicit lifecycle:
+
+```python
+mod.load()
+mod.unload()
+mod.close()
+```
+
+Context-manager use is supported:
+
+```python
+with Moderator() as mod:
+    result = mod.scan("image.jpg")
+```
+
+## Device selection
+
+```python
+Moderator(device="auto")  # default: CUDA when it really works, otherwise CPU
+Moderator(device="cpu")   # strict CPU
+Moderator(device="cuda")  # strict CUDA; raises if CUDA is unusable
+```
+
+`device="auto"` is resilient: session creation and runtime inference can fall
+back to CPU if CUDA is visible but unusable.
+
+## Inputs
+
+`scan()` accepts:
+
+- local file paths (`str` / `pathlib.Path`)
+- encoded image bytes (`bytes` / `bytearray`)
+- `PIL.Image.Image`
+
+EXIF orientation is applied. The default image backend is libvips/pyvips.
+
+## Policy
+
+The classifier produces:
+
+```text
+NSFL -> graphic
+NSFW -> sexual
+SFW  -> safe
+```
+
+V1 development defaults:
+
+```text
+sexual REVIEW >= 0.35
+sexual BLOCK  >= 0.85
+graphic REVIEW >= 0.35
+graphic BLOCK  >= 0.85
+```
+
+These thresholds are **not universal safety policy**. Real moderation policy is
+application-specific. The model author also notes that NSFW judgments are
+subjective/contextual and that the NSFL class is underrepresented in training.
+
+Customize policy:
+
+```python
+from xyran import Moderator, ModerationPolicy
+
+policy = ModerationPolicy(
+    sexual_review=0.40,
+    sexual_block=0.90,
+    graphic_review=0.35,
+    graphic_block=0.85,
+)
+
+mod = Moderator(policy=policy)
+```
+
+## CLI
+
+```bash
+xyran doctor
+xyran scan image.jpg
+xyran scan image.jpg --json
+xyran scan image.jpg --preprocess warp
+xyran scan image.jpg --device cpu
+xyran scan image.jpg --no-resident
+```
+
+## Bundled model
+
+Xyran V1 pins:
+
+```text
+Repository: OwenElliott/image-safety-classifier-s
+Source commit: eb8b0b203952b70db191e990217174af4af39767
+File: onnx/image-safety-classifier-s.onnx
+Size: 23,701,765 bytes
+SHA256: fef443ed68ae25ed693b6fef9e456071692ed3963cff4168acb39c3de6f017e7
+License metadata: MIT
+```
+
+See `THIRD_PARTY_NOTICES.md` and package `xyran/third_party/`.
+
+## Offline guarantee
+
+After `pip install xyran` finishes successfully:
+
+```text
+model download during inference: NO
+API key:                         NO
+cloud moderation API:           NO
+telemetry:                       NO
+network required for inference: NO
+```
+
+## Notes
+
+This SDK helps classify image-safety risk. It is not a guarantee that every
+unsafe image will be detected, nor that every flagged image is unsafe. For
+high-stakes moderation, use human review and dataset-specific evaluation.

xyran-1.0.0/PUBLISHING.md

@@ -0,0 +1,99 @@
+# Publishing Xyran V1 to PyPI
+
+The release source ZIP intentionally does **not** contain a fake/placeholder
+ONNX model. `BUILD_RELEASE.bat` downloads the exact pinned model, verifies its
+SHA256, copies it into the Python package, then builds the wheel and sdist.
+
+The resulting artifacts **do contain the model**, so end users only need:
+
+```bash
+pip install xyran
+```
+
+## 1. Build the release on Windows
+
+From the extracted project directory:
+
+```bat
+BUILD_RELEASE.bat
+```
+
+It will:
+
+1. create an isolated `.release-venv`;
+2. download the exact pinned Owen-S ONNX model (HF, then hf-mirror fallback);
+3. verify file size and SHA256;
+4. run unit/regression tests;
+5. build wheel + sdist;
+6. run `twine check`;
+7. inspect both archives and verify the model is actually bundled.
+
+Expected files:
+
+```text
+dist\xyran-1.0.0-py3-none-any.whl
+dist\xyran-1.0.0.tar.gz
+```
+
+## 2. End-user install rehearsal
+
+Before publishing:
+
+```bat
+TEST_LOCAL_INSTALL.bat
+```
+
+This creates a clean install environment, installs the built wheel with all
+runtime dependencies, then runs:
+
+```text
+xyran doctor
+```
+
+On Windows x64 this intentionally downloads the ONNX Runtime GPU package plus
+pip-managed CUDA/cuDNN runtime dependencies. This can be a large download.
+
+## 3. PyPI account/token
+
+Create a PyPI API token for the project/account. With Twine you can either enter
+credentials interactively or use environment variables:
+
+```bat
+set TWINE_USERNAME=__token__
+set TWINE_PASSWORD=pypi-xxxxxxxxxxxxxxxx
+```
+
+Do not commit the token.
+
+## 4. Optional TestPyPI upload
+
+```bat
+.release-venv\Scripts\python -m twine upload --repository testpypi dist\*
+```
+
+Because runtime dependencies live on normal PyPI, installation from TestPyPI
+usually needs normal PyPI as an extra index.
+
+## 5. Production upload
+
+```bat
+.release-venv\Scripts\python -m twine upload dist\*
+```
+
+Then verify from a new environment:
+
+```bat
+python -m venv verify-pypi
+verify-pypi\Scripts\activate
+python -m pip install --upgrade pip
+pip install xyran==1.0.0
+xyran doctor
+```
+
+## Important dependency note
+
+ONNX Runtime publishes separate CPU and GPU distributions which share the same
+Python import namespace. Xyran's environment markers install exactly
+one runtime on a clean environment. If a user already has the opposite ORT
+package installed, `xyran doctor` detects the conflict and explains
+how to clean it.