mindformers.AutoModel

class mindformers.AutoModel

AutoModel class helps instantiates a model by yaml model name, path or config. If using a model name, the config yaml and checkpoint file will be downloaded from obs to ./checkpoint_download dir

Examples:

>>> from mindformers.auto_class import AutoModel
>>>
>>> # 1)  input model name, load model and weights
>>> model_a = AutoModel.from_pretrained('clip_vit_b_32')
>>> # 2)  input model directory, load model and weights
>>> from mindformers.mindformer_book import MindFormerBook
>>> checkpoint_dir = os.path.join(MindFormerBook.get_default_checkpoint_download_folder(), 'clip')
>>> model_b = AutoModel.from_pretrained(checkpoint_dir)
>>> # 3)  input yaml path, load model without weights
>>> config_path = os.path.join(MindFormerBook.get_project_path(),
...                            'configs', 'clip', 'run_clip_vit_b_32_pretrain_flickr8k.yaml')
>>> model_c = AutoModel.from_config(config_path)
>>> # 4)  input config, load model without weights
>>> config = AutoConfig.from_pretrained('clip_vit_b_32')
>>> model_d = AutoModel.from_config(config)

classmethod from_config(config, **kwargs)

From config method, which instantiates a Model by config.

Args:

config (str, BaseConfig): A model config inherited from BaseConfig, or a path to .yaml file for model config.

Returns:

A model, which inherited from BaseModel.

classmethod from_pretrained(pretrained_model_name_or_dir, **kwargs)

From pretrain method, which instantiates a Model by pretrained model name or path.

Args:

pretrained_model_name_or_dir (str): A supported model name or a directory to model checkpoint

(including .yaml file for config and .ckpt file for weights), the supported model name could be selected from AutoModel.show_support_list(). If pretrained_model_name_or_dir is model name, it supports model names beginning with mindspore or the model name itself, such as “mindspore/vit_base_p16” or “vit_base_p16”.

pretrained_model_name_or_path (Optional[str]): Equal to “pretrained_model_name_or_dir”,

if “pretrained_model_name_or_path” is set, “pretrained_model_name_or_dir” is useless.

Returns:

A model, which inherited from BaseModel.

classmethod get_support_list()

get support list method

classmethod invalid_model_name(pretrained_model_name_or_dir)

Check whether it is a valid model name

classmethod show_support_list()

show support list method