bioimageio.spec.generic

491class GenericDescr(GenericDescrBase, extra="ignore"):
492    """Specification of the fields used in a generic bioimage.io-compliant resource description file (RDF).
493
494    An RDF is a YAML file that describes a resource such as a model, a dataset, or a notebook.
495    Note that those resources are described with a type-specific RDF.
496    Use this generic resource description, if none of the known specific types matches your resource.
497    """
498
499    implemented_type: ClassVar[Literal["generic"]] = "generic"
500    if TYPE_CHECKING:
501        type: Annotated[str, LowerCase] = "generic"
502        """The resource type assigns a broad category to the resource."""
503    else:
504        type: Annotated[str, LowerCase]
505        """The resource type assigns a broad category to the resource."""
506
507    id: Optional[
508        Annotated[ResourceId, Field(examples=["affable-shark", "ambitious-sloth"])]
509    ] = None
510    """bioimage.io-wide unique resource identifier
511    assigned by bioimage.io; version **un**specific."""
512
513    parent: Optional[ResourceId] = None
514    """The description from which this one is derived"""
515
516    source: Optional[HttpUrl] = None
517    """The primary source of the resource"""
518
519    @field_validator("type", mode="after")
520    @classmethod
521    def check_specific_types(cls, value: str) -> str:
522        if value in KNOWN_SPECIFIC_RESOURCE_TYPES:
523            raise ValueError(
524                f"Use the {value} description instead of this generic description for"
525                + f" your '{value}' resource."
526            )
527
528        return value