spey.get_backend_metadata

spey.get_backend_metadata#

spey.get_backend_metadata(name: str) → Dict[str, Any][source]#

Retreive metadata about the backend. This includes citation information, doi, author names etc. Available backend names can be found via AvailableBackends() function.

Parameters:

name (Text) – backend identifier. This backend refers to different packages that prescribes likelihood function.

Raises:

PluginError – If the backend does not exists.

Returns:

Metadata about the backend.

Return type:

Dict[Text, Text]

Example:

>>> spey.get_backend_metadata("default_pdf.third_moment_expansion")

will return the following

>>> {'name': 'default_pdf.third_moment_expansion',
... 'author': 'SpeysideHEP',
... 'version': '0.0.1',
... 'spey_requires': '0.0.1',
... 'doi': ['10.1007/JHEP04(2019)064'],
... 'arXiv': ['1809.05548']}
Contents