this is a list of rules to follow for contributing Base Class Abstractions to Utils.

Harvester Base Class

All the harvester that are going to be submitted must inherit from this base class and later implement the methods by overriding it.

class taiyo_utils.harvester.IndexerHarvester()

This is the base class for the all the harvesters.

basicPreprocess(self)

This should do the basic preprocessing on the fetched data. Some of them includes:

  • Setting index as "Timestamp".
  • Sorting the index.
  • Remove NaN and other forms of missing values.
getData(self)

The implementation of this function should serve as a data fetcher. It should fetch the data from the respective sources and store it in the "self.data" for later use.

Models Base Class

class taiyo_utils.models.IndexerModel()

This is an abstract class that is used as a parent class for all model abstractions

build_model(self, *args, **kwargs)
compile_model(self, *args, **kwargs)
fit_model(self, *args, **kwargs)
get_model(self)
get_params(self)
load_model(self, weights_path)
predict(self, *args, **kwargs)
save_model(self, weights_path)