Switch to unified view

a/README.md b/README.md
1
# 🧬 GeneticsGPT 🔬
1
# 🧬 GeneticsGPT 🔬
2
2
3
GeneticsGPT is a powerful and intuitive application that leverages the OpenAI GPT-3.5-turbo model to provide insights and answers to genetic and disease-related questions. With its user-friendly interface and integration with the [Open Targets](https://platform.opentargets.org/) genetics database, this application makes it easy to explore and understand complex genetic information.
3
GeneticsGPT is a powerful and intuitive application that leverages the OpenAI GPT-3.5-turbo model to provide insights and answers to genetic and disease-related questions. With its user-friendly interface and integration with the [Open Targets](https://platform.opentargets.org/) genetics database, this application makes it easy to explore and understand complex genetic information.
4
4
5
## DEMO
5
6
7
![GeneticsGPT](demo1.png)
8
9
## 🌟 Features
6
## 🌟 Features
10
7
11
- 💬 Ask questions related to genetics and diseases
8
- 💬 Ask questions related to genetics and diseases
12
- 🔍 Get detailed answers based on the Open Targets genetics database
9
- 🔍 Get detailed answers based on the Open Targets genetics database
13
- 📜 View a list of frequently asked questions (FAQs) generated based on the query response
10
- 📜 View a list of frequently asked questions (FAQs) generated based on the query response
14
- 🙋‍♀️ Click on an FAQ to get a concise and informative answer
11
- 🙋‍♀️ Click on an FAQ to get a concise and informative answer
15
- 🧠 Powered by the OpenAI GPT-3.5-turbo model for accurate and relevant responses
12
- 🧠 Powered by the OpenAI GPT-3.5-turbo model for accurate and relevant responses
16
13
17
## 🚀 Getting Started
14
## 🚀 Getting Started
18
15
19
### Prerequisites
16
### Prerequisites
20
17
21
- Python 3.7 or higher
18
- Python 3.7 or higher
22
- OpenAI API key
19
- OpenAI API key
23
- PyQt5 library
20
- PyQt5 library
24
- requests library
21
- requests library
25
22
26
### Installation
23
### Installation
27
24
28
1. Clone the repository.
25
1. Clone the repository.
29
26
30
2. Install the required dependencies using pip.
27
2. Install the required dependencies using pip.
31
   
28
   
32
3. Set up your OpenAI API key:
29
3. Set up your OpenAI API key:
33
   - Sign up for an API key at [OpenAI](https://openai.com/).
30
   - Sign up for an API key at [OpenAI](https://openai.com/).
34
   - Replace `"your-openai-api-key"` in the code with your actual API key.
31
   - Replace `"your-openai-api-key"` in the code with your actual API key.
35
32
36
### Usage
33
### Usage
37
34
38
1. Run the application:
35
1. Run the application:
39
   ```
36
   ```
40
   python main.py
37
   python main.py
41
   ```
38
   ```
42
39
43
2. Enter your question related to genetics or diseases in the input field and click the "Submit" button.
40
2. Enter your question related to genetics or diseases in the input field and click the "Submit" button.
44
41
45
3. The application will display the query response in the answer widget on the left side.
42
3. The application will display the query response in the answer widget on the left side.
46
43
47
4. Generated FAQs will be listed below the answer widget. Click on an FAQ to view a concise answer in the answer text area on the right side.
44
4. Generated FAQs will be listed below the answer widget. Click on an FAQ to view a concise answer in the answer text area on the right side.
48
45
49
5. Explore the generated FAQs and their answers to gain insights into the genetic and disease-related information.
46
5. Explore the generated FAQs and their answers to gain insights into the genetic and disease-related information.
50
47
51
## 💡 Why Open Targets
48
## 💡 Why Open Targets
52
49
53
GeneticsGPT is a GPT-based search engine to translate natural language queries into valid GraphQL queries. This empowers users to easily explore and extract insights from the Open Targets dataset as currently Open Targets lacks a sophisticated search engine for complex queries, so this tool becomes very useful for drug discovery and genetics research.
50
GeneticsGPT is a GPT-based search engine to translate natural language queries into valid GraphQL queries. This empowers users to easily explore and extract insights from the Open Targets dataset as currently Open Targets lacks a sophisticated search engine for complex queries, so this tool becomes very useful for drug discovery and genetics research.
54
51
55
## 📄 License
52
## 📄 License
56
53
57
This project is licensed under the [MIT License](LICENSE).
54
This project is licensed under the [MIT License](LICENSE).
58
55
59
## 🙏 Acknowledgments
56
## 🙏 Acknowledgments
60
57
61
- [OpenAI](https://openai.com/) for providing the powerful GPT-3.5-turbo model
58
- [OpenAI](https://openai.com/) for providing the powerful GPT-3.5-turbo model
62
- [Open Targets](https://www.opentargets.org/) for the genetics database and GraphQL API
59
- [Open Targets](https://www.opentargets.org/) for the genetics database and GraphQL API
63
- [PyQt5](https://pypi.org/project/PyQt5/) for the graphical user interface framework
60
- [PyQt5](https://pypi.org/project/PyQt5/) for the graphical user interface framework
64
- Inspired from cx0
61
- Inspired from cx0
65
62
66
## 🤝 Contributing
63
## 🤝 Contributing
67
64
68
Contributions are welcome! If you have any ideas, suggestions, or bug reports, please open an issue or submit a pull request.
65
Contributions are welcome! If you have any ideas, suggestions, or bug reports, please open an issue or submit a pull request.
69
66
70
## TODO
67
## TODO
71
68
72
- Add a discord chat bot (lets make it more accessible)
69
- Add a discord chat bot (lets make it more accessible)
73
70
74
## 📧 Contact
71
## 📧 Contact
75
72
76
For any questions or inquiries, please contact [owensingh72@gmail.com](mailto:owensingh72@gmail.com).
73
For any questions or inquiries, please contact [owensingh72@gmail.com](mailto:owensingh72@gmail.com).
77
74
78
---
75
---
79
76
80
Please leave a star on the repository! 🧬✨
77
Please leave a star on the repository! 🧬✨