official-stockfish / Stockfish

A free and strong UCI chess engine
https://stockfishchess.org/
GNU General Public License v3.0
11.5k stars 2.27k forks source link

Adding CITATION.cff to repo #4419

Closed jamesbraza closed 1 year ago

jamesbraza commented 1 year ago

Describe the issue

Can you add a CITATION.cff file to the repo root, to make it easy to cite Stockfish, for academic papers? 🤓

You can read about CITATION.cff here and use https://bit.ly/cffinit to easily generate a CITATION.cff file.

Simply adding it to the repo root adds this menu to the right panel:

image

Expected behavior

n/a

Steps to reproduce

n/a

Anything else?

n/a

Operating system

All

Stockfish version

n/a

vdbergh commented 1 year ago

To see if this is useful, I was wondering in what context one would refer to Stockfish in a publication. It could be something like this

All our experiments were performed using the very strong chess engine "Stockfish" [5].

So yes, it seems reasonable to have a standard way of citing Stockfish, even though Stockfish itself is not a publication (not in a standard sense anyway).

jamesbraza commented 1 year ago

Yeah you're right, simply to have a citation corresponding with the Stockfish engine's first mention in the paper.

I am doing some reinforcement learning, and want to use Stockfish (specifying Elo) as a benchmark. That way, I can get a rough idea of my model's Elo, as a function of training and also model architecture(s).

In the 2017 paper Who is the Master?, they used Stockfish 6, but never properly cited Stockfish imo. Directly integrating with CITATION.cff makes citing Stockfish easy.

vondele commented 1 year ago

I think that's a reasonable thing to do. I have added (pull request) a first try, comments welcome.