Skip to content
This repository was archived by the owner on Nov 8, 2025. It is now read-only.

Commit 2ffc720

Browse files
author
Vivek Dagar
authored
docs: update sentiment analysis in readme.md and fix demo screenshot link
1 parent 269aad5 commit 2ffc720

File tree

1 file changed

+20
-8
lines changed

1 file changed

+20
-8
lines changed

README.md

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121

2222

2323
<h2><a id="srn"> :camera:</a> Demo screenshot</h2>
24-
<div align="center"> <a href=""><img src="https://github.com/vivekkdagar/pyquantify/blob/main/assets/demo.png" alt='image' width='800'/></a> </div>
24+
<div align="center"> <a href=""><img src="https://github.com/vivekkdagar/pyquantify/blob/main/sample-output/demo.png" alt='image' width='800'/></a> </div>
2525

2626

2727
<h2><a id="feat">:dart:</a> Features</h2>
@@ -34,13 +34,17 @@
3434

3535
4. **Export Functionality**: Optionally export generated metrics, frequency tables, and visualizations to files.
3636

37-
5. **Word Cloud Visualization**: Create and display a word cloud visualization of processed text data.
37+
5. **Visualization**:
38+
- Generate and visualize the frequency of the top 20 words in the text.
39+
- Create and display a word cloud visualization of processed text data.
3840

39-
6. **Word Frequency Chart**: Generate and visualize the frequency of the top 20 words in the text.
41+
6. **Interactive Commands**: Utilize command-line interface commands for actions like displaying metrics, limiting results, searching for specific words, and generating visualizations.
4042

41-
7. **Interactive Commands**: Utilize command-line interface commands for actions like displaying metrics, limiting results, searching for specific words, and generating visualizations.
43+
7. **Summarize Text**: Summarize text using a BERT Extractive Summarizer.
4244

43-
8. **Summarize Text**: Summarize text using a BERT Extractive Summarizer.
45+
8. **Sentiment Analysis**:
46+
- Perform sentiment analysis on the text.
47+
- Provides insights into sentiment polarity and subjectivity.
4448

4549

4650
<h2><a id="strt"> :toolbox:</a> Getting Started</h2>
@@ -93,8 +97,6 @@ pyquantify
9397

9498
Pyquantify provides several commands for analyzing and visualizing text data. Below is a guide on how to use the key functionalities:
9599

96-
Certainly! Below are the corrected usage commands based on the provided code:
97-
98100
1. **Search for a Specific Word in Morphological Analysis:**
99101

100102
```bash
@@ -142,12 +144,21 @@ Certainly! Below are the corrected usage commands based on the provided code:
142144

143145
- `--mode`: Specify the data loading mode (raw input, file, or website).
144146
- `--export`: Optional flag to export the summary to a file.
147+
148+
6. **Sentiment Analysis**
149+
150+
```bash
151+
pyquantify sentiment-analysis --mode [raw/file/website] --export
152+
```
153+
154+
- `--mode`: Specify the data loading mode (raw input, file, or website).
155+
- `--export`: Optional flag to export the summary to a file.
145156

146157
### Additional Commands
147158

148159
- View the Pyquantify GitHub page:
149160
```bash
150-
pyquantify --git [any command with its parameters]
161+
pyquantify --git
151162
```
152163

153164
Feel free to explore additional options and functionalities by checking the help documentation for each command:
@@ -182,4 +193,5 @@ NLPFreq felt limiting and didn't capture the full scope of the project. Pyquanti
182193
- [NeuralNine's Publish Your Own Python Package](https://www.youtube.com/watch?v=tEFkHEKypLI)
183194

184195
<hr/>
196+
185197
**Note:** Pyquantify has undergone thorough testing on Linux, and its functionality is confirmed to work seamlessly. However, it's important to note that when running on Windows Subsystem for Linux (WSL), certain features may have limited functionality due to the absence of the complete Linux toolset in the WSL environment.

0 commit comments

Comments
 (0)