orbitals 0.1.1__tar.gz → 0.1.3__tar.gz

orbitals-0.1.3/.github/workflows/publish.yml

@@ -0,0 +1,26 @@
+name: "Publish"
+
+on:
+  release:
+    types:
+      - created
+
+jobs:
+  run:
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+    permissions:
+      id-token: write
+      contents: read
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+      - name: Install uv
+        uses: astral-sh/setup-uv@v7
+      - name: Install Python 3.13
+        run: uv python install 3.13
+      - name: Build
+        run: uv build
+      - name: Publish
+        run: uv publish

{orbitals-0.1.1 → orbitals-0.1.3}/AGENTS.md

@@ -20,15 +20,12 @@ This is done by prompting **local LLMs**.
     
 ## Project Structure
 
-The API implementation is entirely in Python, using `uv` as the package manager. We are adopting a mono-repo approach, with the `packages/` folder structured as follows:
-
-/src/transformers: 
-/models: 
+The API implementation is entirely in Python, using `uv` as the package manager. Project structure is as follows:
 
 * `src/orbitals/`: This contains the core source code for the library.
-    * `src/orbitals/cli`: code for root `orbitals` cli. It's a Typer app that imports and adds the apps defined by each orbital.
-    * `src/orbitals/scope_guard`:
-        * `src/orbitals/scope_guard/guards/`: Code for individual scope guards. Starting from the `BaseScopeGuard` root class, we find two subclasses, `ScopeGuard` (sync guard and batch-guard methods) and `AsyncScopeGuard` (async counterpart).
+    * `src/orbitals/cli`: Code for root `orbitals` cli. It's a Typer app that imports and adds the apps defined by each orbital.
+    * `src/orbitals/scope_guard`: This contains the code for the `ScopeGuard` orbital.
+        * `src/orbitals/scope_guard/guards/`: Code for individual scope guards. Starting from the `BaseScopeGuard` root class, we find two subclasses, `ScopeGuard` (sync validate and batch-validate methods) and `AsyncScopeGuard` (async counterpart).
         * `src/orbitals/scope_guard/cli/`: This contains the CLI commands of `scope-guard`.
         * `src/orbitals/scope_guard/serving/`: This contains the FastAPI serving implementation.
 

