sfu-db / dataprep

Open-source low code data preparation library in python. Collect, clean and visualization your data in python with a few lines of code.
http://dataprep.ai
MIT License
2.08k stars 206 forks source link

Make the documentation more lightweight and readable #951

Open rluthi opened 1 year ago

rluthi commented 1 year ago

DataPrep is a great tool! And the automatic EDA module is probably the best open-source option out there.

However, I find your package difficult to understand and learn from your documentation. It makes it feels more complicated than it actually is.

Some ideas to improve :

rluthi commented 1 year ago

If you are interested, I could have a go at this

anthng commented 1 year ago

If you are interested, I could have a go at this

I agree with you, the documentation is too difficult to learn. Param in each function does not represent clearly in your docs. I hope Datapre improves to better than, anyway this is the best Auto EDA I've used

dovahcrow commented 1 year ago

Yep I agree. We do have an ongoing branch which switches sphinx to jupyterbook and tidies things up a little bit. I'll share the branch here once it can build successfully. Thanks for your interest in helping out! @rluthi