diff --git a/README.md b/README.md index 2045034..51af105 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,7 @@ ![Python](https://img.shields.io/badge/Python-3.8%20%7C%203.9%20%7C%203.10%20%7C%203.11%20%7C%203.12.1-blue) ![version](https://img.shields.io/badge/Version-v0.1.1-green) [![License](https://img.shields.io/badge/License-BSD_3--Clause-red.svg)](https://opensource.org/licenses/BSD-3-Clause) +[![chemRxiv](https://img.shields.io/badge/chemRxiv-10.26434%2Fchemrxiv--2024--fmbgk-yellow)](https://doi.org/10.26434/chemrxiv-2024-fmbgk) ## Introduction @@ -83,6 +84,20 @@ Please note that we have a [Code of Conduct](./CODE_OF_CONDUCT.md) in place to e `UNIQUE` is licensed under the BSD 3-Clause License. See the [LICENSE](./LICENSE.md) file. +## Cite Us + +If you find `UNIQUE` helpful for your work and/or research, please consider citing our work: + +```bibtex +@misc{lanini2024unique, + title={UNIQUE: A Framework for Uncertainty Quantification Benchmarking}, + author={Lanini, Jessica and Huynh, Minh Tam Davide and Scebba, Gaetano and Schneider, Nadine and Rodr{\'\i}guez-P{\'e}rez, Raquel}, + year={2024}, + doi={https://doi.org/10.26434/chemrxiv-2024-fmbgk}, +} +``` + + ## Contacts & Acknowledgements For any questions or further details about the project, please get in touch with any of the following contacts: diff --git a/docs/source/development/contacts.md b/docs/source/development/contacts.md index 0be00a7..06b1020 100644 --- a/docs/source/development/contacts.md +++ b/docs/source/development/contacts.md @@ -8,6 +8,19 @@ For any questions or further details about the project, please get in touch with * **Nadine Schneider**, *nadine-1*[dot]*schneider*[at]*novartis*[dot]*com* * **Raquel Rodríguez-Pérez**, *raquel*[dot]*rodriguez_perez*[at]*novartis.com* +## Cite Us + +If you find `UNIQUE` helpful for your work and/or research, please consider citing our work: + +```bibtex +@misc{lanini2024unique, + title={UNIQUE: A Framework for Uncertainty Quantification Benchmarking}, + author={Lanini, Jessica and Huynh, Minh Tam Davide and Scebba, Gaetano and Schneider, Nadine and Rodr{\'\i}guez-P{\'e}rez, Raquel}, + year={2024}, + doi={https://doi.org/10.26434/chemrxiv-2024-fmbgk}, +} +``` + :::{image} ../_static/novartis_logo.png :alt: Novartis logo :align: center diff --git a/docs/source/index.md b/docs/source/index.md index 3848380..cc61c6f 100644 --- a/docs/source/index.md +++ b/docs/source/index.md @@ -21,10 +21,15 @@ myst: version_badge: "![Version badge](https://img.shields.io/badge/Version-vUNIQUE-green)" # See: https://github.com/executablebooks/MyST-Parser/issues/279#issuecomment-752948379 license_badge: | - :::{image} https://img.shields.io/badge/License-BSD_3--Clause-red.svg + :::{image} https://img.shields.io/badge/License-BSD_3--Clause-red :alt: License :target: https://opensource.org/licenses/BSD-3-Clause ::: + article_badge: | + :::{image} https://img.shields.io/badge/chemRxiv-10.26434%2Fchemrxiv--2024--fmbgk-yellow + :alt: Paper's DOI + :target: https://doi.org/10.26434/chemrxiv-2024-fmbgk + ::: high_level_schema: | :::{figure} _static/schema_high_level.png :alt: UNIQUE High-Level Schema @@ -37,10 +42,12 @@ myst: # Welcome to `UNIQUE`'s documentation! -{{python_versions}} {{version_badge | replace("UNIQUE", version)}} {{license_badge}} +{{python_versions}} {{version_badge | replace("UNIQUE", version)}} {{license_badge}} {{article_badge}} {{logo_light}} {{logo_dark}} +## Introduction + `UNIQUE` provides methods for quantifying and evaluating the uncertainty of Machine Learning (ML) models predictions. The library allows to: * combine and benchmark multiple uncertainty quantification (UQ) methods simultaneously; * evaluate the goodness of UQ methods against established metrics; @@ -51,6 +58,22 @@ myst: {{high_level_schema}} +## Cite Us + +If you find `UNIQUE` helpful for your work and/or research, please consider citing our work: + +```bibtex +@misc{lanini2024unique, + title={UNIQUE: A Framework for Uncertainty Quantification Benchmarking}, + author={Lanini, Jessica and Huynh, Minh Tam Davide and Scebba, Gaetano and Schneider, Nadine and Rodr{\'\i}guez-P{\'e}rez, Raquel}, + year={2024}, + doi={https://doi.org/10.26434/chemrxiv-2024-fmbgk}, +} +``` + +To request more information, check out [Contacts & Acknowledgements](development/contacts.md#contacts--acknowledgements). + + --- # Table of Contents