Merge pull request #19 from acmucsd/nlp-series

Nlp series

merging after discussion with wd

website will not load these until issue fixed

Author: arth-shukla

.DS_Store

@@ -1,2 +1,3 @@
 __pycache
 .vscode/settings.json
+.DS_Store

.gitignore

@@ -1,80 +1,118 @@
-[insert some sort of preview or teaser to reel in your audience!]
+![Header for Workshop 3: Seq 2 Seq for Translation](./NLP_Main_Header_Light.png#gh-light-mode-only)
+![Header for Workshop 3: Seq 2 Seq for Translation](./NLP_Main_Header_Dark.png#gh-dark-mode-only)
 
-# 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>
+<ol>
+    <li><a href="#1-file-directory-structure">File Directory Structure</a></li>
+    <li>
+        <a href="#2-datasets">Datasets</a>
+        <ul type="none">
+            <li><a href="#21-workshop-1">2.1 Workshop 1</a></li>
+            <li><a href="#22-workshop-2">2.2 Workshop 2</a></li>
+            <li><a href="#23-workshop-3">2.3 Workshop 3</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>
+    <li>
+        <a href="#3-getting-started">Getting Started</a>
+        <ul type="none">
+            <li><a href="#31-workshop-1-basics-of-nlp">3.1 Workshop 1: Basics of NLP</a></li>
+            <li><a href="#32-workshop-2-rnns-for-multiclassification">3.2 Workshop 2: RNNs for Multiclassification</a></li>
+            <li><a href="#33-workshop-3-seq2seq-for-machine-translation">3.3 Workshop 3: Seq2Seq for Machine Translation</a></li>
+        </ul>
+    </li>
+    <li>
+        <a href="#4-resources">Resources</a>
+        <ul type="none">
+            <li><a href="#41-workshop-1">4.1 Workshop 1</a></li>
+            <li><a href="#42-workshop-2">4.2 Workshop 2</a></li>
+            <li><a href="#43-workshop-3">4.3 Workshop 3</a></li>
+        </ul>
+    </li>
+    <li><a href="#5-author-info">Author Info</a></li>
+</ol>
 </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
+nlp-series
+    | -- workshop-1
+    |        | -- [Workshop 1 Resources]
+    |
+    | -- workshop-2
+    |        | -- [Workshop 2 Resources]
+    |
+    | -- workshop-3
+    |        | -- [Workshop 3 Resources]
+    | 
+    | -- NLP_Main_Header_Dark.png
+    | -- NLP_Main_Header_Light.png
+    | -- README.md
 ```
 
-# 2. Dataset
+# 2. Datasets
+
+## 2.1 Workshop 1
+- [Twitter Sentiment Analysis Hatred Speech](https://www.kaggle.com/datasets/arkhoshghalb/twitter-sentiment-analysis-hatred-speech) by arkhoshghalb
+
+## 2.2 Workshop 2
+- [Emotions Dataset for NLP](https://www.kaggle.com/datasets/praveengovi/emotions-dataset-for-nlp) by Praveen
+
+## 2.3 Workshop 3
+- [English to French Translations](http://www.manythings.org/anki) from the Tatoeba Project
 
-- [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
+## 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 
+## 3.2. Workshop 2: RNNs for Multiclassification
+
+This workshop is about Recurrent Neural Networks for NLP for detecting emotions in a multi-class dataset. This workshop is self-contained from the first and covers RNNs from the ground up!
 
-[Insert description & other important README information here.]
+## 3.3. Workshop 3: Seq2Seq for Machine Translation
 
-## 3.3. Workshop 3 Transformers
+Language Translation is a ubiquitous topic of Modern Natural Language Processing, and the AI that powers language translation is critical to creating a world where we can break down communication barriers between communities that speak different languages.
+
+By the end of this workshop, the reader will have a working Language Translation model similar to Google Translate!
 
-[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 first 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.
+Note: All figures made by [Arth Shukla](#5-author-info) with the exception of [NLPW3_Fig4a](./workshop-3/figures/NLPW3_Fig4a.png) from [*Understanding LSTM Networks*](https://colah.github.io/posts/2015-08-Understanding-LSTMs/) by Christopher Olah.
 
-# 5. Meeting Notes
+## 4.1 Workshop 1
 
-Meeting notes kept on 1 rolling document located [here](https://docs.google.com/document/d/1UKkSFjyYP_txn-A7Lig2tjfwcZqNEzux6DfYdCZAM4U/edit#).
+Each of the following covers a similar topic to our first workshop:
+- [Melanie Walsh Text Analysis Tutorial](https://melaniewalsh.github.io/Intro-Cultural-Analytics/05-Text-Analysis/04-Sentiment-Analysis.html#) 
+- [NeuromatchAcademy's Text Analysis Tutorial](https://github.com/NeuromatchAcademy/course-content-dl/tree/main/tutorials)
+- [Arth's Inspirit AI Colab Notebooks](https://drive.google.com/drive/folders/1y7R_lD8-OAyMD6oecoShiDl23ke5Nai0)
 
-# 6. Author Info
+## 4.2 Workshop 2
+
+We base our second workshop on the following notebook:
+- [Emotion Classification (NLP)](https://www.kaggle.com/code/dorgavra/emotion-classification-nlp/notebook) by Dor Gavra
+
+## 4.3 Workshop 3
+
+We base our code on the following example tutorial:
+- [Keras NLP Character-Level Seq2Seq RNN Model](https://keras.io/examples/nlp/lstm_seq2seq/)
+
+We also base many of our explanations on the following resources:
+- [*Encoder-Decoder Seq2Seq Models, Clearly Explained!!*](https://medium.com/analytics-vidhya/encoder-decoder-seq2seq-models-clearly-explained-c34186fbf49b) by Kriz Moses
+- [*A Simple Introduction to Sequence to Sequence Models*](https://www.analyticsvidhya.com/blog/2020/08/a-simple-introduction-to-sequence-to-sequence-models/#:~:text=Sequence%20to%20Sequence%20) from Analytics Vidhya
+- [*What is Teacher Forcing for Recurrent Neural Networks?*](https://machinelearningmastery.com/teacher-forcing-for-recurrent-neural-networks/) by Jason Brownlee
+- [*Understanding LSTM Networks*](https://colah.github.io/posts/2015-08-Understanding-LSTMs/) by Christopher Olah for [NLPW3_Fig4a](./workshop-3/figures/NLPW3_Fig4a.png)
+
+
+# 5. Author Info
 
-- Vincent Tu: [LinkedIn](https://www.linkedin.com/in/vincent-tu-422b18208/) | [GitHub](https://github.com/alckasoc)
 - Arth Shukla: [LinkedIn](https://www.linkedin.com/in/arth-shukla/) | [GitHub](https://github.com/arth-shukla)
-- Jackie Piepkrn: [LinkedIn](https://www.linkedin.com/in/jackie-piepkorn-70295418a/)
+- Jackie Piepkorn: [LinkedIn](https://www.linkedin.com/in/jackie-piepkorn-70295418a/) | [GitHub](https://github.com/jackiepiepkorn)
+- Vincent Tu: [LinkedIn](https://www.linkedin.com/in/vincent-tu-422b18208/) | [GitHub](https://github.com/alckasoc)