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

{dyff_schema-0.4.0/dyff_schema.egg-info → dyff_schema-0.5.1}/PKG-INFO

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

@@ -30,7 +30,7 @@ from ... import named_data_schema, product_schema
 from ...version import SomeSchemaVersion
 from .base import DyffSchemaBaseModel
 from .dataset import arrow, make_item_type, make_response_type
-from .version import VERSION, Versioned
+from .version import SCHEMA_VERSION, SchemaVersion
 
 SYSTEM_ATTRIBUTES = frozenset(["creationTime", "status", "reason"])
 
@@ -149,6 +149,7 @@ class Entities(str, enum.Enum):
     DataSource = "DataSource"
     Dataset = "Dataset"
     Evaluation = "Evaluation"
+    Family = "Family"
     InferenceService = "InferenceService"
     InferenceSession = "InferenceSession"
     Measurement = "Measurement"
@@ -157,6 +158,7 @@ class Entities(str, enum.Enum):
     Module = "Module"
     Report = "Report"
     SafetyCase = "SafetyCase"
+    Tag = "Tag"
 
 
 class Resources(str, enum.Enum):
@@ -168,6 +170,7 @@ class Resources(str, enum.Enum):
     Dataset = "datasets"
     DataSource = "datasources"
     Evaluation = "evaluations"
+    Family = "families"
     InferenceService = "inferenceservices"
     InferenceSession = "inferencesessions"
     Measurement = "measurements"
@@ -176,6 +179,7 @@ class Resources(str, enum.Enum):
     Module = "modules"
     Report = "reports"
     SafetyCase = "safetycases"
+    Tag = "tags"
 
     Task = "tasks"
     """
@@ -294,7 +298,96 @@ class Status(DyffSchemaBaseModel):
     )
 
 
-class DyffEntity(Status, Labeled, Versioned, DyffModelWithID):
+class Documentation(DyffSchemaBaseModel):
+    title: Optional[str] = pydantic.Field(
+        default=None,
+        description='A short plain string suitable as a title or "headline".',
+    )
+
+    summary: Optional[str] = pydantic.Field(
+        default=None,
+        description="A brief summary, suitable for display in"
+        " small UI elements. Interpreted as Markdown. Excessively long"
+        " summaries may be truncated in the UI, especially on small displays.",
+    )
+
+    fullPage: Optional[str] = pydantic.Field(
+        default=None,
+        description="Long-form documentation. Interpreted as"
+        " Markdown. There are no length constraints, but be reasonable.",
+    )
+
+
+class Documented(DyffSchemaBaseModel):
+    documentation: Documentation = pydantic.Field(
+        default_factory=Documentation,
+        description="Documentation of the resource. The content is used to"
+        " populate various views in the web UI.",
+    )
+
+
+class FamilyMemberKind(str, enum.Enum):
+    """The kinds of entities that can be members of a Family.
+
+    These are resources for which it makes sense to have different versions or variants
+    that evolve over time.
+    """
+
+    Dataset = "Dataset"
+    InferenceService = "InferenceService"
+    Method = "Method"
+    Model = "Model"
+    Module = "Module"
+
+
+class FamilyMember(DyffSchemaBaseModel):
+    family: Optional[str] = pydantic.Field(
+        default=None,
+        description="ID of the Family to which the resource belongs.",
+    )
+
+
+class TagBase(DyffSchemaBaseModel):
+    tag: str = pydantic.Field(
+        description="An interpretable identifier for the tag that is unique in"
+        " the context of the corresponding Family."
+    )
+
+    resource: str = pydantic.Field(
+        description="ID of the resource this tag references.",
+    )
+
+    description: str = pydantic.Field(
+        description="A short description of the tag. Interpreted as Markdown."
+        " This should include information about how the tagged version is"
+        " different from other versions."
+    )
+
+
+class Tag(TagBase):
+    created: datetime = pydantic.Field(description="Tag creation time.")
+
+
+class Family(Labeled, SchemaVersion, DyffModelWithID):
+    kind: Literal["Family"] = "Family"
+
+    resourceKind: FamilyMemberKind = pydantic.Field(
+        description="The kind of resource that comprises the family.",
+    )
+
+    tags: list[Tag] = pydantic.Field(
+        default_factory=list,
+        description="Tags mapping interpretable names to resource IDs.",
+    )
+
+    documentation: Documentation = pydantic.Field(
+        default_factory=Documentation,
+        description="Documentation of the resource family. The content is used"
+        " to populate various views in the web UI.",
+    )
+
+
+class DyffEntity(Status, Labeled, SchemaVersion, DyffModelWithID):
     kind: Literal[
         "Analysis",
         "Audit",
@@ -373,6 +466,9 @@ class APIFunctions(str, enum.Enum):
     query = "query"
     """Query the resource collection."""
 
+    edit = "edit"
+    """Edit properties of existing resources."""
+
     download = "download"
     """
     .. deprecated:: 0.5.0
