Skip to content

Commit

Permalink
[MRG] Add Conda install documentation and update issue templates (#444)
Browse files Browse the repository at this point in the history
* Add Conda install documentation

* Try drop down?

* Add render shell back

* Clean up question.yml
  • Loading branch information
aaronreidsmith authored Sep 24, 2021
1 parent 38755d3 commit 593de60
Show file tree
Hide file tree
Showing 4 changed files with 63 additions and 9 deletions.
18 changes: 15 additions & 3 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,18 +24,30 @@ body:
id: versions
attributes:
label: Versions
placeholder: |
Please run the following snippet and paste the output here.
description: |
<details closed><summary>Instructions to get necessary versions</summary>
<p>
Please run the following snippet and paste the output below.
```python
import pmdarima; pmdarima.show_versions()
For pmdarima versions <1.5.2 use this:
# For pmdarima versions <1.5.2 use this:
import platform; print(platform.platform())
import sys; print("Python", sys.version)
import pmdarima; print("pmdarima", pmdarima.__version__)
import numpy; print("NumPy", numpy.__version__)
import scipy; print("SciPy", scipy.__version__)
import sklearn; print("Scikit-Learn", sklearn.__version__)
import statsmodels; print("Statsmodels", statsmodels.__version__)
```
</p>
</details
placeholder: |
See drop down above for instructions on retrieving the versions necessary for debugging. These will be
automatically converted to code, so no need for back ticks
render: shell
validations:
required: true
Expand Down
22 changes: 17 additions & 5 deletions .github/ISSUE_TEMPLATE/question.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ body:
Before asking a question, please consult our closed issues and docs to see
if we have already addressed it:
https://github.com/alkaline-ml/pmdarima/issues?q=is%3Aissue+is%3Aclosed
https://www.alkaline-ml.com/pmdarima/
- [Closed Issues](https://github.com/alkaline-ml/pmdarima/issues?q=is%3Aissue+is%3Aclosed)
- [Documentation](https://www.alkaline-ml.com/pmdarima/)
- type: textarea
id: question
attributes:
Expand All @@ -21,18 +21,30 @@ body:
id: versions
attributes:
label: Versions (if necessary)
placeholder: |
Please run the following snippet and paste the output here.
description: |
<details closed><summary>Instructions to get necessary versions</summary>
<p>
Please run the following snippet and paste the output below.
```python
import pmdarima; pmdarima.show_versions()
For pmdarima versions <1.5.2 use this:
# For pmdarima versions <1.5.2 use this:
import platform; print(platform.platform())
import sys; print("Python", sys.version)
import pmdarima; print("pmdarima", pmdarima.__version__)
import numpy; print("NumPy", numpy.__version__)
import scipy; print("SciPy", scipy.__version__)
import sklearn; print("Scikit-Learn", sklearn.__version__)
import statsmodels; print("Statsmodels", statsmodels.__version__)
```
</p>
</details
placeholder: |
See drop down above for instructions on retrieving the versions necessary for answering your question. These
will be automatically converted to code, so no need for back ticks
render: shell
validations:
required: false
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,28 @@ from a scikit-learn background.

## Installation

### pip

Pmdarima has binary and source distributions for Windows, Mac and Linux (`manylinux`) on pypi
under the package name `pmdarima` and can be downloaded via `pip`:

```bash
$ pip install pmdarima
pip install pmdarima
```

### conda

Pmdarima also has Mac and Linux builds available via `conda` and can be installed like so:

```bash
conda config --add channels conda-forge
conda config --set channel_priority strict
conda install pmdarima
```

**Note:** We do not maintain our own Conda binaries, they are maintained at https://github.com/conda-forge/pmdarima-feedstock.
See that repo for further documentation on working with Pmdarima on Conda.

## Quickstart Examples

Fitting a simple auto-ARIMA on the [`wineind`](https://alkaline-ml.com/pmdarima/modules/generated/pmdarima.datasets.load_wineind.html#pmdarima.datasets.load_wineind) dataset:
Expand Down
15 changes: 15 additions & 0 deletions doc/setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,21 @@ the following module in python:
If you encounter an ``ImportError``, try updating numpy and re-installing. Outdated
numpy versions have been observed to break the pmdarima build.

Install from Conda
------------------

Pmdarima is on conda under the channel ``conda-forge`` and package name ``pmdarima``. It can be downloaded via ``conda``
like so:

.. code-block:: bash
$ conda config --add channels conda-forge
$ conda config --set channel_priority strict
$ conda install pmdarima
**Note:** We do not maintain our own Conda binaries, they are maintained at https://github.com/conda-forge/pmdarima-feedstock.
See that repo for further documentation on working with Pmdarima on Conda.

Build from source
-----------------

Expand Down

0 comments on commit 593de60

Please sign in to comment.