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+2] fix comments and doc which refer to n_fits as n_iter #490

Closed anne-decusatis closed 2 years ago

anne-decusatis commented 2 years ago

Description

Please include a summary of the change and which issue is fixed:

When reading the docs I noticed that n_fits (which is used to determine the number of test iterations used to fit in random search cases) is sometimes referred to as n_iter. It looks like n_fits is the variable name that's actually in use. I looked for usages of n_iter and changed the ones which referred to n_fits. This is a very minor change which affects a few comments, one reference in documentation, and the text of a single error that's thrown if n_fits is negative. Please feel free to edit or reject.

Fixes # n/a This is such a minor change (at first I thought it was doc-only) that I didn't file an issue first. Please let me know if I need to!

Type of change

Please delete options that are not relevant.

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

I haven't run tests locally because this doesn't really change any functionality - I expect the CI to succeed, if it doesn't I can debug locally.

Checklist:

anne-decusatis commented 2 years ago

Looks like the failing tests are failing on make clean. I'm not familiar with the setup of this repo but it seems likely to me that it's not related to this change.

aaronreidsmith commented 2 years ago

The CI/CD is broken because of a new setuptools version that was released recently. I have a fix up in #491. We'll merge your fix in once we get that one merged in!

aaronreidsmith commented 2 years ago

@anne-decusatis can you update your branch to have the latest master changes? GitHub won't let me merge this without all the status checks 😬