{orbitals-0.1.1 → orbitals-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: orbitals
-Version: 0.1.1
+Version: 0.1.3
 Summary: LLM Guardrails tailored to your Principles
 Author-email: Luigi Procopio <luigi@principled-intelligence.com>, Edoardo Barba <edoardo@principled-intelligence.com>
 License: Apache-2.0
@@ -11,7 +11,7 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
-Requires-Python: ==3.13
+Requires-Python: >=3.10
 Requires-Dist: aiohttp
 Requires-Dist: pydantic>=2.0.0
 Requires-Dist: requests
@@ -22,7 +22,7 @@ Requires-Dist: fastapi[standard]>=0.119.1; extra == 'all'
 Requires-Dist: nvidia-ml-py; extra == 'all'
 Requires-Dist: transformers<5.0.0,>=4.47.0; extra == 'all'
 Requires-Dist: uvicorn>=0.29.0; extra == 'all'
-Requires-Dist: vllm<0.13.0,>=0.11.0; extra == 'all'
+Requires-Dist: vllm>=0.11.0; extra == 'all'
 Requires-Dist: xgrammar; extra == 'all'
 Provides-Extra: scope-guard-all
 Requires-Dist: accelerate>=1.11.0; extra == 'scope-guard-all'
@@ -30,7 +30,7 @@ Requires-Dist: fastapi[standard]>=0.119.1; extra == 'scope-guard-all'
 Requires-Dist: nvidia-ml-py; extra == 'scope-guard-all'
 Requires-Dist: transformers<5.0.0,>=4.47.0; extra == 'scope-guard-all'
 Requires-Dist: uvicorn>=0.29.0; extra == 'scope-guard-all'
-Requires-Dist: vllm<0.13.0,>=0.11.0; extra == 'scope-guard-all'
+Requires-Dist: vllm>=0.11.0; extra == 'scope-guard-all'
 Requires-Dist: xgrammar; extra == 'scope-guard-all'
 Provides-Extra: scope-guard-hf
 Requires-Dist: accelerate>=1.11.0; extra == 'scope-guard-hf'
@@ -41,12 +41,12 @@ Requires-Dist: fastapi[standard]>=0.119.1; extra == 'scope-guard-serve'
 Requires-Dist: nvidia-ml-py; extra == 'scope-guard-serve'
 Requires-Dist: transformers<5.0.0,>=4.47.0; extra == 'scope-guard-serve'
 Requires-Dist: uvicorn>=0.29.0; extra == 'scope-guard-serve'
-Requires-Dist: vllm<0.13.0,>=0.11.0; extra == 'scope-guard-serve'
+Requires-Dist: vllm>=0.11.0; extra == 'scope-guard-serve'
 Requires-Dist: xgrammar; extra == 'scope-guard-serve'
 Provides-Extra: scope-guard-vllm
 Requires-Dist: nvidia-ml-py; extra == 'scope-guard-vllm'
 Requires-Dist: transformers<5.0.0,>=4.47.0; extra == 'scope-guard-vllm'
-Requires-Dist: vllm<0.13.0,>=0.11.0; extra == 'scope-guard-vllm'
+Requires-Dist: vllm>=0.11.0; extra == 'scope-guard-vllm'
 Requires-Dist: xgrammar; extra == 'scope-guard-vllm'
 Provides-Extra: serving
 Requires-Dist: fastapi[standard]>=0.119.1; extra == 'serving'
@@ -54,7 +54,7 @@ Requires-Dist: uvicorn>=0.29.0; extra == 'serving'
 Description-Content-Type: text/markdown
 
 <div align="center">
-    <img src="assets/orbitals-banner.png" width="70%" />
+    <img src="https://raw.githubusercontent.com/Principled-Intelligence/orbitals/refs/heads/main/assets/orbitals-banner.png" width="70%" />
     <h3 align="center">
         <p>
             <b>LLM Guardrails tailored to your Principles</b>
@@ -63,10 +63,16 @@ Description-Content-Type: text/markdown
 </div>
 
 <p align="center">
-    <img src="https://img.shields.io/pypi/v/orbitals?color=green" alt="PyPI Version">
+    <a href="https://pypi.org/project/orbitals/">
+        <img src="https://img.shields.io/pypi/v/orbitals?color=green" alt="PyPI Version">
+    </a>
     <!-- <img src="https://img.shields.io/badge/type%20checked-ty-blue.svg?color=green" alt="Type Checked with ty"> -->
-    <img src="https://img.shields.io/pypi/pyversions/orbitals" alt="Python Versions">
-    <img src="https://img.shields.io/github/license/principled-intelligence/orbitals" alt="GitHub License">
+    <a href="https://pypi.org/project/orbitals/">
+        <img src="https://img.shields.io/pypi/pyversions/orbitals" alt="Python Versions">
+    </a>
+    <a href="https://raw.githubusercontent.com/Principled-Intelligence/orbitals/refs/heads/main/LICENSE">
+        <img src="https://img.shields.io/github/license/principled-intelligence/orbitals" alt="GitHub License">
+    </a>
 </p>
 
 ## Overview

{orbitals-0.1.1 → orbitals-0.1.3}/README.md

@@ -1,5 +1,5 @@
 <div align="center">
-    <img src="assets/orbitals-banner.png" width="70%" />
+    <img src="https://raw.githubusercontent.com/Principled-Intelligence/orbitals/refs/heads/main/assets/orbitals-banner.png" width="70%" />
     <h3 align="center">
         <p>
             <b>LLM Guardrails tailored to your Principles</b>
@@ -8,10 +8,16 @@
 </div>
 
 <p align="center">
-    <img src="https://img.shields.io/pypi/v/orbitals?color=green" alt="PyPI Version">
+    <a href="https://pypi.org/project/orbitals/">
+        <img src="https://img.shields.io/pypi/v/orbitals?color=green" alt="PyPI Version">
+    </a>
     <!-- <img src="https://img.shields.io/badge/type%20checked-ty-blue.svg?color=green" alt="Type Checked with ty"> -->
-    <img src="https://img.shields.io/pypi/pyversions/orbitals" alt="Python Versions">
-    <img src="https://img.shields.io/github/license/principled-intelligence/orbitals" alt="GitHub License">
+    <a href="https://pypi.org/project/orbitals/">
+        <img src="https://img.shields.io/pypi/pyversions/orbitals" alt="Python Versions">
+    </a>
+    <a href="https://raw.githubusercontent.com/Principled-Intelligence/orbitals/refs/heads/main/LICENSE">
+        <img src="https://img.shields.io/github/license/principled-intelligence/orbitals" alt="GitHub License">
+    </a>
 </p>
 
 ## Overview

{orbitals-0.1.1 → orbitals-0.1.3}/README.scope-guard.md

@@ -5,9 +5,9 @@
             <a href="https://principled-intelligence.com/news/introducing-scope-guard">
                 <img src="https://img.shields.io/badge/Blog-Article-blue" />
             </a>
-            <a href="https://demo.halo.principled.app">
+            <!-- <a href="https://demo.halo.principled.app">
                 <img src="https://img.shields.io/badge/Live-Demo-green" />
-            </a>
+            </a> -->
             <a href="https://colab.research.google.com/drive/1iBJog8H4QpS3_Y2powR5tidUhWJNajw2">
                 <img src="https://colab.research.google.com/assets/colab-badge.svg" />
             </a>

{orbitals-0.1.1 → orbitals-0.1.3}/pyproject.toml

@@ -4,11 +4,11 @@ build-backend = "hatchling.build"
 
 [project]
 name = "orbitals"
-version = "0.1.1"
+version = "0.1.3"
 description = "LLM Guardrails tailored to your Principles"
 readme = "README.md"
 
-requires-python = "==3.13"
+requires-python = ">=3.10"
 license = { text = "Apache-2.0" }
 
 authors = [
@@ -37,7 +37,7 @@ scope-guard-hf = [
 ]
 scope-guard-vllm = [
     "transformers>=4.47.0,<5.0.0",
-    "vllm>=0.11.0,<0.13.0",
+    "vllm>=0.11.0",
     "xgrammar",
     "nvidia-ml-py",
 ]

{orbitals-0.1.1 → orbitals-0.1.3}/src/orbitals/scope_guard/cli/serve.py

@@ -38,7 +38,9 @@ def serve(
         "0.0.0.0", "-h", "--host", help="The host to use for the server"
     ),
     vllm_port: int = typer.Option(8001, help="The port to use for the vLLM server"),
-    vllm_max_model_len: int = typer.Option(10000, help="Maximum model length for vLLM"),
+    vllm_max_model_len: int = typer.Option(
+        30_000, help="Maximum model length for vLLM"
+    ),
     vllm_max_num_seqs: int = typer.Option(
         2, help="Maximum number of sequences for vLLM"
     ),

{orbitals-0.1.1 → orbitals-0.1.3}/src/orbitals/scope_guard/guards/api.py

@@ -106,7 +106,7 @@ class APIScopeGuard(ScopeGuard):
         skip_evidences: bool | None = None,
     ) -> ScopeGuardOutput:
         response = requests.post(
-            f"{self.api_url}/api/orbitals/scope-guard/validate",
+            f"{self.api_url}/orbitals/scope-guard/validate",
             json=_build_request_data(
                 conversation,
                 skip_evidences if skip_evidences is not None else self.skip_evidences,
@@ -134,7 +134,7 @@ class APIScopeGuard(ScopeGuard):
         skip_evidences: bool | None = None,
     ) -> list[ScopeGuardOutput]:
         response = requests.post(
-            f"{self.api_url}/api/orbitals/scope-guard/batch-validate",
+            f"{self.api_url}/orbitals/scope-guard/batch-validate",
             json=_build_batch_request_data(
                 conversations,
                 skip_evidences if skip_evidences is not None else self.skip_evidences,
@@ -185,7 +185,7 @@ class AsyncAPIScopeGuard(AsyncScopeGuard):
     ) -> ScopeGuardOutput:
         async with aiohttp.ClientSession() as session:
             response = await session.post(
-                f"{self.api_url}/api/in/scope-guard/validate",
+                f"{self.api_url}/in/scope-guard/validate",
                 json=_build_request_data(
                     conversation,
                     skip_evidences
@@ -216,7 +216,7 @@ class AsyncAPIScopeGuard(AsyncScopeGuard):
     ) -> list[ScopeGuardOutput]:
         async with aiohttp.ClientSession() as session:
             response = await session.post(
-                f"{self.api_url}/api/in/scope-guard/batch-validate",
+                f"{self.api_url}/in/scope-guard/batch-validate",
                 json=_build_batch_request_data(
                     conversations,
                     skip_evidences

{orbitals-0.1.1 → orbitals-0.1.3}/src/orbitals/scope_guard/guards/base.py

@@ -139,7 +139,7 @@ class ScopeGuard(BaseScopeGuard):
         backend: Literal["hf"] = "hf",
         model: DefaultModel | str = "scope-guard",
         skip_evidences: bool = False,
-        max_new_tokens: int = 10_000,
+        max_new_tokens: int = 3000,
         do_sample: bool = False,
         **kwargs,
     ) -> HuggingFaceScopeGuard: ...
@@ -151,8 +151,8 @@ class ScopeGuard(BaseScopeGuard):
         model: DefaultModel | str = "scope-guard",
         skip_evidences: bool = False,
         temperature: float = 0.0,
-        max_tokens: int = 10_000,
-        max_model_len: int = 10_000,
+        max_tokens: int = 3000,
+        max_model_len: int = 30_000,
         max_num_seqs: int = 2,
     ) -> VLLMScopeGuard: ...
 
@@ -227,7 +227,7 @@ class AsyncScopeGuard(BaseScopeGuard):
         skip_evidences: bool = False,
         vllm_serving_url: str = "http://localhost:8000",
         temperature: float = 0.0,
-        max_tokens: int = 10_000,
+        max_tokens: int = 3000,
     ) -> AsyncVLLMApiScopeGuard: ...
 
     @overload

{orbitals-0.1.1 → orbitals-0.1.3}/src/orbitals/scope_guard/guards/hf.py

@@ -23,7 +23,7 @@ class HuggingFaceScopeGuard(ScopeGuard):
         backend: Literal["hf"] = "hf",
         model: DefaultModel | str = "scope-guard",
         skip_evidences: bool = False,
-        max_new_tokens: int = 10_000,
+        max_new_tokens: int = 3000,
         do_sample: bool = False,
         **kwargs,
     ):

{orbitals-0.1.1 → orbitals-0.1.3}/src/orbitals/scope_guard/guards/vllm.py

@@ -26,8 +26,8 @@ class VLLMScopeGuard(ScopeGuard):
         model: DefaultModel | str = "scope-guard",
         skip_evidences: bool = False,
         temperature: float = 0.0,
-        max_tokens: int = 10_000,
-        max_model_len: int = 10_000,
+        max_tokens: int = 3000,
+        max_model_len: int = 30_000,
         max_num_seqs: int = 2,
         gpu_memory_utilization: float = 0.9,
     ):
@@ -131,7 +131,7 @@ class AsyncVLLMApiScopeGuard(AsyncScopeGuard):
         skip_evidences: bool = False,
         vllm_serving_url: str = "http://localhost:8000",
         temperature: float = 0.0,
-        max_tokens: int = 10_000,
+        max_tokens: int = 3000,
     ):
         import transformers
 

