updated README.mds

Author: alckasoc

SP22/nlp-series/README.md

@@ -0,0 +1,78 @@
+[insert some sort of preview or teaser to reel in your audience!]
+
+# NLP Workshop Series
+The official ACM AI NLP Workshop Series repository.
+
+## Table of Contents:
+
+<div class="alert alert-block alert-info">
+<ul>
+    <li>1. <a href="#1.-file-directory-structure">File Directory Structure</a></li>
+    <li>2. <a href="#2.-dataset">Dataset</a></li>
+    <li>3. <a href="#3.-getting-started">Getting Started</a>
+    <ul>
+        <li>3.1. <a href="#3.1.-workshop-1-basics-of-nlp">Workshop 1 Basics of NLP</a></li>
+        <li>3.2. <a href="#3.2.-workshop-2-more-advanced-nlp-models">Workshop 2 More Advanced NLP Models</a></li>
+        <li>3.3. <a href="#3.3.-workshop-3-transformers">Workshop 3 Transformers</a></li>
+    </ul>
+    </li>
+    <li>4. <a href="#4.-resources">Resources</a></li>
+    <li>5. <a href="#5.-meeting-notes">Meeting Notes</a></li>
+    <li>6. <a href="#6.-author-info">Author Info</a></li>
+</ul>
+</div>
+
+# 1. File Directory Structure
+
+```bash
+NLP-SERIES
+   | -- Meeting-Notes
+   |        | -- 4/15 
+   |        | -- ...
+   |
+   | -- workshop-1
+   |        | -- README.md
+   |        | ...
+   |
+   | -- workshop-2
+   |        | -- README.md
+   |        | ...
+   |
+   | -- workshop-3
+   |        | -- README.md
+   |        | ...
+   | 
+   | README.md
+```
+
+# 2. Dataset
+
+- [Twitter Sentiment Analysis Hatred Speech](https://www.kaggle.com/datasets/arkhoshghalb/twitter-sentiment-analysis-hatred-speech) by arkhoshghalb is the dataset we use across all 3 workshops.
+
+# 3. Getting Started
+
+## 3.1. Workshop 1 Basics of NLP
+
+Have you ever wondered how Siri learns your interests, or how Twitter filters hate speech? ACM AI’s Natural Language Processing (NLP) Workshop series is a series of interactive, in-person demos covering the ins and outs of NLP!  In our first workshop, we’ll learn the uses and practice the basics of NLP through interactive Colab notebooks that you can bring home to experiment with. By the end, you’ll know how to apply the models you learn to classify any text you want.
+
+## 3.2. Workshop 2 More Advanced NLP Models 
+
+[Insert description & other important README information here.]
+
+## 3.3. Workshop 3 Transformers
+
+[Insert description & other important README information here.]
+
+# 4. Resources
+
+- [Melanie Walsh Text Analysis Tutorial](https://melaniewalsh.github.io/Intro-Cultural-Analytics/05-Text-Analysis/04-Sentiment-Analysis.html#) is a great scaffolding for our first workshop.
+- [NeuromatchAcademy's Text Analysis Tutorial](https://github.com/NeuromatchAcademy/course-content-dl/tree/main/tutorials) provides another skeleton for our workshop.
+- [Arth's Colab Notebooks](https://drive.google.com/drive/folders/1y7R_lD8-OAyMD6oecoShiDl23ke5Nai0) is the 3rd reference for a table of contents for our first workshop.
+
+# 5. Meeting Notes
+
+Meeting notes are weekly on Fridays. All meeting notes are organized in the Meeting-Notes folder.
+
+# 6. Author Info
+
+- Vincent Tu:            [LinkedIn](https://www.linkedin.com/in/vincent-tu-422b18208/) | [GitHub](https://github.com/alckasoc)

SP22/nlp-series/resources/README.md

@@ -0,0 +1,29 @@
+[If possible, insert some sort of preview or teaser to reel in your audience!]
+
+# NLP Workshop Series - Workshop 1
+The official ACM AI NLP Workshop Series - Workshop 1 repository.
+
+## Table of Contents:
+
+<div class="alert alert-block alert-info">
+<ul>
+    <li>1. <a href="#1.-file-directory-structure">File Directory Structure</a></li>
+    <li>2. <a href="#2.-getting-started">Getting Started</a></li>
+</ul>
+</div>
+
+# 1. File Directory Structure
+
+```bash
+workshop-1
+   | -- README.md
+   | -- ...
+
+```
+
+# 2. Getting Started
+
+Workshop 1 consists of 3 components:
+- [Presentation](https://docs.google.com/presentation/d/1stDp_maSnhklXEt5F_Rh0f4vD9sEnW3Ru6aXIgcfDwg/edit#slide=id.p)
+- [Rule-based Classification & Taking Apart Dataset]() notebook
+- [Bag of Words Classifier]() notebook