dyff-schema 0.37.2__tar.gz → 0.38.0__tar.gz

{dyff_schema-0.37.2/dyff_schema.egg-info → dyff_schema-0.38.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dyff-schema
-Version: 0.37.2
+Version: 0.38.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.38.0/dyff/schema/_version.py

@@ -0,0 +1,2 @@
+__version__ = version = "0.38.0"
+__version_tuple__ = version_tuple = (0, 38, 0)

{dyff_schema-0.37.2 → dyff_schema-0.38.0}/dyff/schema/v0/r1/platform.py

@@ -28,7 +28,6 @@ from datetime import datetime, timedelta, timezone
 from enum import Enum
 from pathlib import Path
 from typing import (
-    TYPE_CHECKING,
     Any,
     Literal,
     NamedTuple,
@@ -51,12 +50,6 @@ from .base import DyffSchemaBaseModel
 from .dataset import arrow, make_item_type, make_response_type
 from .version import SCHEMA_VERSION, SchemaVersion
 
-if TYPE_CHECKING:
-    from .requests import (
-        AnalysisCreateRequest,
-        EvaluationCreateRequest,
-    )
-
 SYSTEM_ATTRIBUTES = frozenset(["creationTime", "status", "reason"])
 
 
@@ -1712,6 +1705,10 @@ class EvaluationClientConfiguration(DyffSchemaBaseModel):
     )
 
 
+class EvaluationInferenceSessionRequest(InferenceSessionBase):
+    inferenceService: str = pydantic.Field(description="InferenceService ID")
+
+
 class EvaluationBase(DyffSchemaBaseModel):
     dataset: str = pydantic.Field(description="The Dataset to evaluate on.")
 
@@ -1731,13 +1728,41 @@ class EvaluationBase(DyffSchemaBaseModel):
     )
 
 
+class EvaluationRequestBase(EvaluationBase):
+    """A description of how to run an InferenceService on a Dataset to obtain a set of
+    evaluation results."""
+
+    kind: Literal["EvaluationRequest"] = "EvaluationRequest"
+
+    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.model_validator(mode="after")
+    def check_session_exactly_one(self):
+        session = self.inferenceSession is not None
+        session_ref = self.inferenceSessionReference is not None
+        if not (session ^ session_ref):
+            raise ValueError(
+                "must specify exactly one of {inferenceSession, inferenceSessionReference}"
+            )
+        return self
+
+
 class Evaluation(DyffEntity, EvaluationBase):
     """A description of how to run an InferenceService on a Dataset to obtain a set of
     evaluation results."""
 
     kind: Literal["Evaluation"] = Entities.Evaluation.value
 
-    inferenceSession: InferenceSessionSpec = pydantic.Field(
+    inferenceSession: InferenceSessionSpec = pydantic.Field(  # type: ignore[assignment]
         description="Specification of the InferenceSession that will perform"
         " inference for the evaluation.",
     )
@@ -2229,6 +2254,12 @@ class AnalysisBase(DyffSchemaBaseModel):
     )
 
 
+class AnalysisRequestBase(AnalysisBase):
+    kind: Literal["AnalysisRequest"] = "AnalysisRequest"
+
+    method: EntityIDField = pydantic.Field(description="Method ID")
+
+
 class AnalysisData(DyffSchemaBaseModel):
     """Arbitrary additional data for the Analysis, specified as a key-value pair where
     the value is the data encoded in base64."""
@@ -2735,8 +2766,8 @@ class ChallengeSubmission(DyffEntity):
 # Pipelines
 
 PipelineNodeRequest: TypeAlias = Union[
-    "AnalysisCreateRequest",
-    "EvaluationCreateRequest",
+    AnalysisRequestBase,
+    EvaluationRequestBase,
 ]
 
 
@@ -2816,6 +2847,11 @@ class PipelineRunBase(DyffSchemaBaseModel):
 class PipelineRun(DyffEntity, PipelineRunBase):
     kind: Literal["PipelineRun"] = Entities.PipelineRun.value
 
+    workflows: dict[str, EntityIdentifier] = pydantic.Field(
+        description="The concrete IDs of the workflows that were created as a"
+        " result of running the pipeline."
+    )
+
     def dependencies(self) -> list[str]:
         return [self.pipeline]
 
