alkaline-ml / pmdarima

A statistical library designed to fill the void in Python's time series analysis capabilities, including the equivalent of R's auto.arima function.

https://www.alkaline-ml.com/pmdarima

MIT License

1.57k stars 231 forks source link

[MRG+1] Add CITATION.cff file #447

Closed aaronreidsmith closed 3 years ago

aaronreidsmith commented 3 years ago

Description

This PR adds a CITATION.cff file. You can read more about it here and here.

Unfortunately, it doesn't match http://alkaline-ml.com/pmdarima/citing, so maybe we need to update that? Additionally, this would require us to keep track of the version/date. We can probably utilize https://github.com/citation-file-format/ruby-cff to automatically generate it on a prod tag?

Type of change

Please delete options that are not relevant.

[ ] Bug fix (non-breaking change which fixes an issue)
[X] New feature (non-breaking change which adds functionality)
[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
[ ] Documentation change

How Has This Been Tested?

See here: https://github.com/alkaline-ml/pmdarima/tree/citation

Video to show where it appears

https://user-images.githubusercontent.com/21350310/130277426-6fc22321-0696-4051-8ac8-85cfb589c4f0.mov

Checklist:

[X] I have performed a self-review of my own code
[X] I have commented my code, particularly in hard-to-understand areas
[X] I have made corresponding changes to the documentation
[X] My changes generate no new warnings
[X] I have added tests that prove my fix is effective or that my feature works
[X] New and existing unit tests pass locally with my changes