core.models.model_registry

core.models.model_registry#

Copyright (c) Meta, Inc. and its affiliates.

This source code is licensed under the MIT license found in the LICENSE file in the root directory of this source tree.

Attributes#

`MODEL_REGISTRY`
`available_pretrained_models`

Classes#

`HuggingFaceModel`	Usage docs: https://docs.pydantic.dev/2.10/concepts/models/
`URLModel`	Usage docs: https://docs.pydantic.dev/2.10/concepts/models/
`ModelRegistry`	Usage docs: https://docs.pydantic.dev/2.10/concepts/models/

Functions#

model_name_to_local_file(→ str)

Download a pretrained checkpoint if it does not exist already

Module Contents#

class core.models.model_registry.HuggingFaceModel(/, **data: Any)#

Bases: pydantic.BaseModel

Usage docs: https://docs.pydantic.dev/2.10/concepts/models/

A base class for creating Pydantic models.

__class_vars__#: The names of the class variables defined on the model.

__private_attributes__#: Metadata about the private attributes of the model.

__signature__#: The synthesized __init__ [Signature][inspect.Signature] of the model.

__pydantic_complete__#: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__#: The core schema of the model.

__pydantic_custom_init__#: Whether the model has a custom __init__ function.

__pydantic_decorators__#: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_generic_metadata__#: Metadata for generic models; contains data used for a similar purpose to __args__, __origin__, __parameters__ in typing-module generics. May eventually be replaced by these.

__pydantic_parent_namespace__#: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__#: The name of the post-init method for the model, if defined.

__pydantic_root_model__#: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__#: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__#: The pydantic-core SchemaValidator used to validate instances of the model.

__pydantic_fields__#: A dictionary of field names and their corresponding [FieldInfo][pydantic.fields.FieldInfo] objects.

__pydantic_computed_fields__#: A dictionary of computed field names and their corresponding [ComputedFieldInfo][pydantic.fields.ComputedFieldInfo] objects.

__pydantic_extra__#: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to ‘allow’.

__pydantic_fields_set__#: The names of fields explicitly set during instantiation.

__pydantic_private__#: Values of private attributes set on the model instance.

type: Literal['huggingface_hub']#

repo_id: Literal['fairchem/OMAT24']#

filename: str#

class core.models.model_registry.URLModel(/, **data: Any)#

Bases: pydantic.BaseModel

Usage docs: https://docs.pydantic.dev/2.10/concepts/models/

A base class for creating Pydantic models.

__class_vars__#: The names of the class variables defined on the model.

__private_attributes__#: Metadata about the private attributes of the model.

__signature__#: The synthesized __init__ [Signature][inspect.Signature] of the model.

__pydantic_complete__#: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__#: The core schema of the model.

__pydantic_custom_init__#: Whether the model has a custom __init__ function.

__pydantic_decorators__#: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_generic_metadata__#: Metadata for generic models; contains data used for a similar purpose to __args__, __origin__, __parameters__ in typing-module generics. May eventually be replaced by these.

__pydantic_parent_namespace__#: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__#: The name of the post-init method for the model, if defined.

__pydantic_root_model__#: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__#: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__#: The pydantic-core SchemaValidator used to validate instances of the model.

__pydantic_fields__#: A dictionary of field names and their corresponding [FieldInfo][pydantic.fields.FieldInfo] objects.

__pydantic_computed_fields__#: A dictionary of computed field names and their corresponding [ComputedFieldInfo][pydantic.fields.ComputedFieldInfo] objects.

__pydantic_extra__#: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to ‘allow’.

__pydantic_fields_set__#: The names of fields explicitly set during instantiation.

__pydantic_private__#: Values of private attributes set on the model instance.

url: str#

type: Literal['url']#

class core.models.model_registry.ModelRegistry(/, **data: Any)#

Bases: pydantic.BaseModel

Usage docs: https://docs.pydantic.dev/2.10/concepts/models/

A base class for creating Pydantic models.

__class_vars__#: The names of the class variables defined on the model.

__private_attributes__#: Metadata about the private attributes of the model.

__signature__#: The synthesized __init__ [Signature][inspect.Signature] of the model.

__pydantic_complete__#: Whether model building is completed, or if there are still undefined fields.

__pydantic_core_schema__#: The core schema of the model.

__pydantic_custom_init__#: Whether the model has a custom __init__ function.

__pydantic_decorators__#: Metadata containing the decorators defined on the model. This replaces Model.__validators__ and Model.__root_validators__ from Pydantic V1.

__pydantic_generic_metadata__#: Metadata for generic models; contains data used for a similar purpose to __args__, __origin__, __parameters__ in typing-module generics. May eventually be replaced by these.

__pydantic_parent_namespace__#: Parent namespace of the model, used for automatic rebuilding of models.

__pydantic_post_init__#: The name of the post-init method for the model, if defined.

__pydantic_root_model__#: Whether the model is a [RootModel][pydantic.root_model.RootModel].

__pydantic_serializer__#: The pydantic-core SchemaSerializer used to dump instances of the model.

__pydantic_validator__#: The pydantic-core SchemaValidator used to validate instances of the model.

__pydantic_fields__#: A dictionary of field names and their corresponding [FieldInfo][pydantic.fields.FieldInfo] objects.

__pydantic_computed_fields__#: A dictionary of computed field names and their corresponding [ComputedFieldInfo][pydantic.fields.ComputedFieldInfo] objects.

__pydantic_extra__#: A dictionary containing extra values, if [extra][pydantic.config.ConfigDict.extra] is set to ‘allow’.

__pydantic_fields_set__#: The names of fields explicitly set during instantiation.

__pydantic_private__#: Values of private attributes set on the model instance.

models: dict[str, pydantic.AnyUrl | HuggingFaceModel | URLModel]#

core.models.model_registry.MODEL_REGISTRY#

core.models.model_registry.available_pretrained_models#

core.models.model_registry.model_name_to_local_file(model_name: str, local_cache: str | pathlib.Path) → str#

Download a pretrained checkpoint if it does not exist already

Parameters:

model_name (str) – the model name. See available_pretrained_checkpoints.
local_cache (str or Path) – path to local cache directory

Returns:

local path to checkpoint file

Return type:

str