[](https://badge.fury.io/py/clarifyquestgen)
[](https://opensource.org/licenses/MIT)
[](https://pepy.tech/project/clarifyquestgen)
# ClarifyingQuestionsGenerator
`ClarifyingQuestionsGenerator` is a Python package designed to refine task descriptions through an iterative process of asking clarifying questions. It uses GPT models from OpenAI to generate questions and refine tasks, streamlining the process of task clarification and ensuring tasks are well-understood and actionable.
## Installation
To install `ClarifyingQuestionsGenerator`, you can use pip:
```bash
pip install clarifyquestgen
```
## Usage
### As a Python Module
You can use `ClarifyingQuestionsGenerator` as a module in your Python scripts.
Example:
```python
from clarifyquestgen import ClarifyingQuestionsGenerator
# Initialize the generator with a task, instruction, and your OpenAI API key
clarifier = ClarifyingQuestionsGenerator(
task="Describe the task here",
instruction="Additional instructions here",
gpt_api_key='your-openai-api-key'
)
# Run the generator to refine your task
refined_task = clarifier.run()
print("Refined Task Description:")
print(refined_task)
```
### Customizing Your Generator
You can customize the behavior of `ClarifyingQuestionsGenerator` by adjusting the initialization parameters, such as the model, temperature, max tokens, etc., to fit the specific needs of your application or to tweak the behavior of the GPT model.
## Output Example
When you run `ClarifyingQuestionsGenerator`, it iteratively asks questions, refines the task, and analyzes its feasibility until a satisfactory level of clarity and feasibility is reached. Here is an example interaction:
```
Question 1: What specific parts of the database schema need to be refactored?
...user chooses an answer...
Question 2: What is the expected format or style of the comments?
...user chooses an answer...
...
Refined Task Description:
Refined task: Add comments to specific sections or functions within two code files. Follow the expected format for comments and adhere to specific guidelines or conventions provided.
```
## Contributing
Contributions, issues, and feature requests are welcome! Feel free to check [issues page](https://github.com/yourusername/ClarifyingQuestionsGenerator/issues).
## License
[MIT](https://choosealicense.com/licenses/mit/)
Raw data
{
"_id": null,
"home_page": "https://github.com/chigwell/ClarifyingQuestionsGenerator",
"name": "clarifyquestgen",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "Eugene Evstafev",
"author_email": "chigwel@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/7e/97/37727e17ad99be1b6232b0c2424ad4b5d13f81cfcc0396fc778be2473ee8/clarifyquestgen-0.0.5.tar.gz",
"platform": null,
"description": "[](https://badge.fury.io/py/clarifyquestgen)\n[](https://opensource.org/licenses/MIT)\n[](https://pepy.tech/project/clarifyquestgen)\n\n# ClarifyingQuestionsGenerator\n\n`ClarifyingQuestionsGenerator` is a Python package designed to refine task descriptions through an iterative process of asking clarifying questions. It uses GPT models from OpenAI to generate questions and refine tasks, streamlining the process of task clarification and ensuring tasks are well-understood and actionable.\n\n## Installation\n\nTo install `ClarifyingQuestionsGenerator`, you can use pip:\n\n```bash\npip install clarifyquestgen\n```\n\n## Usage\n\n### As a Python Module\n\nYou can use `ClarifyingQuestionsGenerator` as a module in your Python scripts.\n\nExample:\n\n```python\nfrom clarifyquestgen import ClarifyingQuestionsGenerator\n\n# Initialize the generator with a task, instruction, and your OpenAI API key\nclarifier = ClarifyingQuestionsGenerator(\n task=\"Describe the task here\",\n instruction=\"Additional instructions here\",\n gpt_api_key='your-openai-api-key'\n)\n\n# Run the generator to refine your task\nrefined_task = clarifier.run()\nprint(\"Refined Task Description:\")\nprint(refined_task)\n```\n\n### Customizing Your Generator\n\nYou can customize the behavior of `ClarifyingQuestionsGenerator` by adjusting the initialization parameters, such as the model, temperature, max tokens, etc., to fit the specific needs of your application or to tweak the behavior of the GPT model.\n\n## Output Example\n\nWhen you run `ClarifyingQuestionsGenerator`, it iteratively asks questions, refines the task, and analyzes its feasibility until a satisfactory level of clarity and feasibility is reached. Here is an example interaction:\n\n```\nQuestion 1: What specific parts of the database schema need to be refactored?\n...user chooses an answer...\nQuestion 2: What is the expected format or style of the comments?\n...user chooses an answer...\n...\nRefined Task Description:\nRefined task: Add comments to specific sections or functions within two code files. Follow the expected format for comments and adhere to specific guidelines or conventions provided.\n```\n\n## Contributing\n\nContributions, issues, and feature requests are welcome! Feel free to check [issues page](https://github.com/yourusername/ClarifyingQuestionsGenerator/issues).\n\n## License\n\n[MIT](https://choosealicense.com/licenses/mit/)\n\n\n",
"bugtrack_url": null,
"license": "",
"summary": "Clarifying Questions Generator for task refinement",
"version": "0.0.5",
"project_urls": {
"Homepage": "https://github.com/chigwell/ClarifyingQuestionsGenerator"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "873e5985091eb4c813f561d4a273a341dba6fdb114adc2beb78d135472776f5e",
"md5": "1cff63b5c02bf8e9b5870f87ff613c17",
"sha256": "5f808687fa93329ee6212b91e5930fd3cfce14024377d0dc09d7f95bfc343766"
},
"downloads": -1,
"filename": "clarifyquestgen-0.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1cff63b5c02bf8e9b5870f87ff613c17",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 5423,
"upload_time": "2024-01-06T17:40:43",
"upload_time_iso_8601": "2024-01-06T17:40:43.835466Z",
"url": "https://files.pythonhosted.org/packages/87/3e/5985091eb4c813f561d4a273a341dba6fdb114adc2beb78d135472776f5e/clarifyquestgen-0.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7e9737727e17ad99be1b6232b0c2424ad4b5d13f81cfcc0396fc778be2473ee8",
"md5": "fb46736901671e68f47f5cd5bce0942a",
"sha256": "4490e05d5e4a8e8f2299770ebaccf6ec92db2cb2dc064d15b3c6d128c5d07712"
},
"downloads": -1,
"filename": "clarifyquestgen-0.0.5.tar.gz",
"has_sig": false,
"md5_digest": "fb46736901671e68f47f5cd5bce0942a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 4401,
"upload_time": "2024-01-06T17:40:46",
"upload_time_iso_8601": "2024-01-06T17:40:46.472401Z",
"url": "https://files.pythonhosted.org/packages/7e/97/37727e17ad99be1b6232b0c2424ad4b5d13f81cfcc0396fc778be2473ee8/clarifyquestgen-0.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-06 17:40:46",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "chigwell",
"github_project": "ClarifyingQuestionsGenerator",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "clarifyquestgen"
}
JSON
