Backbones

List and download GNN backbones for franken.

usage: franken.backbones [-h] {list,download} ...

Sub-commands

list

List available models

franken.backbones list [-h] [--cache_dir CACHE_DIR]
                       [--log_level {DEBUG,INFO,WARNING,ERROR}]

Named Arguments

--cache_dir

Directory to save the downloaded checkpoints. Defaults to ‘~/.franken/’ in the user home or to the ‘FRANKEN_CACHE_DIR’ environment variable if set.

--log_level

Possible choices: DEBUG, INFO, WARNING, ERROR

log-level for the command-line logger

Default: 'INFO'

download

Download a model

franken.backbones download [-h] --model_name
                           {mace_mp/small,mace_mp/medium,mace_mp/large,mace_mp/small-0b,mace_mp/medium-0b,mace_mp/small-0b2,mace_mp/medium-0b2,mace_mp/large-0b2,mace_mp/medium-0b3,mace_mpa/medium-0,mace_omat/small-0,mace_omat/medium-0,mace_matpes/pbe-0,mace_matpes/r2scan-0,mace_mh/0,mace_mh/1,mace_omol/0_1024,mace_omol/0_4M,mace_off/small,mace_off/medium,mace_off/medium24,mace_off/large,SevenNet0/11July2024,PET_MAD/xs_1.5,PET_MAD/s_1.5,PET_OMat/xs_1.0,PET_OMat/s_1.0,PET_OMat/m_1.0,PET_OMat/l_1.0,PET_OMat/xl_1.0}
                           [--cache_dir CACHE_DIR]
                           [--log_level {DEBUG,INFO,WARNING,ERROR}]

Named Arguments

--model_name

Possible choices: mace_mp/small, mace_mp/medium, mace_mp/large, mace_mp/small-0b, mace_mp/medium-0b, mace_mp/small-0b2, mace_mp/medium-0b2, mace_mp/large-0b2, mace_mp/medium-0b3, mace_mpa/medium-0, mace_omat/small-0, mace_omat/medium-0, mace_matpes/pbe-0, mace_matpes/r2scan-0, mace_mh/0, mace_mh/1, mace_omol/0_1024, mace_omol/0_4M, mace_off/small, mace_off/medium, mace_off/medium24, mace_off/large, SevenNet0/11July2024, PET_MAD/xs_1.5, PET_MAD/s_1.5, PET_OMat/xs_1.0, PET_OMat/s_1.0, PET_OMat/m_1.0, PET_OMat/l_1.0, PET_OMat/xl_1.0

The name of the model to download.