Skip to content

Commit f443843

Browse files
authored
Fix links to holidays package (#2999)
* Fix links to holidays package Co-authored-by: Zhihao Dai <zhihao.dai@eng.ox.ac.uk> * Update links to package documentation Co-authored-by: Zhihao Dai <zhihao.dai@eng.ox.ac.uk> * Update CHANGELOG Co-authored-by: Zhihao Dai <zhihao.dai@eng.ox.ac.uk> * Fix CHANGELOG typo Co-authored-by: Zhihao Dai <zhihao.dai@eng.ox.ac.uk>
1 parent e4b61ac commit f443843

File tree

4 files changed

+5
-8
lines changed

4 files changed

+5
-8
lines changed

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ but cannot always guarantee backwards compatibility. Changes that may **break co
2626
- Fixed bug in `StaticCovariatesTransformer` where one-hot encoded column names were incorrectly assigned when the order of columns specified in `cols_cat` differed from the actual data column order. This caused silent data corruption where column names combined wrong feature names with wrong category values (e.g., `City_US` instead of `Country_US`). [#2989](https://github.com/unit8co/darts/pull/2989) by [Dustin Brunner](https://github.com/brunnedu).
2727
- Fixed a bug in `TorchTrainingDataset` where `max_samples_per_ts` was not acting as an upper bound on the number of samples per time series. Now `max_samples_per_ts` correctly acts as an upper bound, capping the dataset size at the actual number of samples that can be extracted from the longest series. [#2987](https://github.com/unit8co/darts/pull/2987) by [Dustin Brunner](https://github.com/brunnedu).
2828
- Updated s(m)ape to not raise a ValueError when actuals and predictions are zero for the same timestep. [#2984](https://github.com/unit8co/darts/pull/2984) by [eschibli](https://github.com/eschibli).
29+
- Updated outdated links to [holidays package](https://holidays.readthedocs.io/en/latest/#available-countries) in `TimeSeries`, `holidays_timeseries()`, and `Prophet`. [#2999](https://github.com/unit8co/darts/pull/2999) by [Zhihao Dai](https://github.com/daidahao).
2930

3031
**Dependencies**
3132

darts/models/forecasting/prophet_model.py

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -97,13 +97,9 @@ def __init__(
9797
..
9898
country_holidays
9999
An optional country code, for which holidays can be taken into account by Prophet.
100+
See `holidays package <https://holidays.readthedocs.io/en/latest/#available-countries>`__ for available
101+
country codes.
100102
101-
See: https://github.com/dr-prodigy/python-holidays
102-
103-
In addition to those countries, Prophet includes holidays for these
104-
countries: Brazil (BR), Indonesia (ID), India (IN), Malaysia (MY), Vietnam (VN),
105-
Thailand (TH), Philippines (PH), Turkey (TU), Pakistan (PK), Bangladesh (BD),
106-
Egypt (EG), China (CN), and Russia (RU).
107103
cap
108104
Parameter specifying the maximum carrying capacity when predicting with logistic growth.
109105
Mandatory when `growth = 'logistic'`, otherwise ignored.

darts/timeseries.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3532,7 +3532,7 @@ def add_holidays(
35323532
35333533
The holiday component is binary where `1` corresponds to a time step falling on a holiday.
35343534
3535-
Available countries can be found `here <https://github.com/dr-prodigy/python-holidays#available-countries>`__.
3535+
Available countries can be found `here <https://holidays.readthedocs.io/en/latest/#available-countries>`__.
35363536
35373537
This works only for deterministic time series (i.e., made of 1 sample).
35383538

darts/utils/timeseries_generation.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -520,7 +520,7 @@ def holidays_timeseries(
520520
Creates a binary univariate TimeSeries with index `time_index` that equals 1 at every index that lies within
521521
(or equals) a selected country's holiday, and 0 otherwise.
522522
523-
Available countries can be found `here <https://github.com/dr-prodigy/python-holidays#available-countries>`__.
523+
Available countries can be found `here <https://holidays.readthedocs.io/en/latest/#available-countries>`__.
524524
525525
Parameters
526526
----------

0 commit comments

Comments
 (0)