dyff-schema 0.3.5__tar.gz → 0.3.7__tar.gz

{dyff-schema-0.3.5/dyff_schema.egg-info → dyff-schema-0.3.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dyff-schema
-Version: 0.3.5
+Version: 0.3.7
 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.3.5 → dyff-schema-0.3.7}/dyff/schema/v0/r1/platform.py

@@ -1141,16 +1141,6 @@ class MeasurementSpec(DyffSchemaBaseModel):
     )
 
 
-class Measurement(DyffEntity, MeasurementSpec, AnalysisOutputQueryFields):
-    kind: Literal["Measurement"] = Entities.Measurement.value
-
-    def dependencies(self) -> list[str]:
-        return [self.analysis]
-
-    def resource_allocation(self) -> Optional[ResourceAllocation]:
-        return None
-
-
 class SafetyCaseSpec(DyffSchemaBaseModel):
     name: str = pydantic.Field(description="Descriptive name of the SafetyCase.")
     description: Optional[str] = pydantic.Field(
@@ -1158,16 +1148,6 @@ class SafetyCaseSpec(DyffSchemaBaseModel):
     )
 
 
-class SafetyCase(DyffEntity, SafetyCaseSpec, AnalysisOutputQueryFields):
-    kind: Literal["SafetyCase"] = Entities.SafetyCase.value
-
-    def dependencies(self) -> list[str]:
-        return [self.analysis]
-
-    def resource_allocation(self) -> Optional[ResourceAllocation]:
-        return None
-
-
 class MethodImplementationKind(str, enum.Enum):
     JupyterNotebook = "JupyterNotebook"
     PythonFunction = "PythonFunction"
@@ -1277,9 +1257,19 @@ class MethodOutput(DyffSchemaBaseModel):
     )
 
 
+class MethodScope(str, enum.Enum):
+    InferenceService = Entities.InferenceService.value
+    Evaluation = Entities.Evaluation.value
+
+
 class MethodBase(DyffSchemaBaseModel):
     name: str = pydantic.Field(description="Descriptive name of the Method.")
 
+    scope: MethodScope = pydantic.Field(
+        description="The scope of the Method. The Method produces outputs that"
+        " are specific to one entity of the type specified in the .scope field."
+    )
+
     description: Optional[str] = pydantic.Field(
         default=None, description="Long-form description, interpreted as Markdown."
     )
@@ -1318,12 +1308,6 @@ class Method(DyffEntity, MethodBase):
         return None
 
 
-AnalysisOutputType = Union[
-    Measurement,
-    SafetyCase,
-]
-
-
 class AnalysisInput(DyffSchemaBaseModel):
     keyword: str = pydantic.Field(
         description="The 'keyword' specified for this input in the MethodSpec."
@@ -1347,7 +1331,19 @@ class ForeignMethod(DyffModelWithID, MethodBase):
     pass
 
 
+class AnalysisScope(DyffSchemaBaseModel):
+    dataset: Optional[str]
+    inferenceService: Optional[str]
+    evaluation: Optional[str]
+    model: Optional[str]
+
+
 class AnalysisBase(DyffSchemaBaseModel):
+    scope: AnalysisScope = pydantic.Field(
+        description="The specific entities to which the analysis results apply."
+        " At a minimum, the field corresponding to method.scope must be set."
+    )
+
     arguments: list[AnalysisArgument] = pydantic.Field(
         default_factory=list,
         description="Arguments to pass to the Method implementation.",
@@ -1358,13 +1354,15 @@ class AnalysisBase(DyffSchemaBaseModel):
     )
 
 
-class Analysis(DyffEntity, AnalysisBase):
-    kind: Literal["Analysis"] = Entities.Analysis.value
-
+class Analysis(AnalysisBase):
     method: ForeignMethod = pydantic.Field(
         description="The analysis Method to run.",
     )
 
+
+class Measurement(DyffEntity, MeasurementSpec, Analysis):
+    kind: Literal["Measurement"] = Entities.Measurement.value
+
     def dependencies(self) -> list[str]:
         return [self.method.id] + [x.entity for x in self.inputs]
 
@@ -1372,11 +1370,35 @@ class Analysis(DyffEntity, AnalysisBase):
         return None
 
 
-class AnalysisAndOutputs(DyffSchemaBaseModel):
-    analysis: Analysis = pydantic.Field(description="The Analysis entity")
-    outputs: list[AnalysisOutputType] = pydantic.Field(
-        description="Concrete outputs of the Analysis"
-    )
+class SafetyCase(DyffEntity, SafetyCaseSpec, Analysis):
+    kind: Literal["SafetyCase"] = Entities.SafetyCase.value
+
+    def dependencies(self) -> list[str]:
+        return [self.method.id] + [x.entity for x in self.inputs]
+
+    def resource_allocation(self) -> Optional[ResourceAllocation]:
+        return None
+
+
+# class Analysis(DyffEntity, AnalysisBase):
+#     kind: Literal["Analysis"] = Entities.Analysis.value
+
+#     method: ForeignMethod = pydantic.Field(
+#         description="The analysis Method to run.",
+#     )
+
+#     def dependencies(self) -> list[str]:
+#         return [self.method.id] + [x.entity for x in self.inputs]
+
+#     def resource_allocation(self) -> Optional[ResourceAllocation]:
+#         return None
+
+
+# class AnalysisAndOutputs(DyffSchemaBaseModel):
+#     analysis: Analysis = pydantic.Field(description="The Analysis entity")
+#     outputs: list[AnalysisOutputType] = pydantic.Field(
+#         description="Concrete outputs of the Analysis"
+#     )
 
 
 # ---------------------------------------------------------------------------
@@ -1642,7 +1664,6 @@ def entity_class(kind: Entities):
 
 
 DyffEntityType = Union[
-    Analysis,
     Audit,
     AuditProcedure,
     DataSource,
@@ -1664,12 +1685,10 @@ __all__ = [
     "AcceleratorGPU",
     "AccessGrant",
     "Analysis",
-    "AnalysisAndOutputs",
     "AnalysisArgument",
     "AnalysisBase",
     "AnalysisInput",
     "AnalysisOutputQueryFields",
-    "AnalysisOutputType",
     "Annotation",
     "APIFunctions",
     "APIKey",
@@ -1695,6 +1714,7 @@ __all__ = [
     "EvaluationBase",
     "ExtractorStep",
     "ForeignInferenceService",
+    "ForeignMethod",
     "ForeignModel",
     "Frameworks",
     "InferenceInterface",
@@ -1728,6 +1748,7 @@ __all__ = [
     "MethodOutput",
     "MethodOutputKind",
     "MethodParameter",
+    "MethodScope",
     "Model",
     "ModelArtifact",
     "ModelArtifactHuggingFaceCache",

{dyff-schema-0.3.5 → dyff-schema-0.3.7/dyff_schema.egg-info}/PKG-INFO

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