Core Module Documentation#

class neuralprophet.hdays.BY(**kwargs)#
country: str#

The country’s ISO 3166-1 alpha-2 code.

expand: bool#

Whether the entire year is calculated when one date from that year is requested.

market: str#

The market’s ISO 3166-1 alpha-2 code.

observed: bool#

Whether dates when public holiday are observed are included.

years: Set[int]#

The years calculated.

class neuralprophet.hdays.Belarus(**kwargs)#

Implement public holidays in Belarus

Reference: https://en.wikipedia.org/wiki/Public_holidays_in_Belarus

Please note: Some holidays might collide with weekends and therefore not compensated with next business day as International Women’s Day

country: str#

The country’s ISO 3166-1 alpha-2 code.

expand: bool#

Whether the entire year is calculated when one date from that year is requested.

market: str#

The market’s ISO 3166-1 alpha-2 code.

observed: bool#

Whether dates when public holiday are observed are included.

years: Set[int]#

The years calculated.

class neuralprophet.hdays.ID(**kwargs)#
country: str#

The country’s ISO 3166-1 alpha-2 code.

expand: bool#

Whether the entire year is calculated when one date from that year is requested.

market: str#

The market’s ISO 3166-1 alpha-2 code.

observed: bool#

Whether dates when public holiday are observed are included.

years: Set[int]#

The years calculated.

class neuralprophet.hdays.Indonesia(**kwargs)#

Implement public holidays in Indonesia

Reference: https://en.wikipedia.org/wiki/Public_holidays_in_Indonesia

Please note: Indonesia is a multi-cultural community and we only implement the national wide public holidays.

country: str#

The country’s ISO 3166-1 alpha-2 code.

expand: bool#

Whether the entire year is calculated when one date from that year is requested.

market: str#

The market’s ISO 3166-1 alpha-2 code.

observed: bool#

Whether dates when public holiday are observed are included.

years: Set[int]#

The years calculated.

class neuralprophet.hdays.PH(**kwargs)#
country: str#

The country’s ISO 3166-1 alpha-2 code.

expand: bool#

Whether the entire year is calculated when one date from that year is requested.

market: str#

The market’s ISO 3166-1 alpha-2 code.

observed: bool#

Whether dates when public holiday are observed are included.

years: Set[int]#

The years calculated.

class neuralprophet.hdays.PK(**kwargs)#
country: str#

The country’s ISO 3166-1 alpha-2 code.

expand: bool#

Whether the entire year is calculated when one date from that year is requested.

market: str#

The market’s ISO 3166-1 alpha-2 code.

observed: bool#

Whether dates when public holiday are observed are included.

years: Set[int]#

The years calculated.

class neuralprophet.hdays.Pakistan(**kwargs)#

Implement public holidays in Pakistan

Reference: https://en.wikipedia.org/wiki/Public_holidays_in_Pakistan

country: str#

The country’s ISO 3166-1 alpha-2 code.

expand: bool#

Whether the entire year is calculated when one date from that year is requested.

market: str#

The market’s ISO 3166-1 alpha-2 code.

observed: bool#

Whether dates when public holiday are observed are included.

years: Set[int]#

The years calculated.

class neuralprophet.hdays.Philippines(**kwargs)#

Implement public holidays in Philippines

Reference: https://en.wikipedia.org/wiki/Public_holidays_in_Thailand

country: str#

The country’s ISO 3166-1 alpha-2 code.

expand: bool#

Whether the entire year is calculated when one date from that year is requested.

market: str#

The market’s ISO 3166-1 alpha-2 code.

observed: bool#

Whether dates when public holiday are observed are included.

years: Set[int]#

The years calculated.

class neuralprophet.hdays.TH(**kwargs)#
country: str#

The country’s ISO 3166-1 alpha-2 code.

expand: bool#

Whether the entire year is calculated when one date from that year is requested.

market: str#

The market’s ISO 3166-1 alpha-2 code.

observed: bool#

Whether dates when public holiday are observed are included.

years: Set[int]#

The years calculated.

class neuralprophet.hdays.TU(**kwargs)#
expand: bool#

Whether the entire year is calculated when one date from that year is requested.

market: str#

The market’s ISO 3166-1 alpha-2 code.

observed: bool#

Whether dates when public holiday are observed are included.

years: Set[int]#

The years calculated.

class neuralprophet.hdays.Thailand(**kwargs)#

Implement public holidays in Thailand

Reference: https://en.wikipedia.org/wiki/Public_holidays_in_Thailand

country: str#

The country’s ISO 3166-1 alpha-2 code.

expand: bool#

Whether the entire year is calculated when one date from that year is requested.

market: str#

The market’s ISO 3166-1 alpha-2 code.

observed: bool#

Whether dates when public holiday are observed are included.

years: Set[int]#

The years calculated.