dyff-schema 0.27.3__py3-none-any.whl → 0.28.0__py3-none-any.whl

dyff/schema/__init__.py

@@ -2,11 +2,11 @@
 # SPDX-License-Identifier: Apache-2.0
 
 import importlib
-from typing import Iterable, Type
+from typing import Any, Iterable, Type, TypeVar, Union
 
 import pydantic
 
-from .base import DyffSchemaBaseModel
+from .base import DyffBaseModel, DyffSchemaBaseModel
 from .version import SomeSchemaVersion
 
 
@@ -33,7 +33,34 @@ def named_data_schema(
     return _symbol(f"dyff.schema.v{version}.r{revision}.dataset.{name}")
 
 
+_UpcastTargetT = TypeVar("_UpcastTargetT", bound=DyffBaseModel)
+_UpcastSourceT = TypeVar("_UpcastSourceT", bound=DyffBaseModel)
+
+
+def upcast(
+    t: type[_UpcastTargetT], obj: Union[_UpcastSourceT, dict[str, Any]]
+) -> _UpcastTargetT:
+    """Perform a "structural upcast" on a Pydantic model instance.
+
+    An upcast is possible when the top-level fields of the target type are a subset of
+    the top-level fields of the source type, and the data in each source field validates
+    against the corresponding target field. In particular, an upcast is possible when
+    the source type is a Python subclass of the target type.
+
+    The upcast is "shallow" in the sense that sub-objects must validate as-is. In
+    particular, most Dyff schema types do not allow additional properties, so validation
+    will fail if a sub-object of the source object has fields that are not present in
+    the corresponding sub-object of the target type.
+    """
+    if not isinstance(obj, dict):
+        # Preserve the unset status
+        obj = obj.dict(exclude_unset=True)
+    fields = {k: v for k, v in obj.items() if k in t.__fields__}
+    return t.parse_obj(fields)
+
+
 __all__ = [
     "named_data_schema",
     "product_schema",
+    "upcast",
 ]

dyff/schema/v0/r1/commands.py

@@ -15,7 +15,6 @@ from .base import DyffSchemaBaseModel, JsonMergePatchSemantics, Null
 from .platform import (
     DyffEntityType,
     EntityIdentifier,
-    EntityKindLiteral,
     FamilyMember,
     FamilyMembers,
     LabelKeyType,
@@ -60,6 +59,7 @@ class Command(SchemaVersion, DyffSchemaBaseModel):
         "EditEntityLabels",
         "EditFamilyMembers",
         "ForgetEntity",
+        "RestoreEntity",
         "UpdateEntityStatus",
     ]
 
@@ -219,6 +219,43 @@ class ForgetEntity(Command):
 # ----------------------------------------------------------------------------
 
 
+class RestoreEntityAttributes(DyffSchemaBaseModel):
+    entity: DyffEntityType = pydantic.Field(
+        description="The full spec of the entity to restore."
+    )
+
+    ifRevisionMatch: Optional[str] = pydantic.Field(
+        default=None,
+        description="Do not change the entity if its revision does not match"
+        " the given revision.",
+    )
+
+    ifRevisionUndefined: Optional[bool] = pydantic.Field(
+        default=None,
+        description="Allow changing entities that have no revision."
+        " By default, entities with no revision will be changed if and only if"
+        " no other matching criteria are specified."
+        " This should be the case only for legacy data.",
+    )
+
+
+class RestoreEntityData(EntityIdentifier):
+    attributes: RestoreEntityAttributes = pydantic.Field(
+        description="The command attributes"
+    )
+
+
+class RestoreEntity(Command):
+    """Restore an entity to a given state."""
+
+    command: Literal["RestoreEntity"] = "RestoreEntity"
+
+    data: RestoreEntityData = pydantic.Field(description="The command data.")
+
+
+# ----------------------------------------------------------------------------
+
+
 class UpdateEntityStatusAttributes(JsonMergePatchSemantics):
     """Attributes for the UpdateEntityStatus command."""
 
@@ -256,6 +293,7 @@ DyffCommandType = Union[
     EditEntityLabels,
     EditFamilyMembers,
     ForgetEntity,
+    RestoreEntity,
     UpdateEntityStatus,
 ]
 
@@ -277,6 +315,9 @@ __all__ = [
     "EntityIdentifier",
     "FamilyIdentifier",
     "ForgetEntity",
+    "RestoreEntity",
+    "RestoreEntityAttributes",
+    "RestoreEntityData",
     "UpdateEntityStatus",
     "UpdateEntityStatusAttributes",
     "UpdateEntityStatusData",

dyff/schema/v0/r1/platform.py

@@ -301,9 +301,7 @@ class EntityIdentifier(DyffSchemaBaseModel):
 
     id: str = pydantic.Field(description="The .id of the entity.")
     kind: EntityKindLiteral = pydantic.Field(
-        description="The .kind of the entity. This is optional because"
-        " sometimes you need to send a command without knowing the kind,"
-        " but it should be set whenever possible.",
+        description="The .kind of the entity.",
     )
 
 

dyff/schema/v0/r1/requests.py

@@ -20,6 +20,7 @@ from typing import Any, Literal, Optional, Union
 
 import pydantic
 
+from ... import upcast
 from . import commands
 from .base import DyffBaseModel, JsonMergePatchSemantics, Null
 from .platform import (
@@ -29,6 +30,7 @@ from .platform import (
     DatasetBase,
     DataView,
     DocumentationBase,
+    Evaluation,
     EvaluationBase,
     FamilyBase,
     FamilyMemberBase,
@@ -197,6 +199,27 @@ class EvaluationCreateRequest(DyffEntityCreateRequest, EvaluationBase):
             )
         return values
 
+    @staticmethod
+    def repeat_of(evaluation: Evaluation) -> EvaluationCreateRequest:
+        """Return a request that will run an existing Evaluation again with the same
+        configuration."""
+        base = upcast(EvaluationBase, evaluation)
+        if evaluation.inferenceSessionReference:
+            return EvaluationCreateRequest(
+                account=evaluation.account,
+                inferenceSessionReference=evaluation.inferenceSessionReference,
+                **base.dict(),
+            )
+        else:
+            return EvaluationCreateRequest(
+                account=evaluation.account,
+                inferenceSession=EvaluationInferenceSessionRequest(
+                    inferenceService=evaluation.inferenceSession.inferenceService.id,
+                    **upcast(InferenceSessionBase, evaluation.inferenceSession).dict(),
+                ),
+                **base.dict(),
+            )
+
 
 class FamilyCreateRequest(DyffEntityCreateRequest, FamilyBase):
     pass
@@ -403,6 +426,7 @@ class ScoreQueryRequest(DyffRequestDefaultValidators):
 
     id: Optional[str] = pydantic.Field(default=None)
     name: Optional[str] = pydantic.Field(default=None)
+    analysis: Optional[str] = pydantic.Field(default=None)
     method: Optional[str] = pydantic.Field(default=None)
     methodName: Optional[str] = pydantic.Field(default=None)
     dataset: Optional[str] = pydantic.Field(default=None)

{dyff_schema-0.27.3.dist-info → dyff_schema-0.28.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: dyff-schema
-Version: 0.27.3
+Version: 0.28.0
 Summary: Data models for the Dyff AI auditing platform.
 Author-email: Digital Safety Research Institute <contact@dsri.org>
 License: Apache-2.0
@@ -27,6 +27,7 @@ Requires-Dist: jsonpath-ng
 Requires-Dist: numpy<2
 Requires-Dist: pyarrow
 Requires-Dist: pydantic<2
+Dynamic: license-file
 
 # dyff-schema
 

{dyff_schema-0.27.3.dist-info → dyff_schema-0.28.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-dyff/schema/__init__.py,sha256=JcpxaRHNYgLjJWLjVayLlqacb2GX49Pazpwb8m-BctM,1031
+dyff/schema/__init__.py,sha256=Nua_5EC8HHIxBp6u0SmnApz1WmlYSJ8tDsayD4zEl_Y,2237
 dyff/schema/adapters.py,sha256=YMTHv_2VlLGFp-Kqwa6H51hjffHmk8gXjZilHysIF5Q,123
 dyff/schema/annotations.py,sha256=nE6Jk1PLqlShj8uqjE_EzZC9zYnTDW5AVtQcjysiK8M,10018
 dyff/schema/base.py,sha256=jvaNtsSZyFfsdUZTcY_U-yfLY5_GyrMxSXhON2R9XR0,119
@@ -25,9 +25,9 @@ dyff/schema/v0/__init__.py,sha256=L5y8UhRnojerPYHumsxQJRcHCNz8Hj9NM8b47mewMNs,92
 dyff/schema/v0/r1/__init__.py,sha256=L5y8UhRnojerPYHumsxQJRcHCNz8Hj9NM8b47mewMNs,92
 dyff/schema/v0/r1/adapters.py,sha256=dmQS2ecgDX4ZvTMOW-6NzV_Oq_UpaiyFd7QnSNoOnK8,33057
 dyff/schema/v0/r1/base.py,sha256=Rry7GKdQyCLNXskB1CxqVlhVsgM8pw6a4xy3BFk_lRc,21095
-dyff/schema/v0/r1/commands.py,sha256=eBXoDxmRZ9s2Idj1srmIaLPCn6QVbWXwpbNDHaJZDco,8354
-dyff/schema/v0/r1/platform.py,sha256=XqDSV0vCLjSPwwMe87Ah6qz4rYCGg9eMYuVf6VUFViM,81566
-dyff/schema/v0/r1/requests.py,sha256=AIBzfOnDEMVh1sCOCM6oKMVwZTCW3v9f5BVKB2s3-X0,16025
+dyff/schema/v0/r1/commands.py,sha256=zgaggy9x2lPaDwRSVtyd7jrZ2gjJDbyghsdj2RmEaBs,9607
+dyff/schema/v0/r1/platform.py,sha256=BNKQt-2udkPt7_Qg5s-I0U8m3Sb7eKbQYqvg87rkNfg,81416
+dyff/schema/v0/r1/requests.py,sha256=56R_yOdbDOEcY0og2GoY5bXeG6ifn7z3ypNdBOF_igk,17043
 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
@@ -39,9 +39,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.27.3.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-dyff_schema-0.27.3.dist-info/METADATA,sha256=tHACi-1R9vZ6FRJ9WViyF41vFt4eEYDzERRT6sC1jAU,3482
-dyff_schema-0.27.3.dist-info/NOTICE,sha256=YONACu0s_Ui6jNi-wtEsVQbTU1JIkh8wvLH6d1-Ni_w,43
-dyff_schema-0.27.3.dist-info/WHEEL,sha256=52BFRY2Up02UkjOa29eZOS2VxUrpPORXg1pkohGGUS8,91
-dyff_schema-0.27.3.dist-info/top_level.txt,sha256=9e3VVdeX73t_sUJOPQPCcGtYO1JhoErhHIi3WoWGcFI,5
-dyff_schema-0.27.3.dist-info/RECORD,,
+dyff_schema-0.28.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+dyff_schema-0.28.0.dist-info/licenses/NOTICE,sha256=YONACu0s_Ui6jNi-wtEsVQbTU1JIkh8wvLH6d1-Ni_w,43
+dyff_schema-0.28.0.dist-info/METADATA,sha256=2SxPi0TcWR7YZcaINtotNvXiyI7kkfbEAhm3CkD1hGg,3504
+dyff_schema-0.28.0.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+dyff_schema-0.28.0.dist-info/top_level.txt,sha256=9e3VVdeX73t_sUJOPQPCcGtYO1JhoErhHIi3WoWGcFI,5
+dyff_schema-0.28.0.dist-info/RECORD,,

{dyff_schema-0.27.3.dist-info → dyff_schema-0.28.0.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (76.0.0)
+Generator: setuptools (78.1.0)
 Root-Is-Purelib: true
 Tag: py3-none-any