functime-org / functime

Time-series machine learning at scale. Built with Polars for embarrassingly parallel feature extraction and forecasts on panel data.

https://docs.functime.ai

Apache License 2.0

1.02k stars 55 forks source link

Docs: `FeatureExtractor` rendering #169

Open FBruzzesi opened 8 months ago

FBruzzesi commented 8 months ago

Description

feature-extractors doc page renders automatically:

All functionalities (properly and as expected)
FeatureExtractor class that serves to register the polars ts namespace

I am not sure if this was intended to be for internal use only, yet outputs of these methods are way less documented that those of the original functions.

Example

FeatureExtractor.absolute_energy method
absolute_energy function

baggiponte commented 8 months ago

Been on my wishlist for a bit, thanks for opening the issue. I haven't dug into the docs yet but it should definitely be fixed. I think we could simply make the FeatureExtractor private. What do you think @abstractqqq?