search

GSTT-CSC / MLOps

Framework for building ML apps
GNU General Public License v3.0
9 stars 5 forks source link

Acknowledgements/Citations #20

Closed hshuaib90 closed 2 years ago

hshuaib90 commented 3 years ago

Can we add a note to the README for how others can appropriately acknowledge or cite this work?

laurencejackson commented 3 years ago

IEEE Reference List Format seems appropriate, at least until (if) superceded by a publication:

AuthorLast, I (Year) Title of Code (Version #.#) [Source code]. URL.

Example: Facebook (2020) Recoil [Source code]. https://github.com/facebookexperimental/Recoil.

alexandertdeng commented 2 years ago

Proposed solution- added Citation File (https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-citation-files):

"When you add a CITATION.cff file to the default branch of your repository, it is automatically linked from the repository landing page. This makes it easy for other users to cite your software project, using the information you've provided."

34