dyff-schema 0.9.0__py3-none-any.whl → 0.10.1__py3-none-any.whl

dyff/schema/errors.py

@@ -6,8 +6,8 @@ from typing import NamedTuple, Optional
 
 
 class HTTPResponseStatus(NamedTuple):
-    status_code: int
-    description: str
+    code: int
+    status: str
 
 
 HTTP_400_BAD_REQUEST = HTTPResponseStatus(400, "Bad Request")
@@ -28,7 +28,7 @@ class ClientError(DyffError):
     def __init__(
         self, message, *, http_status: HTTPResponseStatus = HTTP_400_BAD_REQUEST
     ):
-        if not (400 <= http_status.status_code <= 499):
+        if not (400 <= http_status.code <= 499):
             raise AssertionError(
                 f"ClientError should map to a 4xx HTTP status; got {http_status}"
             )
@@ -44,7 +44,7 @@ class PlatformError(DyffError):
         *,
         http_status: HTTPResponseStatus = HTTP_500_INTERNAL_SERVER_ERROR,
     ):
-        if not (500 <= http_status.status_code <= 599):
+        if not (500 <= http_status.code <= 599):
             raise AssertionError(
                 f"PlatformError should map to a 5xx HTTP status; got {http_status}"
             )

dyff/schema/v0/r1/platform.py

@@ -18,6 +18,7 @@ We use the following naming convention:
 # mypy: disable-error-code="import-untyped"
 import abc
 import enum
+import urllib.parse
 from datetime import datetime
 from enum import Enum
 from typing import Any, Literal, NamedTuple, Optional, Type, Union
@@ -998,8 +999,74 @@ class InferenceServiceRunnerKind(str, Enum):
     VLLM = "vllm"
 
 
+class ContainerImageSource(DyffSchemaBaseModel):
+    host: str = pydantic.Field(description="The host of the container image registry.")
+    name: str = pydantic.Field(
+        description="The name of the image",
+        # https://github.com/opencontainers/distribution-spec/blob/main/spec.md#pull
+        regex=r"^[a-z0-9]+((\.|_|__|-+)[a-z0-9]+)*(\/[a-z0-9]+((\.|_|__|-+)[a-z0-9]+)*)*$",
+    )
+    digest: str = pydantic.Field(
+        description="The digest of the image. The image is always pulled by"
+        " digest, even if 'tag' is specified.",
+        regex=r"^sha256:[0-9a-f]{64}$",
+    )
+    tag: Optional[str] = pydantic.Field(
+        default=None,
+        description="The tag of the image. Although the image is always pulled"
+        " by digest, including the tag is strongly recommended as it is often"
+        " the main source of versioning information.",
+        # https://github.com/opencontainers/distribution-spec/blob/main/spec.md#pull
+        regex=r"^[a-zA-Z0-9_][a-zA-Z0-9._-]{0,127}$",
+    )
+
+    def url(self) -> str:
+        return f"{self.host}/{self.name}@{self.digest}"
+
+    @pydantic.validator("host")
+    def validate_host(cls, v: str):
+        if "/" in v:
+            raise ValueError(
+                "host: slashes not allowed; do not specify a scheme or path"
+            )
+        if "_" in v:
+            # https://docs.docker.com/reference/cli/docker/image/tag/#description
+            raise ValueError(
+                "host: image registry hostnames may not contain underscores"
+            )
+
+        # This works because we know there are no slashes in the value
+        # "Following the syntax specifications in RFC 1808, urlparse recognizes
+        # a netloc only if it is properly introduced by ‘//’. Otherwise the
+        # input is presumed to be a relative URL and thus to start with a path
+        # component."
+        # https://docs.python.org/3/library/urllib.parse.html#urllib.parse.urlparse
+        parsed = urllib.parse.urlparse(f"//{v}")
+        if (
+            parsed.scheme
+            or parsed.path
+            or parsed.params
+            or parsed.query
+            or parsed.fragment
+        ):
+            raise ValueError(
+                "host: must be 'hostname' or 'hostname:port', and nothing else"
+            )
+
+        return v
+
+
 class InferenceServiceRunner(DyffSchemaBaseModel):
     kind: InferenceServiceRunnerKind
+
+    # TODO: (DYFF-421) Make .image required
+    image: Optional[ContainerImageSource] = pydantic.Field(
+        default=None,
+        description="The container image that implements the runner. This field is"
+        " optional for schema backwards-compatibility, but creating new"
+        " services with image=None will result in an error.",
+    )
+
     args: Optional[list[str]] = pydantic.Field(
         default=None, description="Command line arguments to forward to the runner"
     )
