Update README.md

README.md

@@ -9,4 +9,30 @@ app_file: app.py
 pinned: false
 ---
 
-Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
+# AI-Generated-Text-Detection
+ CSI 4180 - Natural Language Processing - Final Project
+
+ My NLP App: https://huggingface.co/spaces/SkwarczynskiP/AI_Generated_Text_Detection
+
+This NLP Application:
+- Contains Jupyter notebooks hosted on Google Colab for the finetuning of Hugging Face models
+- Utilizes those finetuned models within a Hugging Face Space application for AI Generated Text Detection
+- Allows users to input a variety of models, datasets, and input text for sequence classification
+- Visualizes the output classification through the Hugging Face Space GUI
+
+# Files:
+The files in this repository include:
+- `User Guide.pdf`: The user guide for the NLP App
+- `app.py`: The python file containing the source code for the Hugging Face Space App
+- `requirements.txt`: The text file containing the python libraries requried for the Hugging Face Space App
+- `bert-finetuned-dmitva-AI-and-human.ipynb`: The Google Colab notebook for finetuning the BERT model on the dmitva/human_ai_generated_text dataset
+- `bert-finetuned-vedantgaur-AI-and-human.ipynb`: The Google Colab notebook for finetuning the BERT model on the vedantgaur/GPTOutputs-MWP dataset
+- `bert-finetuned-vedantgaur-AI.ipynb`: The Google Colab notebook for finetuning the BERT model on the AI text portion of the vedantgaur/GPTOutputs-MWP dataset
+- `bert-finetuned-vedantgaur-human.ipynb`: The Google Colab notebook for finetuning the BERT model on the human text portion of the vedantgaur/GPTOutputs-MWP dataset
+- `roberta-finetuned-dmitva-AI-and-human.ipynb`: The Google Colab notebook for finetuning the RoBERTa model on the dmitva/human_ai_generated_text dataset
+- `roberta-finetuned-vedantgaur-AI-and-human.ipynb`: The Google Colab notebook for finetuning the RoBERTa model on the vedantgaur/GPTOutputs-MWP dataset
+- `roberta-finetuned-vedantgaur-AI.ipynb`: The Google Colab notebook for finetuning the RoBERTa model on the AI text portion of the vedantgaur/GPTOutputs-MWP dataset
+- `roberta-finetuned-vedantgaur-human.ipynb`: The Google Colab notebook for finetuning the RoBERTa model on the human text portion of the vedantgaur/GPTOutputs-MWP dataset
+
+# How to Access:
+- Click on the link above to access the AI Generated Text Detection App