dyff-schema 0.36.9__tar.gz → 0.37.0__tar.gz

{dyff_schema-0.36.9/dyff_schema.egg-info → dyff_schema-0.37.0}/PKG-INFO

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

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

{dyff_schema-0.36.9 → dyff_schema-0.37.0}/dyff/schema/v0/r1/commands.py

@@ -218,9 +218,6 @@ class ChallengeTaskRulesExecutionEnvironmentPatch(JsonMergePatchSemantics):
     choices: dict[str, Optional[ChallengeTaskExecutionEnvironment]] = pydantic.Field(
         default_factory=dict, description="Execution environment choices."
     )
-    default: Optional[str] = pydantic.Field(
-        default=None, description="The default execution environment."
-    )
 
 
 class ChallengeTaskRulesSchedulePatch(JsonMergePatchSemantics):
@@ -257,11 +254,7 @@ class ChallengeTaskRulesSchedulePatch(JsonMergePatchSemantics):
 
 
 class ChallengeTaskRulesPatch(DyffSchemaBaseModel):
-    """Same properties as ChallengeTaskRules, but assigning None to a field is
-    interpreted as a command to delete that field.
-
-    Fields that are not assigned explicitly remain unchanged.
-    """
+    """Edits to make to the different rules categories."""
 
     executionEnvironment: ChallengeTaskRulesExecutionEnvironmentPatch = pydantic.Field(
         default_factory=ChallengeTaskRulesExecutionEnvironmentPatch,
@@ -289,10 +282,18 @@ class ChallengeTaskRulesPatch(DyffSchemaBaseModel):
         return schedule.model_dump(mode=_info.mode)
 
 
+class EditChallengeTaskRulesPatch(DyffSchemaBaseModel):
+    """A Json Merge Patch for the rules of one task."""
+
+    rules: ChallengeTaskRulesPatch = pydantic.Field(
+        description="Edits to make to the task rules."
+    )
+
+
 class EditChallengeTaskRulesAttributes(DyffSchemaBaseModel):
     """Attributes for the EditChallengeTaskRules command."""
 
-    rules: ChallengeTaskRulesPatch = pydantic.Field(
+    tasks: dict[str, EditChallengeTaskRulesPatch] = pydantic.Field(
         description="Edits to make to the task rules."
     )
 
@@ -612,9 +613,10 @@ __all__ = [
     "EditChallengeContentAttributes",
     "EditChallengeContentData",
     "EditChallengeContentPatch",
+    "EditChallengeTaskRules",
     "EditChallengeTaskRulesAttributes",
     "EditChallengeTaskRulesData",
-    "EditChallengeTaskRules",
+    "EditChallengeTaskRulesPatch",
     "EditEntityDocumentation",
     "EditEntityDocumentationAttributes",
     "EditEntityDocumentationData",

{dyff_schema-0.36.9 → dyff_schema-0.37.0}/dyff/schema/v0/r1/platform.py

@@ -19,13 +19,24 @@ We use the following naming convention:
 
 # fmt: on
 # mypy: disable-error-code="import-untyped"
+from __future__ import annotations
+
 import abc
 import enum
 import urllib.parse
 from datetime import datetime, timedelta, timezone
 from enum import Enum
 from pathlib import Path
-from typing import Any, Literal, NamedTuple, Optional, Type, TypeVar, Union
+from typing import (
+    TYPE_CHECKING,
+    Any,
+    Literal,
+    NamedTuple,
+    Optional,
+    Type,
+    TypeVar,
+    Union,
+)
 
 import i18naddress
 import pyarrow
@@ -40,6 +51,12 @@ 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"])
 
 
@@ -219,6 +236,8 @@ class Entities(str, enum.Enum):
     Method = "Method"
     Model = "Model"
     Module = "Module"
+    Pipeline = "Pipeline"
+    PipelineRun = "PipelineRun"
     Report = "Report"
     Revision = "Revision"
     SafetyCase = "SafetyCase"
@@ -258,6 +277,8 @@ class Resources(str, enum.Enum):
     Method = "methods"
     Model = "models"
     Module = "modules"
+    Pipeline = "pipelines"
+    PipelineRun = "pipelineruns"
     Report = "reports"
     Revision = "revisions"
     SafetyCase = "safetycases"
@@ -309,6 +330,8 @@ EntityKindLiteral = Literal[
     "Module",
     # FIXME: (schema v1) Rename to Artifact
     "OCIArtifact",
+    "Pipeline",
+    "PipelineRun",
     "Report",
     "Revision",
     "SafetyCase",
@@ -539,6 +562,8 @@ class DyffEntity(Status, Labeled, SchemaVersion, DyffModelWithID):
         "Module",
         # FIXME: (schema v1) Rename to Artifact
         "OCIArtifact",
+        "Pipeline",
+        "PipelineRun",
         "Report",
         "Revision",
         "SafetyCase",
@@ -2706,6 +2731,98 @@ class ChallengeSubmission(DyffEntity):
         return None
 
 
+# ---------------------------------------------------------------------------
+# Pipelines
+
+PipelineNodeRequest: TypeAlias = Union[
+    "AnalysisCreateRequest",
+    "EvaluationCreateRequest",
+]
+
+
+class PipelineNode(DyffSchemaBaseModel):
+    name: str = pydantic.Field(
+        description="The name of the node. Must be unique in the context of the pipeline."
+    )
+
+    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'
+        " 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"
+        " dependency graph structure from these placeholders.",
+    )
+
+
+class PipelineParameter(DyffSchemaBaseModel):
+    """Declares a parameter that can be passed to the pipeline to customize its
+    behavior."""
+
+    keyword: str = pydantic.Field(description="The keyword of the argument.")
+    destination: str = pydantic.Field(
+        description="The field in a pipeline node to substitute with the"
+        " parameter value. Should be a string like 'node_name.field1.field2'."
+    )
+    description: Optional[str] = pydantic.Field(
+        default=None, description="A description of the argument."
+    )
+
+
+class PipelineBase(DyffSchemaBaseModel):
+    name: str = pydantic.Field(description="The name of the Pipeline.")
+    nodes: dict[str, PipelineNode] = pydantic.Field(
+        description="The nodes in the pipeline graph.",
+        min_length=1,
+    )
+
+    @pydantic.field_validator("nodes", mode="after")
+    def validate_node_names_match(cls, nodes: dict[str, PipelineNode]):
+        for k, v in nodes.items():
+            if k != v.name:
+                raise ValueError(f"nodes[{k}]: dict key must match value.name")
+
+
+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
+    have a graph structure like ``evaluation -> safetycase``.
+    """
+
+    kind: Literal["Pipeline"] = Entities.Pipeline.value
+
+    def dependencies(self) -> list[str]:
+        return []
+
+    def resource_allocation(self) -> Optional[ResourceAllocation]:
+        return None
+
+
+class PipelineRunBase(DyffSchemaBaseModel):
+    """A pipeline run is an execution of a pipeline."""
+
+    pipeline: str = pydantic.Field(description="The ID of the pipeline that was run.")
+    arguments: dict[str, pydantic.JsonValue] = pydantic.Field(
+        default_factory=dict,
+        description="The arguments to pass to the pipeline.",
+    )
+
+
+class PipelineRun(DyffEntity, PipelineRunBase):
+    kind: Literal["PipelineRun"] = Entities.PipelineRun.value
+
+    def dependencies(self) -> list[str]:
+        return [self.pipeline]
+
+    def resource_allocation(self) -> Optional[ResourceAllocation]:
+        return None
+
+
 # ---------------------------------------------------------------------------
 # Status enumerations
 
@@ -3210,6 +3327,12 @@ __all__ = [
     "Module",
     "ModuleBase",
     "OCIArtifact",
+    "Pipeline",
+    "PipelineBase",
+    "PipelineNode",
+    "PipelineNodeRequest",
+    "PipelineRun",
+    "PipelineRunBase",
     "QueryableDyffEntity",
     "Report",
     "ReportBase",

{dyff_schema-0.36.9 → dyff_schema-0.37.0}/dyff/schema/v0/r1/requests.py

@@ -42,6 +42,7 @@ from .platform import (
     MethodBase,
     ModelSpec,
     ModuleBase,
+    PipelineBase,
     ReportBase,
     TagNameType,
     TeamBase,
@@ -282,6 +283,19 @@ class ModuleCreateRequest(DyffEntityCreateRequest, ModuleBase):
     pass
 
 
+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 ReportCreateRequest(DyffEntityCreateRequest, ReportBase):
     """A Report transforms raw model outputs into some useful statistics.
 
@@ -541,6 +555,8 @@ __all__ = [
     "ModelQueryRequest",
     "ModuleCreateRequest",
     "ModuleQueryRequest",
+    "PipelineCreateRequest",
+    "PipelineRunRequest",
     "QueryRequest",
     "ReportCreateRequest",
     "ReportQueryRequest",

{dyff_schema-0.36.9 → dyff_schema-0.37.0/dyff_schema.egg-info}/PKG-INFO

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

@@ -1,2 +0,0 @@
-__version__ = version = "0.36.9"
-__version_tuple__ = version_tuple = (0, 36, 9)