dyff-schema 0.3.8__tar.gz → 0.4.0__tar.gz

{dyff-schema-0.3.8 → dyff_schema-0.4.0}/.gitlab-ci.yml

@@ -12,7 +12,7 @@ include:
     file:
       - gitlab-release.yml
   - project: buildgarden/pipelines/detect-secrets
-    ref: 0.1.0
+    ref: 0.2.1
     file:
       - detect-secrets.yml
   - project: buildgarden/pipelines/prettier

{dyff-schema-0.3.8/dyff_schema.egg-info → dyff_schema-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dyff-schema
-Version: 0.3.8
+Version: 0.4.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.3.8 → dyff_schema-0.4.0}/dyff/schema/v0/r1/platform.py

@@ -139,15 +139,6 @@ def _k8s_label_value_maxlen():
     return _k8s_label_maxlen()
 
 
-class StorageSignedURL(DyffSchemaBaseModel):
-    url: str = pydantic.Field(description="The signed URL")
-    method: str = pydantic.Field(description="The HTTP method applicable to the URL")
-    headers: dict[str, str] = pydantic.Field(
-        default_factory=dict,
-        description="Mandatory headers that must be passed with the request",
-    )
-
-
 class Entities(str, enum.Enum):
     """The kinds of entities in the dyff system."""
 
@@ -471,6 +462,43 @@ class APIKey(DyffSchemaBaseModel):
     )
 
 
+# ----------------------------------------------------------------------------
+
+
+class Digest(DyffSchemaBaseModel):
+    md5: Optional[str] = pydantic.Field(
+        default=None, description="md5 digest of artifact data"
+    )
+
+
+class Artifact(DyffSchemaBaseModel):
+    # TODO: In v1, rename this to 'contentType' or something and commit to making it the MIME type
+    kind: Optional[str] = pydantic.Field(
+        default=None, description="The kind of artifact"
+    )
+    path: str = pydantic.Field(
+        description="The relative path of the artifact within the tree"
+    )
+    digest: Digest = pydantic.Field(
+        default_factory=Digest,
+        description="One or more message digests (hashes) of the artifact data",
+    )
+
+
+class StorageSignedURL(DyffSchemaBaseModel):
+    url: str = pydantic.Field(description="The signed URL")
+    method: str = pydantic.Field(description="The HTTP method applicable to the URL")
+    headers: dict[str, str] = pydantic.Field(
+        default_factory=dict,
+        description="Mandatory headers that must be passed with the request",
+    )
+
+
+class ArtifactURL(DyffSchemaBaseModel):
+    artifact: Artifact
+    signedURL: StorageSignedURL
+
+
 class AuditRequirement(DyffSchemaBaseModel):
     """An evaluation report that must exist in order to apply an AuditProcedure."""
 
@@ -543,21 +571,6 @@ class ExtractorStep(DyffSchemaBaseModel):
     type: Optional[str] = None
 
 
-class Digest(DyffSchemaBaseModel):
-    md5: Optional[str] = pydantic.Field(None)
-
-
-class Artifact(DyffSchemaBaseModel):
-    # TODO: Enumerate the available kinds
-    kind: str = pydantic.Field(description="The kind of artifact")
-    path: str = pydantic.Field(
-        description="The relative path of the artifact within the dataset"
-    )
-    digest: Digest = pydantic.Field(
-        description="One or more message digests (hashes) of the artifact data"
-    )
-
-
 class DyffDataSchema(DyffSchemaBaseModel):
     components: list[str] = pydantic.Field(
         min_items=1,
@@ -1332,16 +1345,34 @@ class ForeignMethod(DyffModelWithID, MethodBase):
 
 
 class AnalysisScope(DyffSchemaBaseModel):
-    dataset: Optional[str]
-    inferenceService: Optional[str]
-    evaluation: Optional[str]
-    model: Optional[str]
+    """The specific entities to which the analysis applies.
+
+    When applying an InferenceService-scoped Method, at least
+    ``.inferenceService`` must be set.
+
+    When applying an Evaluation-scoped Method, at least ``.evaluation``,
+    ``.inferenceService``, and ``.dataset`` must be set.
+    """
+
+    dataset: Optional[str] = pydantic.Field(
+        default=None, description="The Dataset to which the analysis applies."
+    )
+    inferenceService: Optional[str] = pydantic.Field(
+        default=None, description="The InferenceService to which the analysis applies."
+    )
+    evaluation: Optional[str] = pydantic.Field(
+        default=None, description="The Evaluation to which the analysis applies."
+    )
+    model: Optional[str] = pydantic.Field(
+        default=None, description="The Model to which the analysis applies."
+    )
 
 
 class AnalysisBase(DyffSchemaBaseModel):
     scope: AnalysisScope = pydantic.Field(
+        default_factory=AnalysisScope,
         description="The specific entities to which the analysis results apply."
-        " At a minimum, the field corresponding to method.scope must be set."
+        " At a minimum, the field corresponding to method.scope must be set.",
     )
 
     arguments: list[AnalysisArgument] = pydantic.Field(
@@ -1695,6 +1726,7 @@ __all__ = [
     "APIKey",
     "ArchiveFormat",
     "Artifact",
+    "ArtifactURL",
     "Audit",
     "AuditProcedure",
     "AuditRequirement",

{dyff-schema-0.3.8 → dyff_schema-0.4.0/dyff_schema.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: dyff-schema
-Version: 0.3.8
+Version: 0.4.0
 Summary: Data models for the Dyff AI auditing platform.
 Author-email: Digital Safety Research Institute <contact@dsri.org>
 License: Apache-2.0