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

{dyff-schema-0.3.4/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.4
+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.4 → dyff-schema-0.3.7}/dyff/schema/v0/r1/platform.py

@@ -1114,27 +1114,18 @@ class MeasurementLevel(str, enum.Enum):
 
 
 class AnalysisOutputQueryFields(DyffSchemaBaseModel):
-    method: QueryableDyffEntity = pydantic.Field(
-        description="Identifying information about the Method that was run to produce the output."
-    )
-
-    dataset: Optional[QueryableDyffEntity] = pydantic.Field(
+    analysis: str = pydantic.Field(
         default=None,
-        description="Identifying information about the Dataset being analyzed, if applicable.",
+        description="ID of the Analysis that produced the output.",
     )
 
-    evaluation: Optional[str] = pydantic.Field(
-        default=None,
-        description="ID of the Evaluation being analyzed, if applicable.",
+    method: QueryableDyffEntity = pydantic.Field(
+        description="Identifying information about the Method that was run to produce the output."
     )
 
-    inferenceService: Optional[QueryableDyffEntity] = pydantic.Field(
+    inputs: list[str] = pydantic.Field(
         default=None,
-        description="Identifying information about the InferenceService being analyzed, if applicable.",
-    )
-
-    model: Optional[QueryableDyffEntity] = pydantic.Field(
-        description="Identifying information about the Model being analyzed, if applicable",
+        description="IDs of resources that were inputs to the Analysis.",
     )
 
 
@@ -1150,16 +1141,6 @@ class MeasurementSpec(DyffSchemaBaseModel):
     )
 
 
-class Measurement(DyffEntity, MeasurementSpec, AnalysisOutputQueryFields):
-    kind: Literal["Measurement"] = Entities.Measurement.value
-
-    def dependencies(self) -> list[str]:
-        return []
-
-    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(
@@ -1167,16 +1148,6 @@ class SafetyCaseSpec(DyffSchemaBaseModel):
     )
 
 
-class SafetyCase(DyffEntity, SafetyCaseSpec, AnalysisOutputQueryFields):
-    kind: Literal["SafetyCase"] = Entities.SafetyCase.value
-
-    def dependencies(self) -> list[str]:
-        return []
-
-    def resource_allocation(self) -> Optional[ResourceAllocation]:
-        return None
-
-
 class MethodImplementationKind(str, enum.Enum):
     JupyterNotebook = "JupyterNotebook"
     PythonFunction = "PythonFunction"
@@ -1286,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."
     )
@@ -1327,7 +1308,7 @@ class Method(DyffEntity, MethodBase):
         return None
 
 
-class AnalysisInputMapping(DyffSchemaBaseModel):
+class AnalysisInput(DyffSchemaBaseModel):
     keyword: str = pydantic.Field(
         description="The 'keyword' specified for this input in the MethodSpec."
     )
@@ -1350,24 +1331,48 @@ 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.",
     )
 
-    inputs: list[AnalysisInputMapping] = pydantic.Field(
+    inputs: list[AnalysisInput] = pydantic.Field(
         default_factory=list, description="Mapping of keywords to data entities."
     )
 
 
-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]
+
+    def resource_allocation(self) -> Optional[ResourceAllocation]:
+        return None
+
+
+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]
 
@@ -1375,6 +1380,27 @@ class Analysis(DyffEntity, AnalysisBase):
         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"
+#     )
+
+
 # ---------------------------------------------------------------------------
 # Status enumerations
 
@@ -1638,7 +1664,6 @@ def entity_class(kind: Entities):
 
 
 DyffEntityType = Union[
-    Analysis,
     Audit,
     AuditProcedure,
     DataSource,
@@ -1662,7 +1687,7 @@ __all__ = [
     "Analysis",
     "AnalysisArgument",
     "AnalysisBase",
-    "AnalysisInputMapping",
+    "AnalysisInput",
     "AnalysisOutputQueryFields",
     "Annotation",
     "APIFunctions",
@@ -1689,6 +1714,7 @@ __all__ = [
     "EvaluationBase",
     "ExtractorStep",
     "ForeignInferenceService",
+    "ForeignMethod",
     "ForeignModel",
     "Frameworks",
     "InferenceInterface",
@@ -1722,6 +1748,7 @@ __all__ = [
     "MethodOutput",
     "MethodOutputKind",
     "MethodParameter",
+    "MethodScope",
     "Model",
     "ModelArtifact",
     "ModelArtifactHuggingFaceCache",

{dyff-schema-0.3.4 → dyff-schema-0.3.7}/dyff/schema/v0/r1/requests.py

@@ -131,21 +131,17 @@ class DyffEntityQueryRequest(DyffSchemaBaseModel):
 
 
 class _AnalysisProductQueryRequest(DyffEntityQueryRequest):
-    dataset: Optional[str] = pydantic.Field(default=None)
-    datasetName: Optional[str] = pydantic.Field(default=None)
-    evaluation: Optional[str] = pydantic.Field(default=None)
-    inferenceService: Optional[str] = pydantic.Field(default=None)
-    inferenceServiceName: 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)
-    model: Optional[str] = pydantic.Field(default=None)
-    modelName: Optional[str] = pydantic.Field(default=None)
+    inputsAnyOf: Optional[str] = pydantic.Field(default=None)
 
 
 class AnalysisQueryRequest(DyffEntityQueryRequest):
     method: Optional[str] = pydantic.Field(default=None)
     methodName: Optional[str] = pydantic.Field(default=None)
     methodOutputKind: Optional[str] = pydantic.Field(default=None)
+    inputsAnyOf: Optional[str] = pydantic.Field(default=None)
 
 
 class AuditQueryRequest(DyffEntityQueryRequest):

{dyff-schema-0.3.4 → 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.4
+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