Update README.md

README.md

@@ -22,16 +22,23 @@ pinned: false
 [![Python application test with Github Actions](https://github.com/YZhu0225/reddit_text_classification/actions/workflows/main.yml/badge.svg)](https://github.com/YZhu0225/reddit_text_classification/actions/workflows/main.yml) 
 [![Sync to Hugging Face hub](https://github.com/YZhu0225/reddit_text_classification/actions/workflows/sync_to_hugging_face_hub.yml/badge.svg)](https://github.com/YZhu0225/reddit_text_classification/actions/workflows/sync_to_hugging_face_hub.yml)
 
+## Introduction
+
 In this project, we created a text classifier Hugging Face Spaces app and Gradio interface that classifies not safe for work (NSFW) content, specifically text that is considered inappropriate and unprofessional. We used a pre-trained DistilBERT transformer model for the sentiment analysis. The model was fine-tuned on Reddit posts and predicts 2 classes - which are NSFW and safe for work (SFW).
 
+## Workflow
+
 ### Get Reddit data
 * Data pulled in notebook `reddit_data/reddit_new.ipynb`
+
 ### Verify GPU works
 * Run pytorch training test: `python utils/quickstart_pytorch.py`
 * Run pytorch CUDA test: `python utils/verify_cuda_pytorch.py`
 * Run tensorflow training test: `python utils/quickstart_tf2.py`
 * Run nvidia monitoring test: `nvidia-smi -l 1`
 
+### DistilBERT transformer model
+
 ### Finetune text classifier model and upload to Hugging Face 
 * In terminal, run `huggingface-cli login`
 * Run `python fine_tune_berft.py` to finetune the model on Reddit data 
@@ -39,3 +46,7 @@ In this project, we created a text classifier Hugging Face Spaces app and Gradio
 * Check out the fine-tuned model [here](https://huggingface.co/michellejieli/inappropriate_text_classifier) 
 * Check out the spaces app [Spaces APP](https://huggingface.co/spaces/yjzhu0225/reddit_text_classification_app)
 
+### Gradio interface
+* In terminal, run `python3 app.py`
+* Put reddit URL in *input_url* and get output
+![WechatIMG3674](https://user-images.githubusercontent.com/112578003/207481683-9a38c9e9-fd8f-48d9-be59-27f1583f96b6.jpeg)