Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added simple usage for NLP package to ReadMe #114

Merged
merged 4 commits into from
Nov 4, 2023
Merged
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,8 +94,21 @@ ax[1] = vis.radar(df, ax=ax[1], color='C1', alpha=0)
<img src="examples/radar.svg">
</p>

## 5. NLP Package Usage

## 5. Command Line Interface
```python
from chatminer.nlp import add_sentiment
```
### 5.1 Add Sentiment

Extracts sentiment from the message and adds sentiment column to the input dataframe.

```python
# Adds sentiment column to the DataFrame
df_with_sentiment = add_sentiment(df)
```
smty2018 marked this conversation as resolved.
Show resolved Hide resolved

## 6. Command Line Interface
The CLI supports parsing chat logs into csv files.
As of now, you **can't** create visualizations from the CLI directly.

Expand Down