Skip to content

Commit b9776bf

Browse files
Update README.md to enhance demo visibility and citation details
1 parent 5b8932c commit b9776bf

File tree

1 file changed

+19
-12
lines changed

1 file changed

+19
-12
lines changed

README.md

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@
55
[![codecov](https://codecov.io/gh/idiap/sdialog/graph/badge.svg?token=2210USI8I0)](https://app.codecov.io/gh/idiap/sdialog?displayType=list)
66
[![PyPI version](https://badge.fury.io/py/sdialog.svg)](https://badge.fury.io/py/sdialog)
77
[![Downloads](https://static.pepy.tech/badge/sdialog)](https://pepy.tech/project/sdialog)
8-
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](LICENSE)
8+
[![Demo video](https://img.shields.io/badge/Demo%20video-YouTube-red?logo=youtube)](https://www.youtube.com/watch?v=oG_jJuU255I)
99
[![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/idiap/sdialog/)
1010

11-
Quick links: [Website](https://sdialog.github.io/)[GitHub](https://github.com/idiap/sdialog)[Docs](https://sdialog.readthedocs.io)[API](https://sdialog.readthedocs.io/en/latest/api/sdialog.html)[Demo (Colab)](https://colab.research.google.com/github/idiap/sdialog/blob/main/tutorials/demo.ipynb)[Tutorials](https://github.com/idiap/sdialog/tree/main/tutorials)[Datasets (HF)](https://huggingface.co/datasets/sdialog)[Issues](https://github.com/idiap/sdialog/issues)
11+
Quick links: [Website](https://sdialog.github.io/)[GitHub](https://github.com/idiap/sdialog)[Docs](https://sdialog.readthedocs.io)[API](https://sdialog.readthedocs.io/en/latest/api/sdialog.html)[ArXiv paper](https://arxiv.org/abs/2512.09142)[Demo (video)](demo.md)[Tutorials](https://github.com/idiap/sdialog/tree/main/tutorials)[Datasets (HF)](https://huggingface.co/datasets/sdialog)[Issues](https://github.com/idiap/sdialog/issues)
1212

1313
---
1414
SDialog is an MIT-licensed open-source toolkit for building, simulating, and evaluating LLM-based conversational agents end-to-end. It aims to bridge agent construction → user simulation → dialog generation → evaluation in a single reproducible workflow, so you can generate reliable, controllable dialog systems or data at scale.
@@ -310,7 +310,8 @@ print(audio_dialog.display())
310310

311311
## 📖 Documentation and tutorials
312312

313-
- [Demo notebook](https://colab.research.google.com/github/idiap/sdialog/blob/main/tutorials/demo.ipynb)
313+
- [ArXiv paper](https://arxiv.org/abs/2512.09142)
314+
- [Demo (video)](demo.md)
314315
- [Tutorials](https://github.com/idiap/sdialog/tree/main/tutorials)
315316
- [API reference](https://sdialog.readthedocs.io/en/latest/api/sdialog.html)
316317
- [Documentation](https://sdialog.readthedocs.io)
@@ -377,22 +378,28 @@ This project follows the [all-contributors](https://github.com/all-contributors/
377378

378379
<!-- ALL-CONTRIBUTORS-LIST:END -->
379380

380-
<!-- ## 📚 Citation
381+
## 📚 Citation
382+
383+
If you use SDialog in academic work, please consider citing [our paper](https://arxiv.org/abs/2512.09142):
381384

382-
If you use SDialog in academic work, please cite:
383385
```bibtex
384-
@misc{sdialog2025,
385-
title = {SDialog: A Toolkit for Synthetic Dialog Generation, Evaluation, and Interpretability},
386-
author = {Contributors of the SDialog Project},
387-
year = {2025},
388-
url = {https://github.com/idiap/sdialog}
386+
@misc{burdisso2025sdialogpythontoolkitendtoend,
387+
title = {SDialog: A Python Toolkit for End-to-End Agent Building, User Simulation, Dialog Generation, and Evaluation},
388+
author = {Sergio Burdisso and Séverin Baroudi and Yanis Labrak and David Grunert and Pawel Cyrta and Yiyang Chen and Srikanth Madikeri and Esaú Villatoro-Tello and Thomas Schaaf and Ricard Marxer and Petr Motlicek},
389+
year = {2025},
390+
eprint = {2512.09142},
391+
archivePrefix = {arXiv},
392+
primaryClass = {cs.AI},
393+
url = {https://arxiv.org/abs/2512.09142},
389394
}
390-
``` -->
395+
```
396+
397+
_(A system demonstration version of the paper has been submitted to EACL 2026 and is under review; we will update this BibTeX if accepted)_
391398

392399

393400
## 🙏 Acknowledgments
394401

395-
This work was supported by the European Union Horizon 2020 project [ELOQUENCE](https://eloquenceai.eu/about/) and received a significant development boost during the **Johns Hopkins University** [JSALT 2025 workshop](https://jsalt2025.fit.vut.cz/), as part of the ["Play your Part" research group](https://jsalt2025.fit.vut.cz/play-your-part). We thank all contributors and the open-source community for their valuable feedback and contributions.
402+
This work was mainly supported by the European Union Horizon 2020 project [ELOQUENCE](https://eloquenceai.eu/about/) and received a significant development boost during the **Johns Hopkins University** [JSALT 2025 workshop](https://jsalt2025.fit.vut.cz/), as part of the ["Play your Part" research group](https://jsalt2025.fit.vut.cz/play-your-part). We thank all contributors and the open-source community for their valuable feedback and contributions.
396403

397404
## 📝 License
398405

0 commit comments

Comments
 (0)