bioimageio.spec.generic

436class GenericDescr(GenericDescrBase, extra="ignore"):
437    """Specification of the fields used in a generic bioimage.io-compliant resource description file (RDF).
438
439    An RDF is a YAML file that describes a resource such as a model, a dataset, or a notebook.
440    Note that those resources are described with a type-specific RDF.
441    Use this generic resource description, if none of the known specific types matches your resource.
442    """
443
444    type: Annotated[str, LowerCase] = Field("generic", frozen=True)
445    """The resource type assigns a broad category to the resource."""
446
447    id: Optional[
448        Annotated[ResourceId, Field(examples=["affable-shark", "ambitious-sloth"])]
449    ] = None
450    """bioimage.io-wide unique resource identifier
451    assigned by bioimage.io; version **un**specific."""
452
453    parent: Optional[ResourceId] = None
454    """The description from which this one is derived"""
455
456    source: Optional[HttpUrl] = None
457    """The primary source of the resource"""
458
459    @field_validator("type", mode="after")
460    @classmethod
461    def check_specific_types(cls, value: str) -> str:
462        if value in KNOWN_SPECIFIC_RESOURCE_TYPES:
463            raise ValueError(
464                f"Use the {value} description instead of this generic description for"
465                + f" your '{value}' resource."
466            )
467
468        return value