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:
  • ’BICCN’

  • ’DeepChickenBrain1’

  • ’DeepChickenBrain2’

  • ’DeepFlyBrain’

  • ’DeepHumanBrain’

  • ’DeepHumanCortex1’

  • ’DeepHumanCortex2’

  • ’DeepLiver_accessibility’

  • ’DeepLiver_activity’

  • ’DeepLiver_zonation’

  • ’DeepMEL1’

  • ’DeepMEL2’

  • ’DeepMEL2_gabpa’

  • ’DeepMouseBrain1’

  • ’DeepMouseBrain2’

  • ’DeepMouseBrain3’

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")