MatminerDatasets

class mastml.datasets.MatminerDatasets

Bases: object

Class to download datasets hosted from the Matminer package’s Figshare page. A summary of available datasets can be found at: https://hackingmaterials.lbl.gov/matminer/dataset_summary.html

Args:

None

Methods:

download_data: downloads specified data from Matminer/Figshare and saves to current directory

Args:

name: (str), name of the dataset to download. For compatible names, call get_available_datasets

save_data: (bool), whether to save the downloaded data to the current working directory

Returns:

df: (dataframe), dataframe of downloaded data

get_available_datasets: returns information on the available dataset names and details one can downlaod

Args:

None.

Returns:

None.

Methods Summary

download_data(name[, save_data])
get_available_datasets()

Methods Documentation

download_data(name, save_data=True)

get_available_datasets()