Skip to content

Commit

Permalink
ADD: official paper & citation (#158)
Browse files Browse the repository at this point in the history
  • Loading branch information
VincentAuriau authored Sep 11, 2024
1 parent a6be914 commit d1dadcc
Show file tree
Hide file tree
Showing 4 changed files with 73 additions and 10 deletions.
12 changes: 12 additions & 0 deletions CITATION.bib
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
@article{Auriau2024,
doi = {10.21105/joss.06899},
url = {https://doi.org/10.21105/joss.06899},
year = {2024},
publisher = {The Open Journal},
volume = {9},
number = {101},
pages = {6899},
author = {Vincent Auriau and Ali Aouad and Antoine Désir and Emmanuel Malherbe},
title = {Choice-Learn: Large-scale choice modeling for operational contexts through the lens of machine learning},
journal = {Journal of Open Source Software}
}
38 changes: 38 additions & 0 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: Choice-Learn
message: >-
Large-scale choice modeling for operational contexts
through the lens of machine learning
type: software
authors:
- given-names: Vincent
family-names: Auriau
email: vincent.auriau@artefact.com
affiliation: CentraleSupélec
orcid: 'https://orcid.org/0009-0002-9640-2639'
- given-names: Ali
family-names: Aouad
orcid: 'https://orcid.org/0000-0002-9812-6140'
affiliation: London Business School
- given-names: Antoine
family-names: Désir
affiliation: INSEAD
orcid: 'https://orcid.org/0000-0001-5654-3301'
- given-names: Emmanuel
family-names: Malherbe
affiliation: Artefact Research Center
orcid: 'https://orcid.org/0009-0006-0898-6873'
identifiers:
- type: doi
value: 10.21105/joss.06899
repository-code: 'https://github.com/artefactory/choice-learn'
url: 'https://artefactory.github.io/choice-learn/'
abstract: >-
Choice-Learn provides a modular suite of choice modeling
tools for practitioners and academic researchers to
process choice data, and then formulate, estimate and
operationalize choice models.
license: MIT
33 changes: 23 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@
![PyPI - Version](https://img.shields.io/pypi/v/choice-learn)
![PyPI - License](https://img.shields.io/pypi/l/choice-learn)


[![DOI](https://joss.theoj.org/papers/10.21105/joss.06899/status.svg)](https://doi.org/10.21105/joss.06899)
[![cite](https://img.shields.io/badge/citation-00FFFF)](./CITATION.bib)
</div>


Expand Down Expand Up @@ -185,7 +186,8 @@ print(model.report)
## :trident: Documentation

A detailed documentation of this project is available [here](https://artefactory.github.io/choice-learn/).\
TensorFlow also has extensive [documentation](https://www.tensorflow.org/) that can help you.
TensorFlow also has extensive [documentation](https://www.tensorflow.org/) that can help you.\
An academic paper has been published in the Journal of Open-Source Software, [here](https://joss.theoj.org/papers/10.21105/joss.06899).

## :trident: Contributing
You are welcome to contribute to the project ! You can help in various ways:
Expand All @@ -200,7 +202,25 @@ We recommend to first open an [issue](https://github.com/artefactory/choice-lear

## :trident: Citation

If you consider this package and any of its feature useful for your research, please cite us.
If you consider this package and any of its feature useful for your research, consider citing our [paper](https://joss.theoj.org/papers/10.21105/joss.06899).

<a href="https://joss.theoj.org/papers/10.21105/joss.06899">
<img align="left" width="100"src="https://github.com/openjournals/joss/blob/main/docs/logos/joss-logo.png?raw=true" />
</a>

```bash
@article{Auriau2024,
doi = {10.21105/joss.06899},
url = {https://doi.org/10.21105/joss.06899},
year = {2024},
publisher = {The Open Journal},
volume = {9},
number = {101},
pages = {6899},
author = {Vincent Auriau and Ali Aouad and Antoine Désir and Emmanuel Malherbe},
title = {Choice-Learn: Large-scale choice modeling for operational contexts through the lens of machine learning},
journal = {Journal of Open Source Software} }
```

### License

Expand Down Expand Up @@ -262,10 +282,3 @@ Choice-Learn has been developed through a collaboration between researchers at t

[1] [RUMnet](https://github.com/antoinedesir/rumnet)\
[7] TasteNet [[Repo1](https://github.com/YafeiHan-MIT/TasteNet-MNL)] [[Repo2](https://github.com/deborahmit/TasteNet-MNL)]

*Other choice modeling packages:*

- [PyLogit](https://github.com/timothyb0912/pylogit)
- [Torch Choice](https://gsbdbi.github.io/torch-choice)
- [BioGeme](https://github.com/michelbierlaire/biogeme)
- [mlogit](https://github.com/cran/mlogit)
Binary file added docs/paper/choice_learn_joss_paper.pdf
Binary file not shown.

0 comments on commit d1dadcc

Please sign in to comment.