Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mohayemin committed Jan 29, 2024
1 parent c5088da commit 5ea2340
Showing 1 changed file with 25 additions and 6 deletions.
31 changes: 25 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,22 @@
PyMigBench is a benchmark of Python Library Migrations.
This repository contains the library migration data and a tool to explore the data.
Please visit [the PyMigBench website](https://ualberta-smr.github.io/PyMigBench) for detailed instructions on using the data and the tool.
This repository contains the data and code for the dataset.

Contributors: [Mohayeminul Islam](https://mohayemin.github.io/), [Ajay Kumar Jha](https://hifromajay.github.io/), [Sarah Nadi](https://sarahnadi.org/) and [Ildar Akhmetov](https://ildarakhmetov.com/).
For any queries, please contact [email protected].

If you are going to use this benchmark, please cite:
## PyMigBench v2
This is the latest version of the dataset.
This includes all data from [PyMigBench v1](#pymigbench-v1) and additional migrations borrowed from the [SALM dataset](https://ieeexplore.ieee.org/document/10123560).
The data also includes more information per migration-related code change.
The dataset includes 3,096 migration-related code changes from 335 migrations between 141 analogous library pairs.
The data and relevant code can be found in the [v2](/v2) directory of this repository.
The paper is published published in FSE 2023.
We will update the citation information once available.

## PyMigBench v1
The 2023 version of the dataset includes 375 migration-related code changes from 75 migrations between 34 analogous library pairs.
The data and relevant code can be found in the [v1](/v1) directory of this repository.
Please visit [the PyMigBench website](https://ualberta-smr.github.io/PyMigBench) for detailed instructions on using the dataset.
We recommend using [PyMigBench v2](#pymigbench-v2),
however, if you are going to use this version, please cite the [MSR 2023 paper](https://ieeexplore.ieee.org/abstract/document/10174111):

```
@INPROCEEDINGS{pymigbench,
Expand All @@ -18,5 +29,13 @@ If you are going to use this benchmark, please cite:
pages={511-515},
doi={10.1109/MSR59073.2023.00075}
}
```


## Contributors
- [Mohayeminul Islam](https://mohayemin.github.io/)
- [Ajay Kumar Jha](https://hifromajay.github.io/)
- [Sarah Nadi](https://sarahnadi.org/)
- [Ildar Akhmetov](https://ildarakhmetov.com/)

For any queries, please contact [email protected].

0 comments on commit 5ea2340

Please sign in to comment.