Add link to EDA in main report

mljar / mljar-supervised

Python package for AutoML on Tabular Data with Feature Engineering, Hyper-Parameters Tuning, Explanations and Automatic Documentation

https://mljar.com

MIT License

3k stars 401 forks source link

Closed pplonski closed 3 years ago

pplonski commented 4 years ago

In main README.md there should be a link to EDA if it is available.

Detail desc:

in the file supervised/base_automl.py there is created main README.md for AutoML in select_and_save_best()
at the end of this file we can add a link to Automated Exploratory Data Analysis if there is EDA/README.md file available in self._results_path
We can add in Markdown something like:

## Automated Exploratory Data Analysis 

There is Automated EDA available in this [report](EDA/README.md).

tinomaxthayil commented 4 years ago

I'm interested.

pplonski commented 4 years ago

@tinomaxthayil great!

Please check:

contributing guide https://github.com/mljar/mljar-supervised/blob/master/docs/contributing.md
I would like to see 2 tests for this new code. One test for EDA available and one for missing EDA dir. If you will need help with tests please let me know.

In case of any questions, I'm happy to help.

Good luck!

tinomaxthayil commented 4 years ago

Yeah sure. I'll keep you updated.

pplonski commented 3 years ago

@LukasKaspras what about this issue? This one is perfect for start.

LukasKaspras commented 3 years ago

@pplonski Great! I'll look into it this weekend! (Just noticed that it's going to take me more than this weekend probably)

pplonski commented 3 years ago

I've added Go back links to EDA readme files. Closing.