dyff-schema 0.10.1__tar.gz → 0.10.3__tar.gz

{dyff_schema-0.10.1 → dyff_schema-0.10.3}/.gitlab-ci.yml

@@ -20,7 +20,7 @@ include:
     file:
       - prettier.yml
   - project: buildgarden/pipelines/python
-    ref: 0.12.0
+    ref: 0.13.0
     file:
       - python-autoflake.yml
       - python-black.yml
@@ -33,7 +33,7 @@ include:
       - python-twine-upload.yml
       - python-docformatter.yml
   - project: buildgarden/pipelines/skywalking-eyes
-    ref: 0.2.0
+    ref: 0.2.2
     file:
       - license-eye-header-check.yml
 

{dyff_schema-0.10.1/dyff_schema.egg-info → dyff_schema-0.10.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dyff-schema
-Version: 0.10.1
+Version: 0.10.3
 Summary: Data models for the Dyff AI auditing platform.
 Author-email: Digital Safety Research Institute <contact@dsri.org>
 License: Apache-2.0
@@ -24,6 +24,7 @@ License-File: NOTICE
 Requires-Dist: hypothesis
 Requires-Dist: hypothesis-jsonschema
 Requires-Dist: jsonpath-ng
+Requires-Dist: numpy<2
 Requires-Dist: pyarrow
 Requires-Dist: pydantic<2
 

{dyff_schema-0.10.1 → dyff_schema-0.10.3}/dyff/schema/v0/r1/base.py

@@ -586,7 +586,7 @@ class DyffDefaultSerializers(pydantic.BaseModel):
     ) -> _ModelAsDict:
         """Encode the object as a dict containing only JSON datatypes.
 
-        .. deprecated::
+        .. deprecated:: 0.8.0
 
             FIXME: This emulates a Pydantic 2 feature, but the mode="json"
             option can only be implemented in an inefficient way. Remove when
@@ -614,6 +614,9 @@ class DyffSchemaBaseModel(DyffDefaultSerializers):
     datetimes are well-ordered.
     """
 
+    class Config:
+        extra = pydantic.Extra.forbid
+
     @pydantic.root_validator
     def _ensure_datetime_timezone_utc(cls, values):
         update = {}

{dyff_schema-0.10.1 → dyff_schema-0.10.3}/dyff/schema/v0/r1/platform.py

@@ -140,6 +140,22 @@ def _k8s_label_value_maxlen():
     return _k8s_label_maxlen()
 
 
+def _oci_image_tag_regex():
+    """Regex matching valid image tags according to the OCI spec.
+
+    See: https://github.com/opencontainers/distribution-spec/blob/main/spec.md#pull
+    """
+    return r"^[a-zA-Z0-9_][a-zA-Z0-9._-]{0,127}$"
+
+
+def _oci_image_tag_maxlen():
+    """Max length of valid image tags according to the OCI spec.
+
+    See: https://github.com/opencontainers/distribution-spec/blob/main/spec.md#pull
+    """
+    return 127
+
+
 class Entities(str, enum.Enum):
     """The kinds of entities in the dyff system."""
 
@@ -149,8 +165,10 @@ class Entities(str, enum.Enum):
     AuditProcedure = "AuditProcedure"
     DataSource = "DataSource"
     Dataset = "Dataset"
+    Documentation = "Documentation"
     Evaluation = "Evaluation"
     Family = "Family"
+    History = "History"
     InferenceService = "InferenceService"
     InferenceSession = "InferenceSession"
     Measurement = "Measurement"
@@ -158,8 +176,8 @@ class Entities(str, enum.Enum):
     Model = "Model"
     Module = "Module"
     Report = "Report"
+    Revision = "Revision"
     SafetyCase = "SafetyCase"
-    Tag = "Tag"
 
 
 class Resources(str, enum.Enum):
@@ -170,8 +188,10 @@ class Resources(str, enum.Enum):
     AuditProcedure = "auditprocedures"
     Dataset = "datasets"
     DataSource = "datasources"
+    Documentation = "documentation"
     Evaluation = "evaluations"
     Family = "families"
+    History = "histories"
     InferenceService = "inferenceservices"
     InferenceSession = "inferencesessions"
     Measurement = "measurements"
@@ -179,8 +199,8 @@ class Resources(str, enum.Enum):
     Model = "models"
     Module = "modules"
     Report = "reports"
