Skip to content

Data Modalities¤

The live Artifex modality registry currently exposes three runtime-backed modalities:

  • image
  • molecular
  • protein

This page documents that retained registry surface and then separates the family-scoped owner pages that still live under the shared docs/modalities folder.

Registry-Backed Modalities¤

Image¤

Use the registry-backed image modality for the default factory-ready example path across VAE, GAN, diffusion, and flow-family models.

Image Modality Guide

Molecular¤

Use the registry-backed molecular modality when you need typed chemical extension configuration and family-based adapter lookup.

Protein-Ligand Benchmark Example

Protein¤

Use the registry-backed protein modality when you need typed protein extension bundles and retained geometric or diffusion adapter lookup.

Protein Modeling Guide

Quick Start¤

Use the registry-backed modality entrypoint:

from artifex.generative_models.modalities import get_modality, list_modalities

available = list_modalities()
# ['image', 'molecular', 'protein']

image_modality = get_modality('image', rngs=rngs)
image_adapter = image_modality.get_adapter('vae')
adapted_model = image_adapter.adapt(model, config)

Family-Scoped Owner Pages¤

The shared filenames in this catalog are not modality-generic.

Timeseries Helper Owners¤

These pages document the retained timeseries helper package, which is not part of the shared registry-backed modality contract:

Protein Owner Pages¤

These pages are protein-specific owners rather than shared modality categories:

Image, text, audio, and multi-modal helper packages keep their own package-local docs. The shared owner pages above do not apply to them.

Modality Registry¤

The registry is the authoritative surface for the retained modality set:

from artifex.generative_models.modalities import (
    get_modality,
    list_modalities,
    register_modality,
)

available = list_modalities()
# ['image', 'molecular', 'protein']

protein_modality = get_modality('protein', rngs=rngs)
register_modality('custom', CustomModality)

Registry Owner