{orbitals-0.1.1 → orbitals-0.1.3}/src/orbitals/scope_guard/modeling.py

@@ -1,7 +1,7 @@
 from enum import Enum
-from typing import Literal
+from typing import Annotated, Any, Literal
 
-from pydantic import BaseModel, TypeAdapter
+from pydantic import BaseModel, BeforeValidator, TypeAdapter
 
 from ..types import ConversationMessage, LLMUsage
 
@@ -66,6 +66,23 @@ class ConversationUserMessage(BaseModel):
     content: str
 
 
-ScopeGuardInput = str | ConversationUserMessage | list[ConversationMessage]
+def _select_model_based_on_fields(
+    v: Any,
+) -> str | ConversationUserMessage | list[ConversationMessage]:
+    if isinstance(v, str):
+        return TypeAdapter(str).validate_python(v)
+    elif isinstance(v, dict):
+        return TypeAdapter(ConversationUserMessage).validate_python(v)
+    elif isinstance(v, list):
+        return TypeAdapter(list[ConversationMessage]).validate_python(v)
+
+    # no matching model found, let's fall back to standard pydantic behavior
+    return v
+
+
+ScopeGuardInput = Annotated[
+    str | ConversationUserMessage | list[ConversationMessage],
+    BeforeValidator(_select_model_based_on_fields),
+]
 
 ScopeGuardInputTypeAdapter = TypeAdapter(ScopeGuardInput)

{orbitals-0.1.1 → orbitals-0.1.3}/src/orbitals/utils.py

@@ -17,7 +17,7 @@ def maybe_configure_gpu_usage():
         return
 
     try:
-        import pynvml  # ty: ignore[unresolved-import]  # provided by nvidia-ml-py
+        import pynvml  # ty: ignore[unresolved-import]
     except ModuleNotFoundError:
         logging.debug("nvidia-ml-py not available, skipping GPU auto-configuration")
         return