+    Revision = "revisions"
     SafetyCase = "safetycases"
-    Tag = "tags"
 
     Task = "tasks"
     """
@@ -217,6 +237,11 @@ LabelValue: TypeAlias = Optional[  # type: ignore
 ]
 
 
+TagName: TypeAlias = pydantic.constr(  # type: ignore
+    regex=_oci_image_tag_regex(), max_length=_k8s_label_key_maxlen()
+)
+
+
 class Label(DyffSchemaBaseModel):
     """A key-value label for a resource. Used to specify identifying attributes of
     resources that are meaningful to users but do not imply semantics in the dyff
@@ -331,67 +356,6 @@ class Documented(DyffSchemaBaseModel):
     )
 
 
-class FamilyMemberKind(str, enum.Enum):
-    """The kinds of entities that can be members of a Family.
-
-    These are resources for which it makes sense to have different versions or variants
-    that evolve over time.
-    """
-
-    Dataset = "Dataset"
-    InferenceService = "InferenceService"
-    Method = "Method"
-    Model = "Model"
-    Module = "Module"
-
-
-class FamilyMember(DyffSchemaBaseModel):
-    family: Optional[str] = pydantic.Field(
-        default=None,
-        description="ID of the Family to which the resource belongs.",
-    )
-
-
-class TagBase(DyffSchemaBaseModel):
-    tag: str = pydantic.Field(
-        description="An interpretable identifier for the tag that is unique in"
-        " the context of the corresponding Family."
-    )
-
-    resource: str = pydantic.Field(
-        description="ID of the resource this tag references.",
-    )
-
-    description: str = pydantic.Field(
-        description="A short description of the tag. Interpreted as Markdown."
-        " This should include information about how the tagged version is"
-        " different from other versions."
-    )
-
-
-class Tag(TagBase):
-    created: datetime = pydantic.Field(description="Tag creation time.")
-
-
-class Family(Labeled, SchemaVersion, DyffModelWithID):
-    kind: Literal["Family"] = "Family"
-
-    resourceKind: FamilyMemberKind = pydantic.Field(
-        description="The kind of resource that comprises the family.",
-    )
-
-    tags: list[Tag] = pydantic.Field(
-        default_factory=list,
-        description="Tags mapping interpretable names to resource IDs.",
-    )
-
-    documentation: DocumentationBase = pydantic.Field(
-        default_factory=DocumentationBase,
-        description="Documentation of the resource family. The content is used"
-        " to populate various views in the web UI.",
-    )
-
-
 class DyffEntity(Status, Labeled, SchemaVersion, DyffModelWithID):
     kind: Literal[
         "Analysis",
@@ -400,6 +364,8 @@ class DyffEntity(Status, Labeled, SchemaVersion, DyffModelWithID):
         "DataSource",
         "Dataset",
         "Evaluation",
+        "Family",
+        "History",
         "InferenceService",
         "InferenceSession",
         "Measurement",
@@ -407,6 +373,7 @@ class DyffEntity(Status, Labeled, SchemaVersion, DyffModelWithID):
         "Model",
         "Module",
         "Report",
+        "Revision",
         "SafetyCase",
     ]
 
@@ -584,6 +551,89 @@ class Account(DyffSchemaBaseModel):
     creationTime: Optional[datetime] = None
 
 
