Create README.md

README.md

@@ -0,0 +1,48 @@
+---
+language: "en"
+thumbnail: "https://huggingface.co/nsi319"
+tags:
+- xlnet
+- pytorch
+- text-classification
+- mobile
+- app
+- descriptions
+- playstore
+- classification
+license: "mit"
+inference: true
+---
+
+# Mobile App Classification
+
+## Model description
+
+XLNet is a new unsupervised language representation learning method based on a novel generalized permutation language modeling objective. Additionally, XLNet employs Transformer-XL as the backbone model, exhibiting excellent performance for language tasks involving long context.
+
+The [xlnet-base-cased](https://huggingface.co/xlnet-base-cased) model is fine-tuned to classify an mobile app description into one of **6 play store categories**. 
+Trained on 9000 samples of English App Descriptions and associated categories of apps available in [Google Play](https://play.google.com/store/apps).
+
+## Fine-tuning
+
+The model was fine-tuned for 5 epochs with a batch size of 16, a learning rate of 2e-05, and a maximum sequence length of 512. Since this was a classification task, the model was trained with a cross-entropy loss function. The best evaluation f1 score achieved by the model was 0.8951433611497919, found after 5 epochs. The accuracy of the model on the test set was 0.895.  
+
+## How to use
+
+```python
+from transformers import AutoTokenizer, AutoModelForSequenceClassification, pipeline
+
+tokenizer = AutoTokenizer.from_pretrained("nsi319/xlnet-base-cased-finetuned-app")  
+model = AutoModelForSequenceClassification.from_pretrained("nsi319/xlnet-base-cased-finetuned-app")
+
+classifier = pipeline('sentiment-analysis', model=model, tokenizer=tokenizer)
+
+classifier("The official Google Photos app is made for the way you take photos today and includes essential features like shared albums, automatic creations and an advanced editing suite. Additionally every Google Account comes with 15 GB of free storage and you can choose to automatically back up all your photos and videos in High quality or Original quality. You can then access them from any connected device and on photos.google.com.")
+
+'''Output'''
+[{'label': 'Photography', 'score': 0.998849630355835}]
+```
+
+## Limitations
+Training data consists of apps from 6 play store categories namely Education, Entertainment, Productivity, Sports, News & Magazines and Photography.
+