dyff-schema 0.19.0__py3-none-any.whl → 0.20.1__py3-none-any.whl

dyff/schema/v0/r1/platform.py

@@ -194,11 +194,13 @@ class Entities(str, enum.Enum):
     Analysis = "Analysis"
     Audit = "Audit"
     AuditProcedure = "AuditProcedure"
+    Concern = "Concern"
     DataSource = "DataSource"
     Dataset = "Dataset"
     Documentation = "Documentation"
     Evaluation = "Evaluation"
     Family = "Family"
+    Hazard = "Hazard"
     History = "History"
     InferenceService = "InferenceService"
     InferenceSession = "InferenceSession"
@@ -210,6 +212,7 @@ class Entities(str, enum.Enum):
     Revision = "Revision"
     SafetyCase = "SafetyCase"
     Score = "Score"
+    UseCase = "UseCase"
 
 
 class Resources(str, enum.Enum):
@@ -218,11 +221,14 @@ class Resources(str, enum.Enum):
     Analysis = "analyses"
     Audit = "audits"
     AuditProcedure = "auditprocedures"
+    Concern = "concerns"
     Dataset = "datasets"
     DataSource = "datasources"
+    Descriptor = "descriptors"
     Documentation = "documentation"
     Evaluation = "evaluations"
     Family = "families"
+    Hazard = "hazards"
     History = "histories"
     InferenceService = "inferenceservices"
     InferenceSession = "inferencesessions"
@@ -234,6 +240,7 @@ class Resources(str, enum.Enum):
     Revision = "revisions"
     SafetyCase = "safetycases"
     Score = "scores"