+class FamilyMemberKind(str, enum.Enum):
+    """The kinds of entities that can be members of a Family.
+
+    These are resources for which it makes sense to have different versions or variants
+    that evolve over time.
+    """
+
+    Dataset = "Dataset"
+    InferenceService = "InferenceService"
+    Method = "Method"
+    Model = "Model"
+    Module = "Module"
+
+
+class FamilyMemberBase(DyffSchemaBaseModel):
+    name: TagName = pydantic.Field(
+        description="An interpretable identifier for the member that is unique"
+        " in the context of the corresponding Family.",
+    )
+
+    resource: str = pydantic.Field(
+        description="ID of the resource this member references.",
+    )
+
+    description: Optional[str] = pydantic.Field(
+        default=None,
+        description="A short description of the member. Interpreted as Markdown."
+        " This should include information about how this version of the resource"
+        " is different from other versions.",
+    )
+
+
+class FamilyMember(FamilyMemberBase):
+    family: str = pydantic.Field(
+        description="Identifier of the Family containing this tag."
+    )
+
+    creationTime: datetime = pydantic.Field(
+        default=None, description="Tag creation time (assigned by system)"
+    )
+
+
+class FamilyMembers(DyffSchemaBaseModel):
+    members: dict[TagName, FamilyMember] = pydantic.Field(
+        default_factory=dict,
+        description="Mapping of names to IDs of member resources.",
+    )
+
+
+class FamilyBase(DyffSchemaBaseModel):
+    memberKind: FamilyMemberKind = pydantic.Field(
+        description="The kind of resource that comprises the family.",
+    )
+
+
+class Family(DyffEntity, FamilyBase, FamilyMembers):
+    kind: Literal["Family"] = "Family"
+
+    documentation: DocumentationBase = pydantic.Field(
+        default_factory=DocumentationBase,
+        description="Documentation of the resource family. The content is used"
+        " to populate various views in the web UI.",
+    )
+
+
+class RevisionMetadata(DyffSchemaBaseModel):
+    creationTime: datetime = pydantic.Field("The time when the Revision was created")
+
+
+# Note: The 'Revision' class itself is defined all the way at the end of this
+# file, because OpenAPI generation doesn't work with the Python < 3.10
+# "ForwardDeclaration" syntax.
+
+
+class History(DyffEntity):
+    kind: Literal["History"] = "History"
+
+    latest: str = pydantic.Field(description="The ID of the latest Revision")
+    revisions: dict[str, RevisionMetadata] = pydantic.Field(
+        description="The set of known Revisions"
+    )
+
+
 # ----------------------------------------------------------------------------
 
 
@@ -1011,13 +1061,11 @@ class ContainerImageSource(DyffSchemaBaseModel):
         " digest, even if 'tag' is specified.",
         regex=r"^sha256:[0-9a-f]{64}$",
     )
