Merge pull request #27 from acmucsd/render-READMEs

- support rendering readmes
- support obtaining title/description from metadata file
- resolve relative links to github
- more robust html in markdown parsing 
    - support github themed images

Author: duanwilliam

Fall20/NeuralNetworks2/.acm-ai-metadata.yml

@@ -0,0 +1 @@
+title: Neural Networks 2

NN/Workshop1/.acm-ai-metadata.yml

@@ -0,0 +1 @@
+title: Workshop 1

NN/Workshop1/Introduction_To_AI_and_Neural_Networks.ipynb.acm-ai-metadata.yml

@@ -0,0 +1 @@
+title: Introduction to AI and Neural Networks

SP21/GAN/readme.txt

@@ -1,9 +1,14 @@
+---
+title: NLP Series
+description: A 3-part series on natural language processing. Learn about text classification, RNNs, and language translation! 
+---
+
 ![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)
 
 The official ACM AI NLP Workshop Series repository.
 
-# 1. File Directory Structure
+## 1. File Directory Structure
 
 ```bash
 nlp-series
@@ -20,52 +25,52 @@ nlp-series
     | -- README.md
 ```
 
-# 2. Datasets
+## 2. Datasets
 
-## 2.1 Workshop 1
+### 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
+### 2.2 Workshop 2
 - [Emotions Dataset for NLP](https://www.kaggle.com/datasets/praveengovi/emotions-dataset-for-nlp) by Praveen
 
-## 2.3 Workshop 3
+### 2.3 Workshop 3
 - [English to French Translations](http://www.manythings.org/anki) from the Tatoeba Project
 
 
-# 3. Getting Started
+## 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: RNNs for Multiclassification
+### 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!
 
-## 3.3. Workshop 3: Seq2Seq for Machine Translation
+### 3.3 Workshop 3: Seq2Seq for Machine Translation
 
 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!
 
 
-# 4. Resources
+## 4. Resources
 
 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.
 
-## 4.1 Workshop 1
+### 4.1 Workshop 1
 
 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)
 
-## 4.2 Workshop 2
+### 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
+### 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/)
@@ -77,7 +82,7 @@ We also base many of our explanations on the following resources:
 - [*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
+## 5. Author Info
 
 - Arth Shukla: [LinkedIn](https://www.linkedin.com/in/arth-shukla/) | [GitHub](https://github.com/arth-shukla)
 - Jackie Piepkorn: [LinkedIn](https://www.linkedin.com/in/jackie-piepkorn-70295418a/) | [GitHub](https://github.com/jackiepiepkorn)

SP22/nlp-series/README.md

@@ -1,21 +1,26 @@
+---
+title: "Workshop 1: Intro to NLP"
+description: "Learn about the basics of NLP and practice using them!"
+---
+
 ![Header for Workshop 1 Intro to N L P](./figures/NLPW1_Header_Light.png#gh-light-mode-only)
 ![Header for Workshop 1 Intro to N L P](./figures/NLPW1_Header_Dark.png#gh-dark-mode-only)
 
 The official ACM AI NLP Workshop Series - Workshop 1 repository.
 
-# 1. Workshop Recording
+## 1. Workshop Recording
 
 <div align="center">
-<a href="https://youtu.be/vTGxaUOArd8">
-<img
-    src="https://i.ytimg.com/vi/vTGxaUOArd8/maxresdefault.jpg?sqp=-oaymwEcCNACELwBSFXyq4qpAw4IARUAAIhCGAFwAcABBg==\u0026rs=AOn4CLAi9Z6xz-NdZBtrblK3oLdpNVDP1A"
-    alt="Thumbnail for N L P Workshop 1, Intro to N L P and Text Classification"
-    width="500px"
-/>
-</a>
+    <a href="https://youtu.be/vTGxaUOArd8">
+        <img
+            src="https://i.ytimg.com/vi/vTGxaUOArd8/maxresdefault.jpg?sqp=-oaymwEcCNACELwBSFXyq4qpAw4IARUAAIhCGAFwAcABBg==\u0026rs=AOn4CLAi9Z6xz-NdZBtrblK3oLdpNVDP1A"
+            alt="Thumbnail for N L P Workshop 1, Intro to N L P and Text Classification"
+            width="500px"
+        />
+    </a>
 </div>
 
-# 2. File Directory Structure
+## 2. File Directory Structure
 
 ```bash
 workshop-1
@@ -37,11 +42,10 @@ workshop-1
 
 ```
 
-# 3. Getting Started
+## 3. Getting Started
 
 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.
 
-
 Workshop 1 consists of 4 components:
 - [Presentation](./presentation-resources/NLP_Workshop_1_-_Basics_of_NLP.pptx) used during the workshop.
 - [Main Notebook](./NLP_WS1_Main.ipynb) with completed code and explanations.

SP22/nlp-series/workshop-1/README.md

@@ -1,9 +1,14 @@
+---
+title: "Workshop 2: RNNs for Multiclassification"
+description: "Follow us in learning about recurrent neural networks and how to use them in NLP to detect emotions from text"
+---
+
 ![Header for Workshop 2: R N Ns for Multiclassification](./figures/NLPW2_Header_Light.png#gh-light-mode-only)
 ![Header for Workshop 2: R N Ns for Multiclassification](./figures/NLPW2_Header_Dark.png#gh-dark-mode-only)
 
 The official ACM AI NLP Workshop Series - Workshop 2 repository.
 
-# 1. Workshop Recording
+## 1. Workshop Recording
 
 <div align="center">
 <a href="https://www.youtube.com/watch?v=A8Plt878Vyo&ab_channel=ACMatUCSanDiego">
@@ -16,7 +21,7 @@ The official ACM AI NLP Workshop Series - Workshop 2 repository.
 </div>
 
 
-# 2. File Directory Structure
+## 2. File Directory Structure
 
 ```bash
 workshop-2
@@ -40,7 +45,7 @@ workshop-2
 
 ```
 
-# 3. Getting Started
+## 3. Getting Started
 
 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!
 

SP22/nlp-series/workshop-2/README.md

@@ -1,22 +1,26 @@
+---
+title: "Workshop 3: Machine Translation with RNNs"
+description: "Join us in making a language translation model similar to Google Translate!"
+---
+
 ![Header for Workshop 3: Seq 2 Seq for Translation](./figures/NLPW3_Header_Light.png#gh-light-mode-only)
 ![Header for Workshop 3: Seq 2 Seq for Translation](./figures/NLPW3_Header_Dark.png#gh-dark-mode-only)
 
 The official ACM AI NLP Workshop Series - Workshop 3 repository.
 
-# 1. Workshop Recording
+## 1. Workshop Recording
 
 <div align="center">
-<a href="https://www.youtube.com/watch?v=AvWhHTifw4I&ab_channel=ACMatUCSanDiego">
-<img
-    src="https://i.ytimg.com/vi/AvWhHTifw4I/maxresdefault.jpg?sqp=-oaymwEcCNACELwBSFXyq4qpAw4IARUAAIhCGAFwAcABBg"
-    alt="Thumbnail for N L P Workshop 3, Machine Translation with R N Ns"
-    width="500px"
-/>
-</a>
+    <a href="https://www.youtube.com/watch?v=AvWhHTifw4I&ab_channel=ACMatUCSanDiego">
+        <img
+            src="https://i.ytimg.com/vi/AvWhHTifw4I/maxresdefault.jpg?sqp=-oaymwEcCNACELwBSFXyq4qpAw4IARUAAIhCGAFwAcABBg"
+            alt="Thumbnail for N L P Workshop 3, Machine Translation with R N Ns"
+            width="500px"
+        />
+    </a>
 </div>
 
-
-# 2. File Directory Structure
+## 2. File Directory Structure
 
 ```bash
 workshop-3
@@ -42,7 +46,7 @@ workshop-3
 
 ```
 
-# 3. Getting Started
+## 3. Getting Started
 
 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.
 

SP22/nlp-series/workshop-3/README.md

@@ -0,0 +1,23 @@
+(The MIT License)
+
+Copyright (c) 2016 rhysd
+Copyright (c) 2015 Mapbox
+Copyright (c) 2015 Titus Wormer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.