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

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

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

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

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

@@ -1732,8 +1732,6 @@ 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.",
@@ -2255,8 +2253,6 @@ class AnalysisBase(DyffSchemaBaseModel):
 
 
 class AnalysisRequestBase(AnalysisBase):
-    kind: Literal["AnalysisRequest"] = "AnalysisRequest"
-
     method: EntityIDField = pydantic.Field(description="Method ID")
 
 
@@ -2765,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[
-    AnalysisRequestBase,
-    EvaluationRequestBase,
+    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."
     )
@@ -2779,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"
@@ -2797,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(),
     )
 
 
@@ -2818,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
@@ -3371,10 +3395,13 @@ __all__ = [
     "OCIArtifact",
     "Pipeline",
     "PipelineBase",
+    "PipelineEvaluationRequest",
+    "PipelineMeasurementRequest",
     "PipelineNode",
     "PipelineParameter",
     "PipelineRun",
     "PipelineRunBase",
+    "PipelineSafetyCaseRequest",
     "QueryableDyffEntity",
     "Report",
     "ReportBase",

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

@@ -19,11 +19,10 @@ from datetime import datetime
 from typing import Any, Literal, Optional, Union
 
 import pydantic
-from typing_extensions import TypeAlias
 
 from ... import upcast
 from . import commands
-from .base import DyffBaseModel, DyffSchemaBaseModel, JsonMergePatchSemantics
+from .base import DyffBaseModel, JsonMergePatchSemantics
 from .platform import (
     AnalysisRequestBase,
     AnalysisScope,

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

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

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