|
9 | 9 | <p align="center"> |
10 | 10 | <img src="https://img.shields.io/badge/license-mit-blue.svg" alt="mit license"> |
11 | 11 | <img src="https://img.shields.io/badge/python-3.6+-blue" alt="python3.6+"> |
12 | | - <a href="https://github.com/Yu-group/pcs-pipeline/actions"><img src="https://github.com/Yu-group/pcs-pipeline/workflows/tests/badge.svg" alt="tests"></a> |
13 | | - <img src="https://img.shields.io/github/checks-status/Yu-group/pcs-pipeline/master" alt="checks"> |
| 12 | + <a href="https://github.com/Yu-Group/veridical-flow/actions"><img src="https://github.com/Yu-Group/veridical-flow/workflows/tests/badge.svg" alt="tests"></a> |
14 | 13 | <a href="https://joss.theoj.org/papers/10.21105/joss.03895"><img src="https://joss.theoj.org/papers/10.21105/joss.03895/status.svg" alt="joss"></a> |
15 | 14 | <img src="https://img.shields.io/pypi/v/vflow?color=orange" alt="downloads"> |
16 | 15 | </p> |
@@ -84,11 +83,22 @@ See the [docs](https://yu-group.github.io/veridical-flow/) for reference on the |
84 | 83 |
|
85 | 84 | ## Installation |
86 | 85 |
|
87 | | -Install with `pip install vflow` (see [here](https://github.com/Yu-Group/pcs-pipeline/blob/master/docs/troubleshooting.md) for help). For dev version (unstable), clone the repo and run `python setup.py develop` from the repo directory. |
| 86 | +Install with `pip install vflow` (see [here](https://github.com/Yu-Group/veridical-flow/blob/master/docs/troubleshooting.md) for help). For dev version (unstable), clone the repo and run `python setup.py develop` from the repo directory. |
88 | 87 |
|
89 | 88 | # References |
90 | 89 |
|
91 | 90 | - interface: easily build on [scikit-learn](https://scikit-learn.org/stable/index.html) and [dvc](https://dvc.org/) (data version control) |
92 | 91 | - computation: integration with [ray](https://www.ray.io/) and caching with [joblib](https://joblib.readthedocs.io/en/latest/) |
93 | 92 | - tracking: [mlflow](https://mlflow.org/) |
94 | | -- pull requests very welcome! (see [contributing.md](https://github.com/Yu-Group/pcs-pipeline/blob/master/docs/contributing.md)) |
| 93 | +- pull requests very welcome! (see [contributing.md](https://github.com/Yu-Group/veridical-flow/blob/master/docs/contributing.md)) |
| 94 | + |
| 95 | +```r |
| 96 | +@software{duncan2020vflow, |
| 97 | + author = {Duncan, James and Kapoor, Rush and Agarwal, Abhineet and Singh, Chandan and Yu, Bin}, |
| 98 | + doi = {10.21105/joss.03895}, |
| 99 | + month = {1}, |
| 100 | + title = {{VeridicalFlow: a Python package for building trustworthy data science pipelines with PCS}}, |
| 101 | + url = {https://doi.org/10.21105/joss.03895}, |
| 102 | + year = {2022} |
| 103 | +} |
| 104 | +``` |
0 commit comments