@@ -3080,8 +3116,6 @@ _ENTITY_CLASS = {
     Entities.Method: Method,
     Entities.Model: Model,
     Entities.Module: Module,
-    Entities.Pipeline: Pipeline,
-    Entities.PipelineRun: PipelineRun,
     Entities.Report: Report,
     Entities.SafetyCase: SafetyCase,
     Entities.Team: Team,
@@ -3213,6 +3247,7 @@ __all__ = [
     "AnalysisData",
     "AnalysisInput",
     "AnalysisOutputQueryFields",
+    "AnalysisRequestBase",
     "AnalysisScope",
     "Annotation",
     "APIFunctions",
@@ -3264,6 +3299,7 @@ __all__ = [
     "Evaluation",
     "EvaluationBase",
     "EvaluationClientConfiguration",
+    "EvaluationRequestBase",
     "ExtractorStep",
     "Family",
     "FamilyBase",
@@ -3336,7 +3372,7 @@ __all__ = [
     "Pipeline",
     "PipelineBase",
     "PipelineNode",
-    "PipelineNodeRequest",
+    "PipelineParameter",
     "PipelineRun",
     "PipelineRunBase",
     "QueryableDyffEntity",

{dyff_schema-0.37.2 → dyff_schema-0.38.0}/dyff/schema/v0/r1/requests.py

@@ -19,12 +19,13 @@ from datetime import datetime
 from typing import Any, Literal, Optional, Union
 
 import pydantic
+from typing_extensions import TypeAlias
 
 from ... import upcast
-from . import commands, oci
-from .base import DyffBaseModel, JsonMergePatchSemantics
+from . import commands
+from .base import DyffBaseModel, DyffSchemaBaseModel, JsonMergePatchSemantics
 from .platform import (
-    AnalysisBase,
+    AnalysisRequestBase,
     AnalysisScope,
     ChallengeContent,
     ChallengeTaskBase,
@@ -32,9 +33,9 @@ from .platform import (
     DatasetBase,
     DataView,
     DocumentationBase,
-    EntityIDField,
     Evaluation,
-    EvaluationBase,
+    EvaluationInferenceSessionRequest,
+    EvaluationRequestBase,
     FamilyBase,
     FamilyMemberBase,
     InferenceServiceBase,
@@ -43,6 +44,7 @@ from .platform import (
     ModelSpec,
     ModuleBase,
     PipelineBase,
+    PipelineRunBase,
     ReportBase,
     TagNameType,
     TeamBase,
@@ -112,12 +114,10 @@ class DyffEntityCreateRequest(DyffRequestBase):
     account: str = pydantic.Field(description="Account that owns the entity")
 
 
-class AnalysisCreateRequest(DyffEntityCreateRequest, AnalysisBase):
+class AnalysisCreateRequest(DyffEntityCreateRequest, AnalysisRequestBase):
     """An Analysis transforms Datasets, Evaluations, and Measurements into new
     Measurements or SafetyCases."""
 
-    method: EntityIDField = pydantic.Field(description="Method ID")
-
     @pydantic.field_validator("scope", check_fields=False)
     def _validate_scope(cls, scope: AnalysisScope) -> AnalysisScope:
         # TODO: This has to be a validator function because we can't apply the
@@ -214,40 +214,15 @@ class InferenceSessionTokenCreateRequest(DyffRequestBase):
     )
 
 
-class EvaluationInferenceSessionRequest(InferenceSessionBase):
-    inferenceService: str = pydantic.Field(description="InferenceService ID")
-
-
-class EvaluationCreateRequest(DyffEntityCreateRequest, EvaluationBase):
+class EvaluationCreateRequest(DyffEntityCreateRequest, EvaluationRequestBase):
     """A description of how to run an InferenceService on a Dataset to obtain a set of
     evaluation results."""
 
-    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.model_validator(mode="after")
-    def check_session_exactly_one(self):
-        session = self.inferenceSession is not None
-        session_ref = self.inferenceSessionReference is not None
-        if not (session ^ session_ref):
-            raise ValueError(
-                "must specify exactly one of {inferenceSession, inferenceSessionReference}"
-            )
-        return self
-
     @staticmethod
     def repeat_of(evaluation: Evaluation) -> EvaluationCreateRequest:
         """Return a request that will run an existing Evaluation again with the same
         configuration."""
-        base = upcast(EvaluationBase, evaluation)
+        base = upcast(EvaluationRequestBase, evaluation)
         if evaluation.inferenceSessionReference:
             return EvaluationCreateRequest(
                 account=evaluation.account,
@@ -287,13 +262,8 @@ class PipelineCreateRequest(DyffEntityCreateRequest, PipelineBase):
     pass
 
 
-class PipelineRunRequest(DyffRequestBase):
-    """A request to run a pipeline."""
-
-    arguments: dict[str, pydantic.JsonValue] = pydantic.Field(
-        default_factory=dict,
-        description="Arguments to pass to the pipeline run.",
-    )
+class PipelineRunRequest(DyffEntityCreateRequest, PipelineRunBase):
+    pass
 
 
 class ReportCreateRequest(DyffEntityCreateRequest, ReportBase):

{dyff_schema-0.37.2 → dyff_schema-0.38.0/dyff_schema.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dyff-schema
-Version: 0.37.2
+Version: 0.38.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.37.2/dyff/schema/_version.py

@@ -1,2 +0,0 @@
-__version__ = version = "0.37.2"
-__version_tuple__ = version_tuple = (0, 37, 2)