https://github.com/wbsuh/sop-crewai
CrewAi template for creating business/regulation specific SOP (Standard Operating Procedures)
https://github.com/wbsuh/sop-crewai
Last synced: 5 months ago
JSON representation
CrewAi template for creating business/regulation specific SOP (Standard Operating Procedures)
- Host: GitHub
- URL: https://github.com/wbsuh/sop-crewai
- Owner: wbsuh
- License: apache-2.0
- Created: 2024-03-27T05:01:31.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-29T07:38:09.000Z (about 1 year ago)
- Last Synced: 2024-08-13T07:07:38.981Z (9 months ago)
- Language: Python
- Homepage:
- Size: 84 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - wbsuh/sop-crewai - CrewAi template for creating business/regulation specific SOP (Standard Operating Procedures) (Python)
README
# CrewAI SOP Writer Template
CrewAI is a template for creating business-specific Standard Operating Procedures (SOPs). This project aims to streamline the process of developing SOPs that align with the ICH E6(R3) guideline or any regulatory requirements to promote quality and risk management in clinical trials.
## Requirements
To run this project, you need to have Python installed on your system. The required Python packages are listed in the `requirements.txt` file. You need a subscription to OpenAI to power the Agents.
## Installation
1. Clone the repository:
```
git clone git@github.com:wbsuh/sop-crewai.git
```2. Navigate to the project directory:
```
cd sop-crewai
```
3. Create a virtual environment (optional but recommended)
```
python -m venv venv```
4. Activate the virtual environment:- For Windows:
```
venv\Scripts\activate
```
- For macOS and Linux:
```
source venv/bin/activate
```5. Install the required packages:
```
pip install -r requirements.txt
```
6. In the directory create .env file and add the following:
```
OPENAI_API_KEY = "YOUR_OPENAI_KEYS"
OPENAI_MODEL_NAME = "gpt-4-0125-preview"
```## How to Run
1. Place your reference documents in the `Regulatory_Documents` directory. These documents should provide guidance and requirements for developing SOPs related to IT computerized systems in clinical trials or any other regulatory requirements of your choosing.
2. Run the SOP CrewAI script:
```
python main.py
```3. The generated drafts will be saved in the `output` directory.
## Reference Documents
The `Regulatory_Documents` directory is where you should place your reference documents. These documents serve as a guide for developing SOPs that comply with the ICH E6(R3) guideline and other relevant regulations.
Examples of reference documents include:
- ICH E6(R3) guideline
- Regulatory requirements specific to your region or country
- Internal company policies and proceduresMake sure to review and update these reference documents regularly to ensure your SOPs remain up-to-date with the latest guidelines and best practices.
## Optional
Included a template `sopoutline.md` to help you get started with the SOP development process. You can use this as a reference for the structure and content of your SOP. Modify it as needed to fit your specific needs and requirements.## Limitations
With changes to the OpenAI model to GPT-4-Turbo it is cheaper to run than default GPT-4. Now supports a larger context window to accept more complex and detailed documents for initial analysis.## Enhancements/ To-Do
- [ ] UI for the SOP CrewAI Writer
- [ ] Options to select LLM model eg. Anthrophic Opus
- [ ] Web Search Tool to augment the SOP with additional information
- [ ] SOP MD to Document conversion
- [ ] Refactor Tools, Tasks, Agents
- [ ] Add PDF search tool for SOP writer to find specific context