Create the README.md as the following sections:

Project description: Simple explanation of the main objective and target population
Data Dependencies: Simple data dictionary to describe the data sources and input columns
Usage: How we can reproduce your experiment?
Repository structure: Simple explanation on folders and files structures

Some refs:

For example:

</h1> <h2>Project Description</h2> <p>This project is a <code><type_of_modeling></code> that <code><do_something></code> to solve <code><this_problem></code> aimed to the clients of the <code><some_business></code>.</p> <h2>Data Dependencies</h2> <p>We are using the following Data Sources:</p> <table> <thead> <tr> <th>Source</th> <th>Description</th> <th>Year</th> </tr> </thead> <tbody> <tr> <td>Some Company</td> <td>...</td> <td>2000 - 2021</td> </tr> </tbody> </table> <h2>Usage</h2> <p>To run some experiment:</p> <pre><code class="language-sh">git clone <LINK TO THE REPO> cd <REPO> pip install -r requirements.txt jupyter notebook notebooks/<EXPERIMENT NAME>.ipynb</code></pre> <p>To run some productized model pipeline step:</p> <pre><code class="language-sh">cd src python main.py --help # Shows usage information. python main.py features # Generate features python main.py deploy_model # Deploy model python main.py evaluate_model # Evaluate model python main.py run # Run all model pipeline steps sequencially</code></pre> <p>To install this project as a lib:</p> <pre><code>pip install <LIB NAME></code></pre> <h2>Repository structure</h2> <ul> <li><code>scripts</code>: contains some scripts to collect data</li> <li><code>docs</code>: contains extra documentation of the project (slides, data catalog, etc.)</li> <li><code>notebooks</code>: contains jupyter notebook experiments needed to collect, explore, prepare data, train and evaluate data.</li> <li><code>requirements.txt</code>: contains python dependencies to reproduce the experiments.</li> </ul> </div> </div> <div class="comment"> <div class="user"> <a rel="noreferrer nofollow" target="_blank" href="https://github.com/dunfrey"><img src="https://avatars.githubusercontent.com/u/11588256?v=4" />dunfrey</a> commented <strong> 3 years ago</strong> </div> <div class="markdown-body"> <p><a href="https://github.com/dunfrey/BCG-GAMMA-Challenge-2021">https://github.com/dunfrey/BCG-GAMMA-Challenge-2021</a></p> </div> </div> <div class="page-bar-simple"> </div> <div class="footer"> <ul class="body"> <li>© <script> document.write(new Date().getFullYear()) </script> Githubissues.</li> <li>Githubissues is a development platform for aggregating issues.</li> </ul> </div> <script src="https://cdn.jsdelivr.net/npm/jquery@3.5.1/dist/jquery.min.js"></script> <script src="/githubissues/assets/js.js"></script> <script src="/githubissues/assets/markdown.js"></script> <script src="https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@11.4.0/build/highlight.min.js"></script> <script src="https://cdn.jsdelivr.net/gh/highlightjs/cdn-release@11.4.0/build/languages/go.min.js"></script> <script> hljs.highlightAll(); </script> </body> </html>

dunfrey / BCG-GAMMA-Challenge-2021