deepdisc.data_format.register_data

Functions

register_data_set(data_set_name, filename[, load_func])

Register the data set and get the MetadataCatalog.

Module Contents

register_data_set(data_set_name, filename, load_func=get_data_from_json, **kwargs)[source]

Register the data set and get the MetadataCatalog.

Parameters:
  • data_set_name (str) – The name of the data set.

  • filename (str) – The name of the file.

  • load_func (function) – The function to use to load the data set. Defaults to get_data_from_json().

  • kwargs – Additional parameters to pass into the metadata set function. Example: register_data_set(name1, name2, thing_classes=[‘star’, ‘galaxy’])

Returns:

meta – The metadata for this data set.

Return type:

Metadata

Raises:

FileNotFoundError if the data set file cannot be found.