-    tag: Optional[str] = pydantic.Field(
+    tag: Optional[TagName] = 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:
@@ -1908,12 +1956,14 @@ def entity_class(kind: Entities):
     return _ENTITY_CLASS[kind]
 
 
-DyffEntityType = Union[
+DyffEntityTypeExceptRevision = Union[
     Audit,
     AuditProcedure,
     DataSource,
     Dataset,
     Evaluation,
+    Family,
+    History,
     InferenceService,
     InferenceSession,
     Measurement,
@@ -1925,6 +1975,35 @@ DyffEntityType = Union[
 ]
 
 
+# Note: This class is defined here because OpenAPI generation doesn't work
+# with the Python < 3.10 "ForwardDeclaration" syntax. You get an error like:
+#
+# Traceback (most recent call last):
+#   File "/home/jessehostetler/dsri/code/dyff/dyff-api/./scripts/generate-openapi-definitions.py", line 15, in <module>
+#     get_openapi(
+#   File "/home/jessehostetler/dsri/code/dyff/venv/lib/python3.9/site-packages/fastapi/openapi/utils.py", line 422, in get_openapi
+#     definitions = get_model_definitions(
+#   File "/home/jessehostetler/dsri/code/dyff/venv/lib/python3.9/site-packages/fastapi/utils.py", line 60, in get_model_definitions
+#     m_schema, m_definitions, m_nested_models = model_process_schema(
+#   File "pydantic/schema.py", line 581, in pydantic.schema.model_process_schema
+#   File "pydantic/schema.py", line 622, in pydantic.schema.model_type_schema
+#   File "pydantic/schema.py", line 255, in pydantic.schema.field_schema
+#   File "pydantic/schema.py", line 527, in pydantic.schema.field_type_schema
+#   File "pydantic/schema.py", line 926, in pydantic.schema.field_singleton_schema
+#   File "/home/jessehostetler/.asdf/installs/python/3.9.18/lib/python3.9/abc.py", line 123, in __subclasscheck__
+#     return _abc_subclasscheck(cls, subclass)
+# TypeError: issubclass() arg 1 must be a class
+class Revision(DyffEntity, RevisionMetadata):
+    kind: Literal["Revision"] = "Revision"
+
+    entity: DyffEntityTypeExceptRevision = pydantic.Field(
+        description="The associated entity data",
+    )
+
+
+DyffEntityType = Union[DyffEntityTypeExceptRevision, Revision]
+
+
 __all__ = [
     "Accelerator",
     "AcceleratorGPU",
@@ -1965,12 +2044,16 @@ __all__ = [
     "EvaluationBase",
     "ExtractorStep",
     "Family",
+    "FamilyBase",
     "FamilyMember",
+    "FamilyMemberBase",
     "FamilyMemberKind",
+    "FamilyMembers",
     "ForeignInferenceService",
     "ForeignMethod",
     "ForeignModel",
     "Frameworks",
+    "History",
     "Identity",
     "InferenceInterface",
     "InferenceService",
@@ -2025,13 +2108,14 @@ __all__ = [
     "Report",
     "ReportBase",
     "Resources",
+    "Revision",
+    "RevisionMetadata",
     "SafetyCase",
     "SafetyCaseSpec",
     "SchemaAdapter",
     "Status",
     "StorageSignedURL",
-    "Tag",
-    "TagBase",
+    "TagName",
     "TaskSchema",
     "entity_class",
     "JobStatus",

{dyff_schema-0.10.1 → dyff_schema-0.10.3}/dyff/schema/v0/r1/requests.py

@@ -26,6 +26,8 @@ from .platform import (
     DataView,
     DocumentationBase,
     EvaluationBase,
+    FamilyBase,
+    FamilyMembers,
     InferenceServiceBase,
     InferenceSessionBase,
     Labeled,
@@ -33,7 +35,6 @@ from .platform import (
     ModelSpec,
     ModuleBase,
     ReportBase,
-    TagBase,
 )
 from .version import SchemaVersion
 
@@ -136,6 +137,10 @@ class EvaluationCreateRequest(DyffEntityCreateRequest, EvaluationBase):
         return values
 
 
+class FamilyCreateRequest(DyffEntityCreateRequest, FamilyBase):
+    pass
+
+
 class MethodCreateRequest(DyffEntityCreateRequest, MethodBase):
     pass
 
@@ -169,7 +174,7 @@ class ReportCreateRequest(DyffEntityCreateRequest, ReportBase):
     )
 
 
-class TagCreateRequest(DyffRequestBase, TagBase):
+class FamilyMembersEditRequest(DyffRequestBase, FamilyMembers):
     pass
 
 
@@ -226,6 +231,10 @@ class EvaluationQueryRequest(DyffEntityQueryRequest):
     modelName: Optional[str] = pydantic.Field(default=None)
 
 
+class FamilyQueryRequest(DyffEntityQueryRequest):
+    pass
+
+
 class InferenceServiceQueryRequest(DyffEntityQueryRequest):
     name: Optional[str] = pydantic.Field(default=None)
     model: Optional[str] = pydantic.Field(default=None)
@@ -282,6 +291,9 @@ __all__ = [
     "EvaluationCreateRequest",
     "EvaluationQueryRequest",
     "EvaluationInferenceSessionRequest",
+    "FamilyCreateRequest",
+    "FamilyMembersEditRequest",
+    "FamilyQueryRequest",
     "InferenceServiceCreateRequest",
     "InferenceServiceQueryRequest",
     "InferenceSessionCreateRequest",
@@ -298,5 +310,4 @@ __all__ = [
     "ReportCreateRequest",
     "ReportQueryRequest",
     "SafetyCaseQueryRequest",
-    "TagCreateRequest",
 ]

{dyff_schema-0.10.1 → dyff_schema-0.10.3/dyff_schema.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dyff-schema
-Version: 0.10.1
+Version: 0.10.3
 Summary: Data models for the Dyff AI auditing platform.
 Author-email: Digital Safety Research Institute <contact@dsri.org>
 License: Apache-2.0
@@ -24,6 +24,7 @@ License-File: NOTICE
 Requires-Dist: hypothesis
 Requires-Dist: hypothesis-jsonschema
 Requires-Dist: jsonpath-ng
+Requires-Dist: numpy<2
 Requires-Dist: pyarrow
 Requires-Dist: pydantic<2
 

{dyff_schema-0.10.1 → dyff_schema-0.10.3}/dyff_schema.egg-info/requires.txt

@@ -1,5 +1,6 @@
 hypothesis
 hypothesis-jsonschema
 jsonpath-ng
+numpy<2
 pyarrow
 pydantic<2

{dyff_schema-0.10.1 → dyff_schema-0.10.3}/pyproject.toml

@@ -34,6 +34,7 @@ dependencies = [
     "hypothesis",
     "hypothesis-jsonschema",
     "jsonpath-ng",
+    "numpy<2",
     "pyarrow",
     "pydantic<2",
 ]