crested.get_model

Contents

crested.get_model#

crested.get_model(model)#

Fetch a model.

This function retrieves the model files, downloading if not already cached, and returns the paths to the model and a list of output classnames. The model folder contains the model.keras file and the output classnames file (.tsv).

Note

The cache location can be changed by setting environment variable $CRESTED_DATA_DIR.

Parameters:

model (str) –

The name of the model to fetch. Available options:

  • ’DeepBICCN’

  • ’DeepBICCN2’

  • ’DeepCCL’

  • ’DeepChickenBrain1’

  • ’DeepChickenBrain2’

  • ’DeepFlyBrain’

  • ’DeepGlioma’

  • ’DeepHumanBrain’

  • ’DeepHumanCortex1’

  • ’DeepHumanCortex2’

  • ’DeepLiver_accessibility’

  • ’DeepLiver_activity’

  • ’DeepLiver_zonation’

  • ’DeepMEL1’

  • ’DeepMEL2’

  • ’DeepMEL2_gabpa’

  • ’DeepMouseBrain1’

  • ’DeepMouseBrain2’

  • ’DeepMouseBrain3’

  • ’DeepPBMC’

  • ’DeepZebraFish’

  • ’Enformer_human’

  • ’Enformer_mouse’

  • ’BorzoiBICCN’

  • ’Borzoi_human_rep[0-3]’

  • ’Borzoi_mouse_rep[0-3]’

  • ’Embryo10x”

  • ’EmbryoHydrop’

  • ’MouseCortexHydrop’

Return type:

tuple[str, list[str]]

Returns:

A tuple consisting of the .keras model file path and a list of output classnames.

Example

>>> model_file, output_names = crested.get_model("DeepFlyBrain")
Contents