Git Product home page Git Product logo

qualigpt's Introduction

QualiGPT

QualiGPT: An easy-to-use tool for qualitative research (automatic coding)

Logo-QualiGPT

Static Badge Static Badge License

Python version Static Badge

QualiGPT is a toolkit with a visual interactive interface based on the OpenAI API. It can assist qualitative analysts in quickly coding data from interviews, focus groups, or social media (posts or comments) stored in Word documents or spreadsheets (.xlsx or .csv). The results can be saved in .txt or .csv formats for easy and quick viewing.

Logo-QualiGPT

Figure 1. Overview of the qualitative analysis toolkit, QualiGPT. The user interface of QualiGPT is displayed on the left. On the right side, the usage flow and design logic of QualiGPT are presented.

Before running, please check your Python environment and install the appropriate packages using pip install . The list of required packages is as follows:

  • pip install nltk
  • pip install openai
  • pip install PyQt5
  • pip install python-docx
  • pip install docx2txt
  • pip install pandas

QualiGPT-v0.1.0-alpha

We have released the QualiGPT-v0.1.0-alpha (Windows) version for testing. If you prefer not to build from the source code, please use this version.

QualiGPT-v0.1.0-alpha Release Notes

Click here to read QualiGPT-v0.1.0-alpha Release Notes

QuickStart

Please download QualiGPT-v0.1.0-alpha.exe from Version Release.

Source Code & Usage

We have fully open-sourced the early version of this program, providing both .py and .ipynb files to build QualiGPT-v0.1.0-alpha. For a detailed description, please refer to the Version Release.

  1. Please download the QualiGPTApp.py file from repository.
  2. Navigate to the directory, for example, cd ../QualiGPT
  3. Install the required packages pip install -r requirements.txt (If you prefer not to use the requirements.txt file, you can manually install each package.)
  4. Once you have installed all the packages required for this tool, please run (python QualiGPTApp.py) through the command prompt (cmd), or (highly recommended) compile from VS Code. If you are using Jupyter Notebook, please convert QualiGPTApp.py to QualiGPTApp.ipynb. Please note that after each run, you'll need to restart the kernel to run it again.

How to get OpenAI API.

  • Please register and log in to OpenAI to request your personal API key and keep it safe.

User manual

Please follow the user manual to use QualiGPT.

  • Step 1. ① (enter the API Key)
  • Step 2. ② (connect to API)
  • Step 3. ③ (select dataset)
  • Step 4. ④ (submit dataset)
  • Step 5. ⑤ (optional)
  • Step 6. ⑥ (optional)
  • Step 7. ⑦ (select the type of dataset)
  • Step 8. ⑧ (select the number of themes)
  • Step 9. ⑨ (optional)
  • Step 10. ⑩ (submit the task)
  • Step 11. ⑪ or ⑫ (save results)

User manual

Figure 2. User manual

Citation

Please cite these papers in your publications if QualiGPT helps your research. The theoretical foundation for developing QualiGPT comes from: Redefining Qualitative Analysis in the AI Era: Utilizing ChatGPT for Efficient Thematic Analysis.

@misc{zhang2023redefining, title={Redefining Qualitative Analysis in the AI Era: Utilizing ChatGPT for Efficient Thematic Analysis}, author={He Zhang and Chuhao Wu and Jingyi Xie and Yao Lyu and Jie Cai and John M. Carroll}, year={2023}, eprint={2309.10771}, archivePrefix={arXiv}, primaryClass={cs.HC} }

@misc{zhang2023qualigpt, title={QualiGPT: GPT as an easy-to-use tool for qualitative coding}, author={He Zhang and Chuhao Wu and Jingyi Xie and ChanMin Kim and John M. Carroll}, year={2023}, eprint={2310.07061}, archivePrefix={arXiv}, primaryClass={cs.HC} }

License

QualiGPT is freely available for use, and may be redistributed any content in this repository under the Creative Commons Attribution 4.0 International Public License and the MIT License. QualiGPT is freely available for academic and commercial use. We hope it benefits the research community and facilitates further advancements in the field. We encourage users to contribute and provide feedback to improve the tool.

Additional Notes

This project is one of the works in a series of projects. To view the complete project, please visit the LLMs x Generative AI Project.

qualigpt's People

Contributors

kindopstar avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.