+    UseCase = "usecases"
 
     Task = "tasks"
     """
@@ -396,6 +403,15 @@ class Documented(DyffSchemaBaseModel):
     )
 
 
+class Metadata(DyffSchemaBaseModel):
+    pass
+
+
+class Mutable(DyffSchemaBaseModel):
+    etag: str
+    lastModificationTime: datetime
+
+
 class DyffEntity(Status, Labeled, SchemaVersion, DyffModelWithID):
     kind: Literal[
         "Analysis",
@@ -405,6 +421,7 @@ class DyffEntity(Status, Labeled, SchemaVersion, DyffModelWithID):
         "Dataset",
         "Evaluation",
         "Family",
+        "Hazard",
         "History",
         "InferenceService",
         "InferenceSession",
@@ -415,6 +432,7 @@ class DyffEntity(Status, Labeled, SchemaVersion, DyffModelWithID):
         "Report",
         "Revision",
         "SafetyCase",
+        "UseCase",
     ]
 
     annotations: list[Annotation] = pydantic.Field(
@@ -683,6 +701,32 @@ class History(DyffEntity):
     )
 
 
+class ConcernBase(Documented):
+    pass
+
+
+class Concern(ConcernBase, DyffEntity):
+    def label_key(self) -> str:
+        return f"{Resources[self.kind].value}.dyff.io/{self.id}"
+
+    def label_value(self) -> str:
+        return "1"
+
+    def dependencies(self) -> list[str]:
+        return []
+
+    def resource_allocation(self) -> Optional[ResourceAllocation]:
+        return None
+
+
+class Hazard(Concern):
+    kind: Literal["Hazard"] = Entities.Hazard.value
+
+
+class UseCase(Concern):
+    kind: Literal["UseCase"] = Entities.UseCase.value
+
+
 # ----------------------------------------------------------------------------
 
 
@@ -1727,6 +1771,16 @@ class MethodBase(DyffSchemaBaseModel):
         return scores
 
 
+class MethodMetadata(Metadata):
+    concerns: list[Concern] = pydantic.Field(
+        default_factory=list, description="The Concerns applicable to this Method."
+    )
+
+
+class ModelMetadata(Metadata):
+    pass
+
+
 class Method(DyffEntity, MethodBase):
     kind: Literal["Method"] = Entities.Method.value
 
@@ -2169,6 +2223,7 @@ DyffEntityTypeExceptRevision = Union[
     Dataset,
     Evaluation,
     Family,
+    Hazard,
     History,
     InferenceService,
     InferenceSession,
@@ -2178,6 +2233,7 @@ DyffEntityTypeExceptRevision = Union[
     Module,
     Report,
     SafetyCase,
+    UseCase,
 ]
 
 
@@ -2232,6 +2288,8 @@ __all__ = [
     "Audit",
     "AuditProcedure",
     "AuditRequirement",
+    "Concern",
+    "ConcernBase",
     "ContainerImageSource",
     "DataSchema",
     "Dataset",
@@ -2243,6 +2301,7 @@ __all__ = [
     "Digest",
     "Documentation",
     "DocumentationBase",
+    "Documented",
     "DyffDataSchema",
     "DyffEntity",
     "DyffEntityType",
@@ -2263,6 +2322,7 @@ __all__ = [
     "ForeignMethod",
     "ForeignModel",
     "Frameworks",
+    "Hazard",
     "History",
     "Identity",
     "InferenceInterface",
@@ -2333,6 +2393,7 @@ __all__ = [
     "StorageSignedURL",
     "TagName",
     "TaskSchema",
+    "UseCase",
     "entity_class",
     "JobStatus",
     "EntityStatus",

dyff/schema/v0/r1/requests.py

@@ -24,6 +24,7 @@ from .base import DyffBaseModel
 from .platform import (
     AnalysisBase,
     AnalysisScope,
+    ConcernBase,
     DatasetBase,
     DataView,
     DocumentationBase,
@@ -37,6 +38,8 @@ from .platform import (
     ModelSpec,
     ModuleBase,
     ReportBase,
+    summary_maxlen,
+    title_maxlen,
 )
 from .version import SchemaVersion
 
@@ -92,12 +95,53 @@ class AnalysisCreateRequest(DyffEntityCreateRequest, AnalysisBase):
         return scope
 
 
+class ConcernCreateRequest(DyffEntityCreateRequest, ConcernBase):
+    @pydantic.validator("documentation", check_fields=False)
+    def _validate_documentation(
+        cls, documentation: DocumentationBase
+    ) -> DocumentationBase:
+        # TODO: This has to be a validator function because we can't apply the
+        # contraint to DocumentationBase, since there are already entities
+        # that violate the constraints in the data store. Fix in Schema v1.
+        if (
+            documentation.title is not None
+            and len(documentation.title) > title_maxlen()
+        ):
+            raise ValueError(
+                f".documentation.title must have length < {title_maxlen()}"
+            )
+        if (
+            documentation.summary is not None
+            and len(documentation.summary) > summary_maxlen()
+        ):
+            raise ValueError(
+                f".documentation.summary must have length < {summary_maxlen()}"
+            )
+        return documentation
+
+
 class DatasetCreateRequest(DyffEntityCreateRequest, DatasetBase):
     pass
 
 
 class DocumentationEditRequest(DyffRequestBase, DocumentationBase):
-    pass
+    @pydantic.validator("title", check_fields=False)
+    def _validate_title(cls, title: Optional[str]) -> Optional[str]:
+        # TODO: This has to be a validator function because we can't apply the
+        # contraint to DocumentationBase, since there are already entities
+        # that violate the constraints in the data store. Fix in Schema v1.
+        if title is not None and len(title) > title_maxlen():
+            raise ValueError(f".title must have length < {title_maxlen()}")
+        return title
+
+    @pydantic.validator("summary", check_fields=False)
+    def _validate_summary(cls, summary: Optional[str]) -> Optional[str]:
+        # TODO: This has to be a validator function because we can't apply the
+        # contraint to DocumentationBase, since there are already entities
+        # that violate the constraints in the data store. Fix in Schema v1.
+        if summary is not None and len(summary) > summary_maxlen():
+            raise ValueError(f".summary must have length < {summary_maxlen()}")
+        return summary
 
 
 class InferenceServiceCreateRequest(DyffEntityCreateRequest, InferenceServiceBase):
@@ -330,9 +374,14 @@ class ScoreQueryRequest(DyffRequestDefaultValidators):
     model: Optional[str] = pydantic.Field(default=None)
 
 
+class UseCaseQueryRequest(DyffEntityQueryRequest):
+    pass
+
+
 __all__ = [
     "AnalysisCreateRequest",
     "AuditQueryRequest",
+    "ConcernCreateRequest",
     "DyffEntityCreateRequest",
     "DyffEntityQueryRequest",
     "DyffRequestBase",
@@ -364,4 +413,5 @@ __all__ = [
     "ReportQueryRequest",
     "SafetyCaseQueryRequest",
     "ScoreQueryRequest",
+    "UseCaseQueryRequest",
 ]

{dyff_schema-0.19.0.dist-info → dyff_schema-0.20.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dyff-schema
-Version: 0.19.0
+Version: 0.20.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.19.0.dist-info → dyff_schema-0.20.1.dist-info}/RECORD

@@ -24,8 +24,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=IpvlYDr6JjYo6tn8XW4C1Fpgd_uqzZGZsG_cuEn_gQs,19441
-dyff/schema/v0/r1/platform.py,sha256=c-XBKsACEmz_VptGDGCDsULGYtxDajVZ6H7mzjxXHGY,74405
-dyff/schema/v0/r1/requests.py,sha256=UC2jK_upahjemie2s_Acg9xd4NDlwlwUUAOGnpI2iS0,13058
+dyff/schema/v0/r1/platform.py,sha256=bvROO9WEOV257C_QSWuWeDLCFegaYl116YvMP-AClUE,75609
+dyff/schema/v0/r1/requests.py,sha256=3aLqBchrwoFg18ZrVGU938Zo3B4G2o-zzHA2r7noEDc,15259
 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
@@ -37,9 +37,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.19.0.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-dyff_schema-0.19.0.dist-info/METADATA,sha256=r7aFHs035B-teQqNrDhlCKYNSicfqzmwXU_8ADCAigo,3482
-dyff_schema-0.19.0.dist-info/NOTICE,sha256=YONACu0s_Ui6jNi-wtEsVQbTU1JIkh8wvLH6d1-Ni_w,43
-dyff_schema-0.19.0.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
-dyff_schema-0.19.0.dist-info/top_level.txt,sha256=9e3VVdeX73t_sUJOPQPCcGtYO1JhoErhHIi3WoWGcFI,5
-dyff_schema-0.19.0.dist-info/RECORD,,
+dyff_schema-0.20.1.dist-info/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+dyff_schema-0.20.1.dist-info/METADATA,sha256=RgL-FUplGCL93AiOnjWVkZ5m_QMygt6kRe2bBq4yp_g,3482
+dyff_schema-0.20.1.dist-info/NOTICE,sha256=YONACu0s_Ui6jNi-wtEsVQbTU1JIkh8wvLH6d1-Ni_w,43
+dyff_schema-0.20.1.dist-info/WHEEL,sha256=PZUExdf71Ui_so67QXpySuHtCi3-J3wvF4ORK6k_S8U,91
+dyff_schema-0.20.1.dist-info/top_level.txt,sha256=9e3VVdeX73t_sUJOPQPCcGtYO1JhoErhHIi3WoWGcFI,5
+dyff_schema-0.20.1.dist-info/RECORD,,