@@ -578,7 +674,7 @@ class DyffDataSchema(DyffSchemaBaseModel):
         " the composition of these component schemas.",
     )
     schemaVersion: SomeSchemaVersion = pydantic.Field(
-        default=VERSION, description="The dyff schema version"
+        default=SCHEMA_VERSION, description="The dyff schema version"
     )
 
     def model_type(self) -> Type[DyffSchemaBaseModel]:
@@ -601,6 +697,12 @@ class DataSchema(DyffSchemaBaseModel):
         default=None, description="The schema in JSON Schema format"
     )
 
+    @staticmethod
+    def from_model(model: Type[DyffSchemaBaseModel]) -> "DataSchema":
+        arrowSchema = arrow.encode_schema(arrow.arrow_schema(model))
+        jsonSchema = model.schema()
+        return DataSchema(arrowSchema=arrowSchema, jsonSchema=jsonSchema)
+
     @staticmethod
     def make_input_schema(
         schema: Union[pyarrow.Schema, Type[DyffSchemaBaseModel], DyffDataSchema],
@@ -1738,6 +1840,7 @@ __all__ = [
     "DataSources",
     "DataView",
     "Digest",
+    "Documentation",
     "DyffDataSchema",
     "DyffEntity",
     "DyffModelWithID",
@@ -1746,6 +1849,9 @@ __all__ = [
     "Evaluation",
     "EvaluationBase",
     "ExtractorStep",
+    "Family",
+    "FamilyMember",
+    "FamilyMemberKind",
     "ForeignInferenceService",
     "ForeignMethod",
     "ForeignModel",
@@ -1807,6 +1913,8 @@ __all__ = [
     "SchemaAdapter",
     "Status",
     "StorageSignedURL",
+    "Tag",
+    "TagBase",
     "TaskSchema",
     "entity_class",
     "JobStatus",

{dyff_schema-0.4.0 → dyff_schema-0.5.1}/dyff/schema/v0/r1/requests.py

@@ -22,6 +22,7 @@ from .platform import (
     AnalysisBase,
     DatasetBase,
     DataView,
+    Documentation,
     EvaluationBase,
     InferenceServiceBase,
     InferenceSessionBase,
@@ -30,11 +31,12 @@ from .platform import (
     ModelSpec,
     ModuleBase,
     ReportBase,
+    TagBase,
 )
-from .version import Versioned
+from .version import SchemaVersion
 
 
-class DyffEntityCreateRequest(Versioned, DyffSchemaBaseModel):
+class DyffEntityCreateRequest(SchemaVersion, DyffSchemaBaseModel):
     account: str = pydantic.Field(description="Account that owns the entity")
 
 
@@ -49,6 +51,10 @@ class DatasetCreateRequest(DyffEntityCreateRequest, DatasetBase):
     pass
 
 
+class DocumentationEditRequest(Documentation):
+    pass
+
+
 class InferenceServiceCreateRequest(DyffEntityCreateRequest, InferenceServiceBase):
     model: Optional[str] = pydantic.Field(
         default=None, description="ID of Model backing the service, if applicable"
@@ -105,6 +111,10 @@ class ReportCreateRequest(DyffEntityCreateRequest, ReportBase):
     )
 
 
+class TagCreateRequest(TagBase):
+    pass
+
+
 class LabelUpdateRequest(Labeled):
     pass
 
@@ -211,6 +221,7 @@ __all__ = [
     "DyffEntityQueryRequest",
     "DatasetCreateRequest",
     "DatasetQueryRequest",
+    "DocumentationEditRequest",
     "EvaluationCreateRequest",
     "EvaluationQueryRequest",
     "EvaluationInferenceSessionRequest",
@@ -229,4 +240,5 @@ __all__ = [
     "ReportCreateRequest",
     "ReportQueryRequest",
     "SafetyCaseQueryRequest",
+    "TagCreateRequest",
 ]

{dyff_schema-0.4.0 → dyff_schema-0.5.1}/dyff/schema/v0/r1/version.py

@@ -5,16 +5,16 @@ from typing import Literal
 
 import pydantic
 
-VERSION: str = "0.1"
+SCHEMA_VERSION: str = "0.1"
 
 
-class Versioned(pydantic.BaseModel):
+class SchemaVersion(pydantic.BaseModel):
     schemaVersion: Literal["0.1"] = pydantic.Field(
-        default=VERSION, description="The schema version."
+        default=SCHEMA_VERSION, description="The schema version."
     )
 
 
 __all__ = [
-    "VERSION",
-    "Versioned",
+    "SCHEMA_VERSION",
+    "SchemaVersion",
 ]

{dyff_schema-0.4.0 → dyff_schema-0.5.1/dyff_schema.egg-info}/PKG-INFO

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