A comprehensive tool for sentiment analysis and tone review, empowered by GPT4ALL.
Project description
GPT4ALL Tone Analyzer
gpt4all-tone
is a comprehensive tool for sentiment analysis and tone review, empowered by GPT4ALL. It reads a text input and evaluates the sentiment, returning a numerical value indicating the sentiment of the text.
Installation
- Clone this repository to your local machine or install via pip:
pip install gpt4all-tone
or
pip3 install gpt4all-tone
- Ensure you have the
gpt4all
library installed. It will be installed automatically if you installgpt4all-tone
via pip.
Usage
You can use this tool via the command line or import it into your Python project.
Command Line Usage:
gpt4all_tone --model "orca-mini-3b.ggmlv3.q4_0.bin" --char-limit 2000 "Your text here"
Parameters:
--model
: Specifies the model name. Default isorca-mini-3b.ggmlv3.q4_0.bin
.--char-limit
: Specifies the character limit for the prompt. Default is2000
.input
: Specifies the input text to analyze.
Python Usage:
from gpt4all_tone import ToneAnalyzer
analyzer = ToneAnalyzer("orca-mini-3b.ggmlv3.q4_0.bin", "Your text here")
result = analyzer.run()
print(result)
Output
The script will return a numerical value indicating the sentiment of the text based on the following scale:
1
: Positive tone0.75
: More Positive tone0.5
: Neutral tone0.25
: More Negative tone0
: Negative tone
In case the sentiment analysis encounters an issue or can't determine the sentiment, it will return -1
.
Contributing
Feel free to fork this repository, create a feature branch, and send us a pull request.
Contact
- Author: Evgenii Evstafev
- Email: chigwel@gmail.com
- GitHub Repository
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for gpt4all_tone-0.21-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3e41078c3c0be0deccfd1a89009ffc9415cbb728a4aef4aab507772b1cfa5c12 |
|
MD5 | a54502bac75483291b6d1b9eb6bc043f |
|
BLAKE2b-256 | 418741ebfbd74681f527f9286f4a7751d6cb835054ef01ec0687cdcc24519b0e |