search

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
2.99k stars 400 forks source link

Create gifs with folder structure after AutoML training #221

Open pplonski opened 3 years ago

pplonski commented 3 years ago

Create gifs with folder structure after AutoML training and add them to the Readme

aakarsh1011 commented 3 years ago

Hi, I want to work on this feature, and I want to get more info on it. By the way, I'm new to the open-source world, so please bear with me.

pplonski commented 3 years ago

Hi @aakarsh1011,

Great, happy to see you here. This issue is to improve docs/readme.

After running MLJAR AutoML there is produced a results directory with many files. I was thinking about making a GIF that will show simple training (for example on Titanic data which is well-known) and then show the output files and output README.md reports. The plan for such GIF can be:

  1. Show code for training on Titanic data.
  2. Show output from training.
  3. Show results directory with files.
  4. Present README.md files (display reports).

The final GIF will be some kind of video/presentation that will showcase the features of MLJAR AutoML. The final GIF will be added to the package README.

@aakarsh1011 what do you think?

aakarsh1011 commented 3 years ago

That sounds great, I will try to implement the same and update it in the readme..

aakarsh1011 commented 3 years ago

Hey @pplonski, so I have the results folder and I wanted to all the requirements mentioned above should be in 1 single gif ?

pplonski commented 3 years ago

@aakarsh1011 yes, the gif should show all good things that are created with the package.

aakarsh1011 commented 3 years ago

I have uploaded the gif on mljar/mljar-examples and created a pull request their take a look and tell me if it required changes and I will do the needful.

pplonski commented 3 years ago

@aakarsh1011 I like GIF very much. Great job. I've added it to the package readme. You can check it here https://github.com/mljar/mljar-supervised#demo - feel free to add more description to the readme.

What software have you used for GIF creation?

Is this your Twitter account https://twitter.com/yadavaakarsh? I will ask @aplonska to tweet about your great demo.

Thank you!

aakarsh1011 commented 3 years ago

@pplonski Thank you so much and yes that is my Twitter handle. I am using a software called "LICEcap"