Skip to content

Commit

Permalink
update readme and cff with new JOSS citation
Browse files Browse the repository at this point in the history
  • Loading branch information
JacksonBurns committed Nov 6, 2023
1 parent 0080e6e commit a8a91d3
Show file tree
Hide file tree
Showing 2 changed files with 59 additions and 73 deletions.
110 changes: 55 additions & 55 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -1,56 +1,56 @@
# This CITATION.cff file was generated with cffinit.
# Visit https://bit.ly/cffinit to generate yours today!

cff-version: 1.2.0
title: astartes
message: >-
If you use this software, please cite it using the
metadata from this file.
type: software
cff-version: "1.2.0"
authors:
- given-names: Jackson
family-names: Burns
orcid: 'https://orcid.org/0000-0002-0657-9426'
affiliation: >-
Center for Computational Science and Engineering,
Massachusetts Institute of Technology
- given-names: Kevin
family-names: Spiekermann
affiliation: >-
Department of Chemical Engineering, Massachusetts
Institute of Technology, United States
orcid: 'https://orcid.org/0000-0002-9484-9253'
- given-names: Himaghna
family-names: Bhattacharjee
orcid: 'https://orcid.org/0000-0002-6598-3939'
affiliation: >-
Department of Chemical and Biomolecular Engineering,
University of Delaware, United States
- given-names: Dionisios
family-names: Vlachos
orcid: 'https://orcid.org/0000-0002-6795-8403'
affiliation: >-
Department of Chemical and Biomolecular Engineering,
University of Delaware, United States
- given-names: William
family-names: Green
orcid: 'https://orcid.org/0000-0003-2603-9694'
affiliation: >-
Department of Chemical and Biomolecular Engineering,
University of Delaware, United States
identifiers:
- type: doi
value: 10.5281/zenodo.7884532
description: zenodo deposit of v1.0.0
repository-code: 'https://github.com/JacksonBurns/astartes'
url: 'https://jacksonburns.github.io/astartes/'
abstract: Better Data Splits for Machine Learning with astartes
keywords:
- Python
- machine learning
- sampling
- interpolation
- extrapolation
- data splits
- cheminformatics
license: MIT
- family-names: Burns
given-names: Jackson W.
orcid: "https://orcid.org/0000-0002-0657-9426"
- family-names: Spiekermann
given-names: Kevin A.
orcid: "https://orcid.org/0000-0002-9484-9253"
- family-names: Bhattacharjee
given-names: Himaghna
orcid: "https://orcid.org/0000-0002-6598-3939"
- family-names: Vlachos
given-names: Dionisios G.
orcid: "https://orcid.org/0000-0002-6795-8403"
- family-names: Green
given-names: William H.
orcid: "https://orcid.org/0000-0003-2603-9694"
contact:
- family-names: Burns
given-names: Jackson W.
orcid: "https://orcid.org/0000-0002-0657-9426"
doi: 10.5281/zenodo.8147205
message: If you use this software, please cite our article in the
Journal of Open Source Software.
preferred-citation:
authors:
- family-names: Burns
given-names: Jackson W.
orcid: "https://orcid.org/0000-0002-0657-9426"
- family-names: Spiekermann
given-names: Kevin A.
orcid: "https://orcid.org/0000-0002-9484-9253"
- family-names: Bhattacharjee
given-names: Himaghna
orcid: "https://orcid.org/0000-0002-6598-3939"
- family-names: Vlachos
given-names: Dionisios G.
orcid: "https://orcid.org/0000-0002-6795-8403"
- family-names: Green
given-names: William H.
orcid: "https://orcid.org/0000-0003-2603-9694"
date-published: 2023-11-05
doi: 10.21105/joss.05996
issn: 2475-9066
issue: 91
journal: Journal of Open Source Software
publisher:
name: Open Journals
start: 5996
title: Machine Learning Validation via Rational Dataset Sampling with
astartes
type: article
url: "https://joss.theoj.org/papers/10.21105/joss.05996"
volume: 8
title: Machine Learning Validation via Rational Dataset Sampling with
`astartes`
22 changes: 4 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ To facilitate adoption of these models, there are two important tasks to conside
2. evaluate model performance on both interpolative and extrapolative tasks so future users are informed of any potential limitations.

`astartes` addresses both of these points by implementing an `sklearn`-compatible `train_val_test_split` function.
Additional technical detail is provided below as well as in our companion [paper](https://raw.githubusercontent.com/JacksonBurns/astartes/joss-paper/Burns-Spiekermann-Bhattacharjee_astartes.pdf).
Additional technical detail is provided below as well as in our companion paper in the Journal of Open Source Software: [Machine Learning Validation via Rational Dataset Sampling with astartes](https://joss.theoj.org/papers/10.21105/joss.05996).
For a demo-based explainer using machine learning on a fast food menu, see the `astartes` Reproducible Notebook published at the United States Research Software Engineers Conference at [this page](https://jacksonburns.github.io/use-rse-23-astartes/split_comparisons.html).

### Target Audience
Expand Down Expand Up @@ -291,23 +291,9 @@ We continually run regression tests to catch these, and will list all _known_ li
`astartes` is still consistent between runs on the same platform in all cases, and other samplers are not impacted by this apparent bug.

## How to Cite
If you use `astartes` in your work please use the below citation or the "Cite this repository" button on GitHub:
> **BibTeX**
> @software{burns_jackson_2023_8147205,
> author = {Burns, Jackson and
> Spiekermann, Kevin and
> Bhattacharjee, Himaghna and
> Vlachos, Dionisios and
> Green, William},
> title = {{Machine Learning Validation via Rational Dataset
> Sampling with astartes}},
> month = may,
> year = 2023,
> publisher = {Zenodo},
> version = {1.1.1},
> doi = {10.5281/zenodo.8147205},
> url = {https://doi.org/10.5281/zenodo.8147205}
> }
If you use `astartes` in your work please follow the link below to our (Open Access!) paper in the Journal of Open Source Software or use the "Cite this repository" button on GitHub.

[Machine Learning Validation via Rational Dataset Sampling with astartes](https://joss.theoj.org/papers/10.21105/joss.05996)

## Contributing & Developer Notes
See [CONTRIBUTING.md](./CONTRIBUTING.md) for instructions on installing `astartes` for development, making a contribution, and general guidance on the design of `astartes`.
Expand Down

0 comments on commit a8a91d3

Please sign in to comment.