@@ -1878,6 +1945,7 @@ __all__ = [
     "Audit",
     "AuditProcedure",
     "AuditRequirement",
+    "ContainerImageSource",
     "DataSchema",
     "Dataset",
     "DatasetBase",

dyff/schema/v0/r1/requests.py

@@ -83,6 +83,16 @@ class InferenceServiceCreateRequest(DyffEntityCreateRequest, InferenceServiceBas
         default=None, description="ID of Model backing the service, if applicable"
     )
 
+    # TODO: (DYFF-421) Make .image required and remove this validator
+    @pydantic.validator("image", check_fields=False)
+    def validate_image_not_none(cls, v):
+        if v is None:
+            raise ValueError(
+                ".image is required for new services; it is defined as Optional"
+                " for schema backwards-compatibility only"
+            )
+        return v
+
 
 class InferenceSessionCreateRequest(DyffEntityCreateRequest, InferenceSessionBase):
     inferenceService: str = pydantic.Field(description="InferenceService ID")

{dyff_schema-0.9.0.dist-info → dyff_schema-0.10.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dyff-schema
-Version: 0.9.0
+Version: 0.10.1
 Summary: Data models for the Dyff AI auditing platform.
 Author-email: Digital Safety Research Institute <contact@dsri.org>
 License: Apache-2.0

{dyff_schema-0.9.0.dist-info → dyff_schema-0.10.1.dist-info}/RECORD

@@ -2,7 +2,7 @@ dyff/schema/__init__.py,sha256=JcpxaRHNYgLjJWLjVayLlqacb2GX49Pazpwb8m-BctM,1031
 dyff/schema/adapters.py,sha256=YMTHv_2VlLGFp-Kqwa6H51hjffHmk8gXjZilHysIF5Q,123
 dyff/schema/base.py,sha256=jvaNtsSZyFfsdUZTcY_U-yfLY5_GyrMxSXhON2R9XR0,119
 dyff/schema/copydoc.py,sha256=B4ZRpQmbFxi-3l9LCHvaJiVKb9VxADgC5vey804Febc,1075
-dyff/schema/errors.py,sha256=4FwatI-0RUYYqVR0hHoifXPgANk89QgSq9PTS9FzfwU,1568
+dyff/schema/errors.py,sha256=ow3yiucU4wGkeLmapUURp3eyaebwGUwDaVTXpPcrA7M,1542
 dyff/schema/ids.py,sha256=Z3JQzlAJQC2Pam7ehxb4TXA4MIuFQN5SyzL5Ql0RukA,1422
 dyff/schema/platform.py,sha256=peHzGGSd5dQ-EFXrWDjBqMUtoOL3iCHxcV3XzW6Rjag,123
 dyff/schema/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -22,8 +22,8 @@ dyff/schema/v0/__init__.py,sha256=L5y8UhRnojerPYHumsxQJRcHCNz8Hj9NM8b47mewMNs,92
 dyff/schema/v0/r1/__init__.py,sha256=L5y8UhRnojerPYHumsxQJRcHCNz8Hj9NM8b47mewMNs,92
 dyff/schema/v0/r1/adapters.py,sha256=2t2oxsnGfSEDKKDIEYw4qqLXMH7qlFIwPVuLyUmbsHs,23552
 dyff/schema/v0/r1/base.py,sha256=QX1TfqX3jBafxpBnf2bUTcgP0sMyqZFFNJZQHhM48BI,19385
-dyff/schema/v0/r1/platform.py,sha256=t7XKNBXByrkleLhcRZn1Et0Dtb36CtmghWeezThz_UI,61416
-dyff/schema/v0/r1/requests.py,sha256=I2K3thOsga0X9-6oRsAO1Hqgkr8qV_8haw-7ALIf_yc,9857
+dyff/schema/v0/r1/platform.py,sha256=XNrL-H1wuY9CaBpfbCVzDK7hqclS87OouyAnS9FlM4g,64134
+dyff/schema/v0/r1/requests.py,sha256=2Xu1iA2m1bCNzITPcwrnNagqAOtB8Fahav9zzV8oGJ0,10245
 dyff/schema/v0/r1/test.py,sha256=X6dUyVd5svcPCI-PBMOAqEfK9jv3bRDvkQTJzwS96c0,10720
 dyff/schema/v0/r1/version.py,sha256=isKAGuGxsdru8vDaYmI4YiZdJOu_wNxXK7u6QzD6FE4,392
 dyff/schema/v0/r1/dataset/__init__.py,sha256=LbVlkO2asyGYBKk2z49xjJYTM-pu9y9e4eQDXgTDLnM,2553
@@ -34,9 +34,9 @@ dyff/schema/v0/r1/dataset/text.py,sha256=nLIn91Zlt0tNdXUklSgjJ-kEDxoPX32ISLkiv2D
 dyff/schema/v0/r1/dataset/vision.py,sha256=aIe0fbfM_g3DsrDTdg2K803YKLjZBpurM_VJcJFuZLc,369
 dyff/schema/v0/r1/io/__init__.py,sha256=L5y8UhRnojerPYHumsxQJRcHCNz8Hj9NM8b47mewMNs,92
 dyff/schema/v0/r1/io/vllm.py,sha256=CUE9y8KthtUI7sD49S875rDmPvKotSXVIRaBS79aBZs,5320
-dyff_schema-0.9.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-dyff_schema-0.9.0.dist-info/METADATA,sha256=y8iwfPwD_j6hEaMZXg7wTYwt319cWdKjB2eDNRiyc14,3459
-dyff_schema-0.9.0.dist-info/NOTICE,sha256=YONACu0s_Ui6jNi-wtEsVQbTU1JIkh8wvLH6d1-Ni_w,43
-dyff_schema-0.9.0.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-dyff_schema-0.9.0.dist-info/top_level.txt,sha256=9e3VVdeX73t_sUJOPQPCcGtYO1JhoErhHIi3WoWGcFI,5
-dyff_schema-0.9.0.dist-info/RECORD,,
+dyff_schema-0.10.1.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+dyff_schema-0.10.1.dist-info/METADATA,sha256=1yQ9XLIRO4uugg3K5OBROsnHoBCA4ekh1PRWImfFSU0,3460
+dyff_schema-0.10.1.dist-info/NOTICE,sha256=YONACu0s_Ui6jNi-wtEsVQbTU1JIkh8wvLH6d1-Ni_w,43
+dyff_schema-0.10.1.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
+dyff_schema-0.10.1.dist-info/top_level.txt,sha256=9e3VVdeX73t_sUJOPQPCcGtYO1JhoErhHIi3WoWGcFI,5
+dyff_schema-0.10.1.dist-info/RECORD,,