diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index f7cb555c..6a441a0a 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -1,9 +1,9 @@ name: Documentation build - #on: push -on: - release: - types: [published] +on: push + # on: + # release: + # types: [published] # Only run when release published (not created or edited, etc) # https://docs.github.com/en/actions/reference/events-that-trigger-workflows#release diff --git a/docs/source/faq.rst b/docs/source/faq.rst index 3d0e145a..ce58e988 100644 --- a/docs/source/faq.rst +++ b/docs/source/faq.rst @@ -14,6 +14,20 @@ difficulties while launching. ``http://[url]:8421/download`` which has a filename like ``exp-2021-05-20T07:31-salmon-v0.4.1.rdb``). +How do I cite Salmon? +--------------------- + +See the :ref:`users` section to for the specific BibTex citation for the +relevant paper, "`Efficiently Learning Relative Similarity Embeddings with +Crowdsourcing `_". + +.. raw:: html + + + DOI badge + +
+ .. _random_vs_active: When should I use random/active sampling? diff --git a/docs/source/index.rst b/docs/source/index.rst index a03f040b..438ea6e3 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -38,6 +38,8 @@ at :ref:`deps`. Salmon is licensed under the BSD License. Details are at .. _Salmon's contribution guide: https://github.com/stsievert/salmon/blob/master/CONTRIBUTING.md +.. _users: + Users ===== @@ -45,6 +47,38 @@ Salmon is currently being actively used by pyschologists from the University of Wisconsin--Madison, and has seen some user from pyschologists at the Louisiana State University and Canada's Western University. +If you use Salmon, please cite "`Efficiently Learning Relative Similarity +Embeddings with Crowdsourcing `_", which +mentions this specific BibTex: + +.. code-block:: none + + @article{Sievert2023, + author = {Scott Sievert and Robert Nowak and Timothy Rogers}, + title = {Efficiently Learning Relative Similarity Embeddings with Crowdsourcing}, + journal = {Journal of Open Source Software} + doi = {10.21105/joss.04517}, + url = {https://doi.org/10.21105/joss.04517}, + year = {2023}, + publisher = {The Open Journal}, + volume = {8}, + number = {84}, + pages = {4517}, + } + + +Salmon also has a `citation file `_ +file at `salmon/CITATION.cff +`_. + +.. raw:: html + + + DOI badge + +
+ + .. toctree:: :maxdepth: 2 :caption: Usage @@ -75,8 +109,8 @@ Louisiana State University and Canada's Western University. developers deps -Other sources -------------- +Other sources of this documentation +----------------------------------- This documentation is available at these locations: