dyff-schema 0.5.1__tar.gz → 0.6.0__tar.gz

{dyff_schema-0.5.1 → dyff_schema-0.6.0}/.gitlab-ci.yml

@@ -20,7 +20,7 @@ include:
     file:
       - prettier.yml
   - project: buildgarden/pipelines/python
-    ref: 0.9.1
+    ref: 0.10.0
     file:
       - python-autoflake.yml
       - python-black.yml

{dyff_schema-0.5.1/dyff_schema.egg-info → dyff_schema-0.6.0}/PKG-INFO

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

@@ -1097,6 +1097,16 @@ class InferenceSessionAndToken(DyffSchemaBaseModel):
     token: str
 
 
+class InferenceSessionReference(DyffSchemaBaseModel):
+    session: str = pydantic.Field(
+        description="The ID of a running inference session.",
+    )
+
+    interface: InferenceInterface = pydantic.Field(
+        description="How to move data in and out of the service."
+    )
+
+
 class DatasetFilter(DyffSchemaBaseModel):
     """A rule for restrcting which instances in a Dataset are returned."""
 
@@ -1134,10 +1144,20 @@ class Evaluation(DyffEntity, EvaluationBase):
     kind: Literal["Evaluation"] = Entities.Evaluation.value
 
     inferenceSession: InferenceSessionSpec = pydantic.Field(
-        description="Specification of the InferenceSession that will perform inference for the evaluation.",
+        description="Specification of the InferenceSession that will perform"
+        " inference for the evaluation.",
+    )
+
+    inferenceSessionReference: Optional[str] = pydantic.Field(
+        default=None,
+        description="ID of a running inference session that will be used"
+        " for the evaluation instead of starting a new one.",
     )
 
     def dependencies(self) -> list[str]:
+        # TODO: It would be nice if the session could be a dependency,
+        # so that the client doesn't start until the session is ready, but
+        # dyff-orchestrator can't handle dependencies on sessions currently.
         return [self.dataset, self.inferenceSession.inferenceService.id]
 
     def resource_allocation(self) -> Optional[ResourceAllocation]:
@@ -1867,6 +1887,7 @@ __all__ = [
     "InferenceSession",
     "InferenceSessionAndToken",
     "InferenceSessionBase",
+    "InferenceSessionReference",
     "InferenceSessionSpec",
     "Label",
     "LabelKey",

{dyff_schema-0.5.1 → dyff_schema-0.6.0}/dyff/schema/v0/r1/requests.py

@@ -73,10 +73,27 @@ class EvaluationCreateRequest(DyffEntityCreateRequest, EvaluationBase):
     """A description of how to run an InferenceService on a Dataset to obtain a set of
     evaluation results."""
 
-    inferenceSession: EvaluationInferenceSessionRequest = pydantic.Field(
+    inferenceSession: Optional[EvaluationInferenceSessionRequest] = pydantic.Field(
+        default=None,
         description="Specification of the InferenceSession that will perform inference for the evaluation.",
     )
 
+    inferenceSessionReference: Optional[str] = pydantic.Field(
+        default=None,
+        description="The ID of a running inference session that will be used"
+        " for the evaluation, instead of starting a new one.",
+    )
+
+    @pydantic.root_validator
+    def check_session_exactly_one(cls, values):
+        session = values.get("inferenceSession") is not None
+        session_ref = values.get("inferenceSessionReference") is not None
+        if not (session ^ session_ref):
+            raise ValueError(
+                "must specify exactly one of {inferenceSession, inferenceSessionReference}"
+            )
+        return values
+
 
 class MethodCreateRequest(DyffEntityCreateRequest, MethodBase):
     pass
@@ -141,16 +158,12 @@ class DyffEntityQueryRequest(DyffSchemaBaseModel):
 
 
 class _AnalysisProductQueryRequest(DyffEntityQueryRequest):
-    analysis: Optional[str] = pydantic.Field(default=None)
-    method: Optional[str] = pydantic.Field(default=None)
-    methodName: 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)
+    dataset: Optional[str] = pydantic.Field(default=None)
+    evaluation: Optional[str] = pydantic.Field(default=None)
+    inferenceService: Optional[str] = pydantic.Field(default=None)
+    model: Optional[str] = pydantic.Field(default=None)
     inputsAnyOf: Optional[str] = pydantic.Field(default=None)
 
 
@@ -215,7 +228,6 @@ class SafetyCaseQueryRequest(_AnalysisProductQueryRequest):
 
 __all__ = [
     "AnalysisCreateRequest",
-    "AnalysisQueryRequest",
     "AuditQueryRequest",
     "DyffEntityCreateRequest",
     "DyffEntityQueryRequest",

{dyff_schema-0.5.1 → dyff_schema-0.6.0/dyff_schema.egg-info}/PKG-INFO

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