References in documentation/logs

[frostedoyster]

The current documentation does not make it easy for users to cite the relevant papers. In my opinion, bibtex should be readily available. Another good idea, as suggested by @PicoCentauri, would be to print the papers to cite in the logs of the training runs (at the beginning? at the end? ...)

[PicoCentauri]

Thanks for bringing up this discussion.

Currently, I would split the way references are provided: 1. within the documentation and 2. within the code.

1. As introduces in Document hyperparameters for SOAP-BPNN #72 I am suggesting to use the sphinxcontrib-bibtex library. We have to keep a bibtex file, which many scientists in our field are familiar with. Then you can easily cite references in the docs and they get rendered in a consistent way.

2. For the code my idea is to introduce an ArchitectureInfo class, where each Architecture has to define some meta data. This meta data includes a property references which for simplicity should be list of strings. This list will get formatted and displayed during training.

I know this may somehow a bit of a duplication for references but I think putting a bibtex parser to the code is an overkill and on top printing five lines (as usually for a real paper like reference) per references is too much for a logfile.

On the other hand having nice formatted references in the actual docs is nice and there, at least for me sphinxcontrib-bibtex seems like a good solution.

Let me know what you think