dyff-schema 0.37.3__py3-none-any.whl → 0.38.1__py3-none-any.whl

dyff/schema/_version.py

@@ -1,2 +1,2 @@
-__version__ = version = "0.37.3"
-__version_tuple__ = version_tuple = (0, 37, 3)
+__version__ = version = "0.38.1"
+__version_tuple__ = version_tuple = (0, 38, 1)

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,39 @@ class EvaluationBase(DyffSchemaBaseModel):
     )
 
 
+class EvaluationRequestBase(EvaluationBase):
+    """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
+
+
 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 +2252,10 @@ class AnalysisBase(DyffSchemaBaseModel):
     )
 
 
+class AnalysisRequestBase(AnalysisBase):
+    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."""
@@ -2734,13 +2761,34 @@ class ChallengeSubmission(DyffEntity):
 # ---------------------------------------------------------------------------
 # Pipelines
 
+
+class PipelineEvaluationRequest(EvaluationRequestBase):
+    kind: Literal["PipelineEvaluationRequest"] = "PipelineEvaluationRequest"
+
+
+class PipelineMeasurementRequest(AnalysisRequestBase):
+    kind: Literal["PipelineMeasurementRequest"] = "PipelineMeasurementRequest"
+
+
+class PipelineSafetyCaseRequest(AnalysisRequestBase):
+    kind: Literal["PipelineSafetyCaseRequest"] = "PipelineSafetyCaseRequest"
+
+
 PipelineNodeRequest: TypeAlias = Union[
-    "AnalysisCreateRequest",
-    "EvaluationCreateRequest",
+    PipelineEvaluationRequest,
+    PipelineMeasurementRequest,
+    PipelineSafetyCaseRequest,
 ]
 
 
 class PipelineNode(DyffSchemaBaseModel):
+    """A node in the graph that defines the pipeline.
+
+    Each node contains a Dyff API request that might depend on the outcome of other
+    requests in the pipeline graph. When the pipeline runs, the requests are executed in
+    an order that respects these dependencies.
+    """
+
     name: str = pydantic.Field(
         description="The name of the node. Must be unique in the context of the pipeline."
     )
@@ -2748,7 +2796,7 @@ class PipelineNode(DyffSchemaBaseModel):
     request: PipelineNodeRequest = pydantic.Field(  # type: ignore[valid-type]
         discriminator="kind",
         description="The request template that will be executed when this node"
-        ' executes. You can use the syntax ``"$(node_name)"`` in request fields'
+        ' executes. You can use the syntax "$(node_name)" in request fields'
         " that reference another entity to indicate that the request depends"
         " on another node in the pipeline. The placeholder will be substituted"
         " with the ID of the created entity once it is known. Dyff infers the"
@@ -2766,7 +2814,9 @@ class PipelineParameter(DyffSchemaBaseModel):
         " parameter value. Should be a string like 'node_name.field1.field2'."
     )
     description: Optional[str] = pydantic.Field(
-        default=None, description="A description of the argument."
+        default=None,
+        description="A description of the argument.",
+        max_length=summary_maxlen(),
     )
 
 
@@ -2787,11 +2837,16 @@ class PipelineBase(DyffSchemaBaseModel):
 class Pipeline(DyffEntity, PipelineBase):
     """A set of Dyff workflows that can be executed as a group.
 
-    The pipeline
-    is a directed acyclic graph representing data dependencies between
-    workflows. For example, a simple pipeline might run an Evaluation and
-    then create a SafetyCase from the evaluation output. This pipeline would
+    The pipeline is a directed acyclic graph representing data dependencies
+    between workflows. For example, a simple pipeline might run an Evaluation
+    and then create a SafetyCase from the evaluation output. This pipeline would
     have a graph structure like ``evaluation -> safetycase``.
+
+    Each node in the pipeline contains the specification of a Dyff API request.
+    The request specifications may contain placeholders that reference other
+    nodes in the pipeline graph. When the pipeline is run, the nodes execute
+    in an order that respects their dependencies, and the placeholders are
+    replaced with concrete values once they are known.
     """
 
     kind: Literal["Pipeline"] = Entities.Pipeline.value
