search

timeseriesAI / tsai

Time series Timeseries Deep Learning Machine Learning Python Pytorch fastai | State-of-the-art Deep Learning library for Time Series and Sequences in Pytorch / fastai
https://timeseriesai.github.io/tsai/
Apache License 2.0
5.07k stars 633 forks source link

Need user guide, api reference and better search result from documentation. #698

Closed langslike closed 1 year ago

langslike commented 1 year ago

Hi I am learning to use tsai, but the documentation isn't quite handy, for example, when I read the tutoria notebooks , I encountered learn.fit_one_cycle(25, lr_max=1e-3) So I went to check the usage of this function , but the search box on the documentation site didn't give much help, it just lists out many code snippets other than detailed function usage, I think this hinders people from learning tsai. Hope for a better documentation.

oguiza commented 1 year ago

Thank you for your feedback. I appreciate it. I'm sorry to hear that you find too many things missing in the documentation. You need to bear in mind that tsai is built on top of fastai. I'd recommend you to visit https://docs.fast.ai/ if you are not familiarized with it. I do not currently have any plans to replicate fastai's documentation here. But I can add a comment about this on tsai's documentation.

langslike commented 1 year ago

Do I need some fastai knowledge before learning tsai? Advice is needed :)

oguiza commented 1 year ago

It would certainly help since tsai is built on top of fastai, so it leverages much of its functionality. I would review the documentation in particular in regards to the Learner object and training.

langslike commented 1 year ago

Thanks a lot.

oguiza commented 1 year ago

@langslike, is it ok if I close this issue?

langslike commented 1 year ago

Sure.