zenml-domain-models

ZenML Domain Models

Overview

ZenML domain models represent the core business entities in the ZenML ecosystem. They are built using a sophisticated layered architecture that emphasizes clean separation of concerns, type safety, and maintainable code. This document outlines the key patterns and conventions used in implementing domain models. Make sure to follow these patterns when implementing new domain models or modifying existing ones.

All model files are located in the @src/zenml/models directory.

Base Class Hierarchy

The domain models follow two main hierarchies: the Model Hierarchy and the Filter Hierarchy.

Model Hierarchy

BaseZenModel (base.py)
├── BaseRequest
│   ├── UserScopedRequest
│   │   └── WorkspaceScopedRequest
│   └── [Entity]Request
├── BaseUpdate
│   └── [Entity]Update
└── BaseResponse[Body, Metadata, Resources]
    ├── BaseResponseBody
    │   └── BaseDatedResponseBody
    │       ├── UserScopedResponseBody
    │       └── WorkspaceScopedResponseBody
    ├── BaseResponseMetadata
    │   ├── UserScopedResponseMetadata
    │   └── WorkspaceScopedResponseMetadata
    ├── BaseResponseResources
    │   ├── UserScopedResponseResources
    │   └── WorkspaceScopedResponseResources
    └── BaseIdentifiedResponse[DatedBody, Metadata, Resources]
        └── UserScopedResponse[Body, Metadata, Resources]
            └── WorkspaceScopedResponse[Body, Metadata, Resources]

Filter Hierarchy

BaseFilter (filter.py)
├── Filter (ABC)
│   ├── BoolFilter
│   ├── StrFilter
│   │   └── UUIDFilter
│   ├── NumericFilter
│   └── DatetimeFilter
├── UserScopedFilter
│   └── WorkspaceScopedFilter
└── TaggableFilter

FilterGenerator
└── Used to create appropriate Filter instances

Key Characteristics

1. Model Base Classes:
   • BaseZenModel: Root class with analytics tracking and YAML serialization
   • BaseRequest: For creating new entities
   • BaseUpdate: For modifying existing entities
   • BaseResponse: Tripartite structure with Body/Metadata/Resources
   • BaseIdentifiedResponse: Adds UUID and permission handling
   • BaseDatedResponseBody: Adds creation/update timestamps