dyff-schema 0.38.5__tar.gz → 0.38.12__tar.gz

{dyff_schema-0.38.5/dyff_schema.egg-info → dyff_schema-0.38.12}/PKG-INFO

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

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

{dyff_schema-0.38.5 → dyff_schema-0.38.12}/dyff/schema/v0/r1/platform.py

@@ -2656,6 +2656,18 @@ class ChallengeTaskContent(DyffSchemaBaseModel):
     )
 
 
+class ChallengeSubmissionStructure(DyffSchemaBaseModel):
+    submissionKind: EntityKindLiteral = pydantic.Field(
+        default=Entities.InferenceService.value,
+        description="The kind of entity that you can submit to this task.",
+    )
+    pipelineKeyword: str = pydantic.Field(
+        default="submission",
+        description="The keyword parameter where the submitted entity ID"
+        " should be passed to the assessment Pipeline.",
+    )
+
+
 class ChallengeTaskBase(DyffSchemaBaseModel):
     """The part of the ChallengeTask spec that is not system-populated."""
 
@@ -2669,7 +2681,11 @@ class ChallengeTaskBase(DyffSchemaBaseModel):
         pattern=r"[a-z0-9-]*",
     )
     assessment: str = pydantic.Field(
-        description="ID of the Assessment that the task runs."
+        description="ID of the Pipeline used to assess the submission."
+    )
+    submissionStructure: ChallengeSubmissionStructure = pydantic.Field(
+        default_factory=ChallengeSubmissionStructure,
+        description="How to run the assessment pipeline on a new submission.",
     )
     rules: ChallengeTaskRules = pydantic.Field(description="The rules for submissions.")
     content: ChallengeTaskContent = pydantic.Field(
@@ -2729,7 +2745,14 @@ class Challenge(DyffEntity):
         return None
 
 
-class ChallengeSubmission(DyffEntity):
+class ChallengeSubmissionBase(DyffSchemaBaseModel):
+    team: str = pydantic.Field(description="The ID of the team making the submission.")
+    submission: EntityIdentifier = pydantic.Field(
+        description="The resource being submitted for assessment."
+    )
+
+
+class ChallengeSubmission(DyffEntity, ChallengeSubmissionBase):
     """A submission of an inference system to a challenge by a team.
 
     All of the constituent resources must already exist. Creating a Submission simply
@@ -2746,9 +2769,8 @@ class ChallengeSubmission(DyffEntity):
     task: str = pydantic.Field(
         description="The key of the task within the challenge being submitted to."
     )
-    team: str = pydantic.Field(description="The ID of the team making the submission.")
-    inferenceService: str = pydantic.Field(
-        description="The ID of the inference service being submitted."
+    pipelineRun: str = pydantic.Field(
+        description="The ID of the PipelineRun for this submission."
     )
 
     def dependencies(self) -> list[str]:
@@ -2765,14 +2787,33 @@ class ChallengeSubmission(DyffEntity):
 class PipelineEvaluationRequest(EvaluationRequestBase):
     kind: Literal["PipelineEvaluationRequest"] = "PipelineEvaluationRequest"
 
+    def dependencies(self) -> list[str]:
+        if self.inferenceSession is None:
+            raise AssertionError()
+        return [self.dataset, self.inferenceSession.inferenceService]
+
+    @pydantic.model_validator(mode="after")
+    def check_session_not_reference(self):
+        if self.inferenceSession is None or self.inferenceSessionReference is not None:
+            raise ValueError(
+                "evaluations in pipelines must set inferenceSession, not inferenceSessionReference"
+            )
+        return self
+
 
 class PipelineMeasurementRequest(AnalysisRequestBase):
     kind: Literal["PipelineMeasurementRequest"] = "PipelineMeasurementRequest"
 
+    def dependencies(self) -> list[str]:
+        return [self.method] + [x.entity for x in self.inputs]
+
 
 class PipelineSafetyCaseRequest(AnalysisRequestBase):
     kind: Literal["PipelineSafetyCaseRequest"] = "PipelineSafetyCaseRequest"
 
+    def dependencies(self) -> list[str]:
+        return [self.method] + [x.entity for x in self.inputs]
+
 
 PipelineNodeRequest = Union[
     PipelineEvaluationRequest,
@@ -2814,16 +2855,25 @@ class PipelineNode(DyffSchemaBaseModel):
 
 class PipelineParameter(DyffSchemaBaseModel):
     """Declares a parameter that can be passed to the pipeline to customize its
-    behavior."""
+    behavior.
 
-    keyword: str = pydantic.Field(description="The keyword of the argument.")
-    destination: str = pydantic.Field(
+    By default, the argument will be substituted for the placeholder value
+    ``$(keyword)``, where ``keyword`` is the ``.keyword`` property of the
+    parameter. In this case, the value of the argument must be a string.
+
+    If ``.destination`` is specified, the argument will instead overwrite
+    the value at the specified JSON path.
+    """
+
+    keyword: str = pydantic.Field(description="The keyword of the parameter.")
+    destination: Optional[str] = pydantic.Field(
+        default=None,
         description="The field in a pipeline node to substitute with the"
-        " parameter value. Should be a string like 'node_name.field1.field2'."
+        " parameter value. Should be a string like 'node_name.field1.field2'.",
     )
     description: Optional[str] = pydantic.Field(
         default=None,
-        description="A description of the argument.",
+        description="A description of the parameter.",
         max_length=summary_maxlen(),
     )
 
@@ -2834,6 +2884,10 @@ class PipelineBase(DyffSchemaBaseModel):
         description="The nodes in the pipeline graph.",
         min_length=1,
     )
