This project consists of a backend and a frontend. It requires a valid OPENAI_API_KEY to be placed in backend/.env
To run the backend, follow these steps:
- Create a virtual environment and install necessary packages
pip install -r backend/requirements.txt. - Change directory to the backend folder:
cd backend. - Run the backend application:
fastapi dev app.py.
To start the frontend, follow these steps:
- Start up a new terminal and change directory to the frontend folder:
cd frontend. - Install the required dependencies using yarn:
yarn. - Start the frontend development server:
yarn dev.
If you find this work useful in your research, please consider citing:
@article{khan2024faultexplainer,
title={FaultExplainer: Leveraging Large Language Models for Interpretable Fault Detection and Diagnosis},
author={Khan, Abdullah and Nahar, Rahul and Chen, Hao and Flores, Gonzalo E and Li, Can},
journal={arXiv preprint arXiv:2412.14492},
year={2024}
}