Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add citing entry to README.rst and doc/faq.rst #389

Merged
merged 3 commits into from
Apr 8, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 21 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,27 @@ Important links
- Download releases: https://pypi.org/project/giotto-tda/
- Issue tracker: https://github.com/giotto-ai/giotto-tda/issues


Citing giotto-tda
-----------------

If you use ``giotto-tda`` in a scientific publication, we would appreciate citations to the following paper:

`giotto-tda: A Topological Data Analysis Toolkit for Machine Learning and Data Exploration <https://arxiv.org/abs/2004.02551>`_, Tauzin *et al*, arXiv:2004.02551, 2020.

You can use the following BibTeX entry:

.. code:: RST

@misc{tauzin2020giottotda,
title={giotto-tda: A Topological Data Analysis Toolkit for Machine Learning and Data Exploration},
author={Guillaume Tauzin and Umberto Lupo and Lewis Tunstall and Julian Burella Pérez and Matteo Caorsi and Anibal Medina-Mardones and Alberto Dassatti and Kathryn Hess},
year={2020},
eprint={2004.02551},
archivePrefix={arXiv},
primaryClass={cs.LG}
}

Community
=========

Expand Down
21 changes: 20 additions & 1 deletion doc/faq.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,25 @@ I am a researcher. Can I use ``giotto-tda`` in my project?
Of course! The `license <https://github.com/giotto-ai/giotto-tda/blob/master/LICENSE>`_ is very permissive.
For more information, please contact the `L2F team`_.

How do I cite ``giotto-tda``?
-----------------------------
We would appreciate citations to the following paper:

`giotto-tda: A Topological Data Analysis Toolkit for Machine Learning and Data Exploration <https://arxiv.org/abs/2004.02551>`_, Tauzin *et al*, arXiv:2004.02551, 2020.

You can use the following BibTeX entry:

.. code:: RST

@misc{tauzin2020giottotda,
title={giotto-tda: A Topological Data Analysis Toolkit for Machine Learning and Data Exploration},
author={Guillaume Tauzin and Umberto Lupo and Lewis Tunstall and Julian Burella Pérez and Matteo Caorsi and Anibal Medina-Mardones and Alberto Dassatti and Kathryn Hess},
year={2020},
eprint={2004.02551},
archivePrefix={arXiv},
primaryClass={cs.LG}
}

I cannot install ``giotto-tda``
-------------------------------

Expand All @@ -26,4 +45,4 @@ There are many TDA libraries available. How is ``giotto-tda`` different?
``giotto-tda`` is oriented towards machine learning (for details, see the :ref:`guiding principles <guiding_principles>`).
This philosophy is in contrast with other reference libraries, like `GUDHI <https://gudhi.inria.fr/doc/latest/index.html>`_,
which provide more low-level functionality at the expense of being less adapted to e.g. batch processing, or of
being tightly integrated with ``scikit-learn``.
being tightly integrated with ``scikit-learn``.