mattertune.data.mp

Classes

MPDataset(config)

MPDatasetConfig(*[, type])

Configuration for a dataset stored in the Materials Project database.
class mattertune.data.mp.MPDatasetConfig(*, type='mp', api, fields, query)[source]

Configuration for a dataset stored in the Materials Project database.

Parameters:

  • type (Literal['mp'])

  • api (str)

  • fields (list[str])

  • query (dict)

type: Literal['mp']

Discriminator for the MP dataset.

api: str

Input API key for the Materials Project database.

fields: list[str]

Fields to retrieve from the Materials Project database.

query: dict

Query to filter the data from the Materials Project database.

create_dataset()[source]
class mattertune.data.mp.MPDataset(config)[source]
Parameters:

config (MPDatasetConfig)

__init__(config)[source]
Parameters:

config (MPDatasetConfig)