Weighted-Class-Tfidf 1.0.3
Custom implementation of tfidf for imbalanced datasets
Requires Python: >=3.6

# Weighted-Class-Tfidf
[![forthebadge made-with-python](http://ForTheBadge.com/images/badges/made-with-python.svg)](https://www.python.org/)[![ForTheBadgebuilt-with-love](http://ForTheBadge.com/images/badges/built-with-love.svg)](https://github.com/SauravPattnaikCS60/Weighted-Class-Based-Tfidf)

## Inspiration behind WCBTFIDF

Standard tfidf models select the features(number defined by the **max_features** param) using t**erm frequency** alone.
This can create problems when the dataset is imbalanced resulting in words from the majority class being selected.
As a result of this minority class gets under-represented in the matrix that is being returned by tfidf.


## Solution

To tackle this problem we break down the tfidf process class wise.
Let us consider an example to understand what WCBTFIDF does under the hood

Assume a dataset having two labels 0 and 1.
**0** is present in **80%** of the records and **1** is present in **20%** of the records.

If we run standard tfidf on this(with for example 300 features) it will pick the top 300 words by frequency
from both the classes. There is a very high chance that words selected will be majorly from class 0 and we 
might run the risk of under-representing class 1 severely.

What wcbtfidf does is that first it calculates weight for each label.
Weight here refers to how many features it should select from each class.

Since class 0 is present in 80% of the records, wcbtfidf will pick 240 features from class 0 and 60 features
from class 1.

So essentially we run tfidf class wise on 0 and 1 labels with max features set as 240 and 60.

After doing that, we combine the vocabulary from both these classes into a single list.It can be easily done since
tfidf provides a **vocabulary_** param that stores the vocab.

Finally this combined vocab is used as a fixed vocabulary in another tfidf model that is ran on the entire data.
By fixing the vocab for the final tfidf we ensure that we are going to score on these set of words only.

_To put it simply the 300 features choosen by wcbtfidf are a better representation of the overall data as compared
to the features chosen by standard tfidf model._

## RESULTS

In the experiments conducted, wcbtfidf performed better than standard tfidf models. The results have been put
into a notebook under the _demos_ folder.

## Data Sources

[IMDB Dataset](https://www.kaggle.com/lakshmi25npathi/imdb-dataset-of-50k-movie-reviews)

[Toxic Classification Dataset](https://www.kaggle.com/c/jigsaw-toxic-comment-classification-challenge/data)

[Sentiment140 Dataset](https://www.kaggle.com/kazanova/sentiment140)


## Article Link 
[Click here](https://www.deepwizai.com/projects/how-to-correctly-use-tf-idf-with-imbalanced-data)

## Tutorial
```python
# Import the class
from wcbtfidf import Wcbtfidf
# Initialize the object
wcbtfidf = Wcbtfidf(max_features=100)
# Fit on the training set
wcbtfidf.fit(xtrain,ytrain)
# Transform on the test set
test_df = wcbtfidf.transform(xtest)
# Get the vocab
wcbtfidf.combine_vocab
# Get the class wise vocab
wcbtfidf.class_wise_vocab

# Added support for providing custom features set
wcbtfidf = Wcbtfidf(max_features=100,custom_weights={0:20,1:80}) # This lets you manage how many features you want to assign

# Here xtrain,xtest refers to a single pandas column containing the text data and ytrain ytest the
# categorical output label
```