@@ -3085,8 +3140,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,
@@ -3218,6 +3271,7 @@ __all__ = [
     "AnalysisData",
     "AnalysisInput",
     "AnalysisOutputQueryFields",
+    "AnalysisRequestBase",
     "AnalysisScope",
     "Annotation",
     "APIFunctions",
@@ -3269,6 +3323,7 @@ __all__ = [
     "Evaluation",
     "EvaluationBase",
     "EvaluationClientConfiguration",
+    "EvaluationRequestBase",
     "ExtractorStep",
     "Family",
     "FamilyBase",
@@ -3340,10 +3395,13 @@ __all__ = [
     "OCIArtifact",
     "Pipeline",
     "PipelineBase",
+    "PipelineEvaluationRequest",
+    "PipelineMeasurementRequest",
     "PipelineNode",
-    "PipelineNodeRequest",
+    "PipelineParameter",
     "PipelineRun",
     "PipelineRunBase",
+    "PipelineSafetyCaseRequest",
     "QueryableDyffEntity",
     "Report",
     "ReportBase",

dyff/schema/v0/r1/requests.py

@@ -21,10 +21,10 @@ from typing import Any, Literal, Optional, Union
 import pydantic
 
 from ... import upcast
-from . import commands, oci
+from . import commands
 from .base import DyffBaseModel, JsonMergePatchSemantics
 from .platform import (
-    AnalysisBase,
+    AnalysisRequestBase,
     AnalysisScope,
     ChallengeContent,
     ChallengeTaskBase,
@@ -32,9 +32,9 @@ from .platform import (
     DatasetBase,
     DataView,
     DocumentationBase,
-    EntityIDField,
     Evaluation,
-    EvaluationBase,
+    EvaluationInferenceSessionRequest,
+    EvaluationRequestBase,
     FamilyBase,
     FamilyMemberBase,
     InferenceServiceBase,
@@ -43,6 +43,7 @@ from .platform import (
     ModelSpec,
     ModuleBase,
     PipelineBase,
+    PipelineRunBase,
     ReportBase,
     TagNameType,
     TeamBase,
@@ -112,12 +113,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 +213,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 +261,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.3.dist-info → dyff_schema-0.38.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dyff-schema
-Version: 0.37.3
+Version: 0.38.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.37.3.dist-info → dyff_schema-0.38.1.dist-info}/RECORD

@@ -1,5 +1,5 @@
 dyff/schema/__init__.py,sha256=w7OWDFuyGKd6xt_yllNtKzHahPgywrfU4Ue02psYaMA,2244
-dyff/schema/_version.py,sha256=5nPrqHGvMXylMNMttG621ra1SKLUs9wn6ubCYwxMf7g,80
+dyff/schema/_version.py,sha256=OAbKv7VQqg-KzyqDjyeWStot6XPBinPJdHJGJ1MwAw4,80
 dyff/schema/adapters.py,sha256=YMTHv_2VlLGFp-Kqwa6H51hjffHmk8gXjZilHysIF5Q,123
 dyff/schema/annotations.py,sha256=nE6Jk1PLqlShj8uqjE_EzZC9zYnTDW5AVtQcjysiK8M,10018
 dyff/schema/base.py,sha256=jvaNtsSZyFfsdUZTcY_U-yfLY5_GyrMxSXhON2R9XR0,119
@@ -29,8 +29,8 @@ dyff/schema/v0/r1/adapters.py,sha256=hpwCSW8lkMkUKCLe0zaMUDu-VS_caSxJvPsECEi_XRA
 dyff/schema/v0/r1/base.py,sha256=1VJXVLKldOq3aH2HdVgxXXk4DJTZEIiaTa4GzMKzziU,20228
 dyff/schema/v0/r1/commands.py,sha256=jqbEvDRLpcVGWXqlbniuSKg3UIjlrpKt6_0hiwUpPfQ,20153
 dyff/schema/v0/r1/oci.py,sha256=YjHDVBJ2IIxqijll70OK6pM-qT6pq8tvU7D3YB9vGM0,6700
-dyff/schema/v0/r1/platform.py,sha256=Ck6nHK-k-Lm90Gz-fpz_I_6bSFixR1NYkuPWHFfR6d8,108134
-dyff/schema/v0/r1/requests.py,sha256=-KaM1VjwaqZEI0zgexeyetQccrRX78x4WxHNIxQqJog,19483
+dyff/schema/v0/r1/platform.py,sha256=Slh548oqJhfTfriz62YRut3WriGgE4FfwflG5oMwkTM,110503
+dyff/schema/v0/r1/requests.py,sha256=JMpdx9WBlUpePshacG85XMmlGPBkkaK5453VaK3kH9s,18321
 dyff/schema/v0/r1/responses.py,sha256=nxy7FPtfw2B_bljz5UGGuSE79HTkDQxKH56AJVmd4Qo,1287
 dyff/schema/v0/r1/test.py,sha256=X6dUyVd5svcPCI-PBMOAqEfK9jv3bRDvkQTJzwS96c0,10720
 dyff/schema/v0/r1/version.py,sha256=NONebgcv5Thsw_ymud6PacZdGjV6ndBrmLnap-obcpo,428
@@ -43,9 +43,9 @@ dyff/schema/v0/r1/dataset/text.py,sha256=MYG5seGODDryRSCy-g0Unh5dD0HCytmZ3FeElC-
 dyff/schema/v0/r1/dataset/vision.py,sha256=tJFF4dkhHX0UXTj1sPW-G22xTSI40gbYO465FuvmvAU,443
 dyff/schema/v0/r1/io/__init__.py,sha256=L5y8UhRnojerPYHumsxQJRcHCNz8Hj9NM8b47mewMNs,92
 dyff/schema/v0/r1/io/vllm.py,sha256=vWyLg-susbg0JDfv6VExBpgFdU2GHP2a14ChOdbckvs,5321
-dyff_schema-0.37.3.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-dyff_schema-0.37.3.dist-info/licenses/NOTICE,sha256=YONACu0s_Ui6jNi-wtEsVQbTU1JIkh8wvLH6d1-Ni_w,43
-dyff_schema-0.37.3.dist-info/METADATA,sha256=nuB3G6pomcu9ApybN9hIRUMxmFluT4bhC0CUfVokj4U,3734
-dyff_schema-0.37.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-dyff_schema-0.37.3.dist-info/top_level.txt,sha256=9e3VVdeX73t_sUJOPQPCcGtYO1JhoErhHIi3WoWGcFI,5
-dyff_schema-0.37.3.dist-info/RECORD,,
+dyff_schema-0.38.1.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+dyff_schema-0.38.1.dist-info/licenses/NOTICE,sha256=YONACu0s_Ui6jNi-wtEsVQbTU1JIkh8wvLH6d1-Ni_w,43
+dyff_schema-0.38.1.dist-info/METADATA,sha256=LwpS_MihYVnxHSp9cuKFpjY72GTrHqgHuR5b7ztQM9Y,3734
+dyff_schema-0.38.1.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+dyff_schema-0.38.1.dist-info/top_level.txt,sha256=9e3VVdeX73t_sUJOPQPCcGtYO1JhoErhHIi3WoWGcFI,5
+dyff_schema-0.38.1.dist-info/RECORD,,