Skip to main content

Structure for the entire AI App Suite

App Layout

The final goal is to make an app out of the entire pipe_breaks repository.

Documentation

  1. Initial thoughts, stick with a documentation service which can be tracked on Git
  2. Have the docs organize, so that one can quickly search through the entire document and see all docs together in a single place
  3. Deven started with docusaurus
    1. For meeting notes
    2. Design discussions and app layouts

Repository

  1. Everything right now in the repository comes together with the script_runner.py file.
  2. Need for some docstrings and something like readthedocs or pydocs or nbdev

For designing the app

  1. Take out individual functions from the script_runner.py file, try giving them a UI.
  2. For instance,
    1. Data cleaning, separate option in the sidebar to do data cleaning
    2. Once the data is cleaned and appropriate parameters are selected, choose the model
    3. Specify the model parameters to run the model, design a separate tab for that
    4. Once all the inputs are ready, you can have the model run
    5. Once the execution is complete, have the results show up in a clean manner