+    parameters: dict[str, PipelineParameter] = pydantic.Field(
+        default_factory=dict,
+        description="Input parameters used to customize the pipeline.",
+    )
 
     @pydantic.field_validator("nodes", mode="after")
     def validate_node_names_match(cls, nodes: dict[str, PipelineNode]):
@@ -2842,6 +2896,15 @@ class PipelineBase(DyffSchemaBaseModel):
                 raise ValueError(f"nodes[{k}]: dict key must match value.name")
         return nodes
 
+    @pydantic.field_validator("parameters", mode="after")
+    def validate_parameter_keywords_match(
+        cls, parameters: dict[str, PipelineParameter]
+    ):
+        for k, v in parameters.items():
+            if k != v.keyword:
+                raise ValueError(f"parameters[{k}]: dict key must match value.keyword")
+        return parameters
+
 
 class Pipeline(DyffEntity, PipelineBase):
     """A set of Dyff workflows that can be executed as a group.
@@ -3144,6 +3207,7 @@ _DyffEntityTypeRevisable = Union[
     Audit,
     AuditProcedure,
     Challenge,
+    ChallengeSubmission,
     DataSource,
     Dataset,
     Evaluation,
@@ -3239,6 +3303,7 @@ _ENTITY_CLASS: dict[Entities, type[DyffEntityType]] = {
     Entities.Report: Report,
     Entities.Revision: Revision,
     Entities.SafetyCase: SafetyCase,
+    Entities.Submission: ChallengeSubmission,
     Entities.Team: Team,
     Entities.UseCase: UseCase,
 }
@@ -3254,6 +3319,7 @@ DyffEntityT = TypeVar(
     Audit,
     AuditProcedure,
     Challenge,
+    ChallengeSubmission,
     DataSource,
     Dataset,
     Evaluation,
@@ -3304,6 +3370,8 @@ __all__ = [
     "ChallengeContent",
     "ChallengeContentPage",
     "ChallengeSubmission",
+    "ChallengeSubmissionBase",
+    "ChallengeSubmissionStructure",
     "ChallengeTask",
     "ChallengeTaskBase",
     "ChallengeTaskContent",

{dyff_schema-0.38.5 → dyff_schema-0.38.12}/dyff/schema/v0/r1/requests.py

@@ -27,6 +27,7 @@ from .platform import (
     AnalysisRequestBase,
     AnalysisScope,
     ChallengeContent,
+    ChallengeSubmissionBase,
     ChallengeTaskBase,
     ConcernBase,
     DatasetBase,
@@ -148,6 +149,12 @@ class ChallengeCreateRequest(DyffEntityCreateRequest):
     )
 
 
+class ChallengeSubmissionCreateRequest(
+    DyffEntityCreateRequest, ChallengeSubmissionBase
+):
+    pass
+
+
 class ChallengeTaskCreateRequest(DyffEntityCreateRequest, ChallengeTaskBase):
     pass
 
@@ -398,6 +405,10 @@ class AuditQueryRequest(DyffEntityQueryRequest):
     name: Optional[str] = pydantic.Field(default=None)
 
 
+class ChallengeQueryRequest(DyffEntityQueryRequest):
+    pass
+
+
 class DatasetQueryRequest(DyffEntityQueryRequest):
     name: Optional[str] = pydantic.Field(default=None)
 
@@ -492,6 +503,8 @@ __all__ = [
     "AuditQueryRequest",
     "ChallengeContentEditRequest",
     "ChallengeCreateRequest",
+    "ChallengeQueryRequest",
+    "ChallengeSubmissionCreateRequest",
     "ChallengeTaskCreateRequest",
     "ChallengeTaskRulesEditRequest",
     "ChallengeTeamCreateRequest",

{dyff_schema-0.38.5 → dyff_schema-0.38.12/dyff_schema.egg-info}/PKG-INFO

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

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