lamindb.integrations.save_vitessce_config

lamindb.integrations.save_vitessce_config(vitessce_config, key=None, description=None)

Validates and saves a VitessceConfig object.

If the VitessceConfig object references multiple artifacts, automatically creates a Collection and displays the “Vitessce button” next to it.

The VitessceConfig artifact has .suffix = ".vitessce.json" and .kind = "__lamindb_config__", which is by default hidden on the hub UI.

Guide: Vitessce.

Parameters:

  • vitessce_config (VitessceConfig) – A VitessceConfig object.

  • key (str | None, default: None) – A key for the VitessceConfig artifact.

  • description (str | None, default: None) – A description for the VitessceConfig aritifact. Is additionally used as key for a Collection in case the VitessceConfig object references multiple artifacts.

Return type:

Artifact