dyff-schema 0.27.3__tar.gz → 0.28.0__tar.gz

{dyff_schema-0.27.3/dyff_schema.egg-info → dyff_schema-0.28.0}/PKG-INFO

@@ -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.28.0/dyff/schema/__init__.py

@@ -0,0 +1,66 @@
+# SPDX-FileCopyrightText: 2024 UL Research Institutes
+# SPDX-License-Identifier: Apache-2.0
+
+import importlib
+from typing import Any, Iterable, Type, TypeVar, Union
+
+import pydantic
+
+from .base import DyffBaseModel, DyffSchemaBaseModel
+from .version import SomeSchemaVersion
+
+
+def _symbol(fully_qualified_name):
+    tokens = fully_qualified_name.split(".")
+    module_name = ".".join(tokens[:-1])
+    member = tokens[-1]
+    module = importlib.import_module(module_name)
+    return getattr(module, member)
+
+
+def product_schema(
+    schemas: Iterable[Type[DyffSchemaBaseModel]],
+) -> Type[DyffSchemaBaseModel]:
+    return pydantic.create_model("Product", __base__=tuple(schemas))
+
+
+# TODO: Should have a way of registering schema names rather than allowing
+# arbitrary imports.
+def named_data_schema(
+    name: str, schema_version: SomeSchemaVersion
+) -> Type[DyffSchemaBaseModel]:
+    version, revision = schema_version.split(".")
+    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-0.27.3 → dyff_schema-0.28.0}/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-0.27.3 → dyff_schema-0.28.0}/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-0.27.3 → dyff_schema-0.28.0}/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 → dyff_schema-0.28.0/dyff_schema.egg-info}/PKG-INFO

@@ -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/dyff/schema/__init__.py

@@ -1,39 +0,0 @@
-# SPDX-FileCopyrightText: 2024 UL Research Institutes
-# SPDX-License-Identifier: Apache-2.0
-
-import importlib
-from typing import Iterable, Type
-
-import pydantic
-
-from .base import DyffSchemaBaseModel
-from .version import SomeSchemaVersion
-
-
-def _symbol(fully_qualified_name):
-    tokens = fully_qualified_name.split(".")
-    module_name = ".".join(tokens[:-1])
-    member = tokens[-1]
-    module = importlib.import_module(module_name)
-    return getattr(module, member)
-
-
-def product_schema(
-    schemas: Iterable[Type[DyffSchemaBaseModel]],
-) -> Type[DyffSchemaBaseModel]:
-    return pydantic.create_model("Product", __base__=tuple(schemas))
-
-
-# TODO: Should have a way of registering schema names rather than allowing
-# arbitrary imports.
-def named_data_schema(
-    name: str, schema_version: SomeSchemaVersion
-) -> Type[DyffSchemaBaseModel]:
-    version, revision = schema_version.split(".")
-    return _symbol(f"dyff.schema.v{version}.r{revision}.dataset.{name}")
-
-
-__all__ = [
-    "named_data_schema",
-    "product_schema",
-]