Skip to content

Commit 6cd87cb

Browse files
arth-shuklaarth-shukla
authored
Merge pull request #26 from acmucsd/workshop-directory-example-making
Workshop directory example making
2 parents 39ab7e3 + e671c9b commit 6cd87cb

File tree

13 files changed

+313
-63
lines changed

13 files changed

+313
-63
lines changed

‎SP22/nlp-series/README.md‎

Lines changed: 0 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -3,39 +3,6 @@
33

44
The official ACM AI NLP Workshop Series repository.
55

6-
## Table of Contents:
7-
8-
<div class="alert alert-block alert-info">
9-
<ol>
10-
<li><a href="#1-file-directory-structure">File Directory Structure</a></li>
11-
<li>
12-
<a href="#2-datasets">Datasets</a>
13-
<ul type="none">
14-
<li><a href="#21-workshop-1">2.1 Workshop 1</a></li>
15-
<li><a href="#22-workshop-2">2.2 Workshop 2</a></li>
16-
<li><a href="#23-workshop-3">2.3 Workshop 3</a></li>
17-
</ul>
18-
</li>
19-
<li>
20-
<a href="#3-getting-started">Getting Started</a>
21-
<ul type="none">
22-
<li><a href="#31-workshop-1-basics-of-nlp">3.1 Workshop 1: Basics of NLP</a></li>
23-
<li><a href="#32-workshop-2-rnns-for-multiclassification">3.2 Workshop 2: RNNs for Multiclassification</a></li>
24-
<li><a href="#33-workshop-3-seq2seq-for-machine-translation">3.3 Workshop 3: Seq2Seq for Machine Translation</a></li>
25-
</ul>
26-
</li>
27-
<li>
28-
<a href="#4-resources">Resources</a>
29-
<ul type="none">
30-
<li><a href="#41-workshop-1">4.1 Workshop 1</a></li>
31-
<li><a href="#42-workshop-2">4.2 Workshop 2</a></li>
32-
<li><a href="#43-workshop-3">4.3 Workshop 3</a></li>
33-
</ul>
34-
</li>
35-
<li><a href="#5-author-info">Author Info</a></li>
36-
</ol>
37-
</div>
38-
396
# 1. File Directory Structure
407

418
```bash

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

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,6 @@
33

44
The official ACM AI NLP Workshop Series - Workshop 1 repository.
55

6-
# Table of Contents:
7-
8-
<div class="alert alert-block alert-info">
9-
<ol>
10-
<li><a href="#1-workshop-recording">Workshop Recording</a></li>
11-
<li><a href="#2-file-directory-structure">File Directory Structure</a></li>
12-
<li><a href="#3-getting-started">Getting Started</a></li>
13-
</ul>
14-
</div>
15-
166
# 1. Workshop Recording
177

188
<div align="center">

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

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,6 @@
33

44
The official ACM AI NLP Workshop Series - Workshop 2 repository.
55

6-
# Table of Contents:
7-
8-
<div class="alert alert-block alert-info">
9-
<ol>
10-
<li><a href="#1-workshop-recording">Workshop Recording</a></li>
11-
<li><a href="#2-file-directory-structure">File Directory Structure</a></li>
12-
<li><a href="#3-getting-started">Getting Started</a></li>
13-
</ul>
14-
</div>
15-
166
# 1. Workshop Recording
177

188
<div align="center">

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

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,6 @@
33

44
The official ACM AI NLP Workshop Series - Workshop 3 repository.
55

6-
# Table of Contents:
7-
8-
<div class="alert alert-block alert-info">
9-
<ol>
10-
<li><a href="#1-workshop-recording">Workshop Recording</a></li>
11-
<li><a href="#2-file-directory-structure">File Directory Structure</a></li>
12-
<li><a href="#3-getting-started">Getting Started</a></li>
13-
</ul>
14-
</div>
15-
166
# 1. Workshop Recording
177

188
<div align="center">

‎internal/templates/single-workshop/README.md‎

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
<!--
2+
If you have any questions about this template, feel free to ask
3+
your Director for help!
4+
-->
5+
6+
7+
<!--
8+
SECTION: Header
9+
---------
10+
Request new headers from you Director to fit your workshop!
11+
-->
12+
13+
![Alt Text (This should be your workshop title written so it's screenreader-compatible)](./figures/Default_Header_Light.png#gh-light-mode-only)
14+
![Alt Text (This should be your workshop title written so it's screenreader-compatible)](./figures/Default_Header_Dark.png#gh-dark-mode-only)
15+
16+
The official ACM AI <!-- Your Workshop Name --> repository.
17+
18+
<!--
19+
Mandatory Sections:
20+
- File Directory Structure
21+
- Workshop Recording
22+
- if you recorded your workshop, please make it available here
23+
- Getting Started
24+
- Give an interesting description of your workshop!
25+
- E.g. you can use the marketing descriptiong (w/o the emojis
26+
and make the nouns general ('you' becomes 'the reader'))
27+
- Resources
28+
- Images, papers, etc
29+
- Author Info
30+
- About yourself! This is so you get credit for your work!
31+
Other Possible Sections:
32+
- Datasets
33+
- Separate from 'Resources' to distinguish between inspiration and
34+
things like datasets used in a notebook
35+
- Anything else you'd like, but try not to be redundant!
36+
-->
37+
38+
<!--
39+
SECTION: Workshop Video
40+
---------
41+
Most, if not all, workshops should have recordings. Once the recording
42+
is posted to the ACMUCSD YT channel (https://www.youtube.com/channel/UCyjPATFqc3FwOiuqJ2UG1Eg), replace the text with an <img> element.
43+
-->
44+
45+
# 1. Workshop Video
46+
47+
*Will be added as soon as uploaded to YouTube*
48+
49+
<!--
50+
<div align="center">
51+
<a href="YT Video Link">
52+
<img
53+
src="YT Max Res Thumbnail Link"
54+
alt="Screen reader-compatible alt text"
55+
width="500px"
56+
/>
57+
</a>
58+
</div>
59+
-->
60+
61+
<!--
62+
SECTION: File Directory Structure
63+
---------
64+
Write out your File Directory Structure below (make sure it's up-to-date)
65+
-->
66+
67+
# 2. File Directory Structure
68+
69+
```bash
70+
nlp-series
71+
| -- figures
72+
| -- Default_Header_Dark.png
73+
| -- Default_Header_Light.png
74+
| -- ...
75+
| -- README.md
76+
```
77+
78+
<!--
79+
SECTION: Getting Started
80+
---------
81+
Brief description of your workshop here
82+
-->
83+
84+
# 3. Getting Started
85+
86+
<!--
87+
You can write something up or use the marketing description.
88+
-->
89+
90+
91+
<!--
92+
SECTION: Resources
93+
---------
94+
Make sure to cite everything you use, whether directly or for inspiration!
95+
-->
96+
97+
# 4. Resources
98+
99+
<!--
100+
List all your resources below; DO NOT skimp on this part!
101+
-->
102+
103+
- [*Pale Blue Dot*](https://www.youtube.com/watch?v=wupToqz1e2g&ab_channel=carlsagandotcom) by Carl Sagan from carlsagandot.com on YouTube
104+
105+
106+
<!--
107+
SECTION: Author Info
108+
---------
109+
Make sure to give yourself credit for your work by listing yourself and
110+
your partners below! Add your LinkedIn and GitHub!
111+
-->
112+
113+
# 5. Author Info
114+
115+
- Person One: [LinkedIn](<!-- LinkedIn link -->) | [GitHub](<!-- GitHub link -->)
116+
- Person Two: [LinkedIn](<!-- LinkedIn link -->) | [GitHub](<!-- GitHub link -->)

‎internal/templates/single-workshop/figures/Default_Header_Dark.png‎

31.3 KB
Loading

‎internal/templates/single-workshop/figures/Default_Header_Light.png‎

27.8 KB
Loading

‎internal/templates/workshop-series/Default_Main_Header_Dark.png‎

36.3 KB
Loading

‎internal/templates/workshop-series/Default_Main_Header_Light.png‎

31.7 KB
Loading

‎internal/templates/workshop-series/README.md‎

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
<!--
2+
If you have any questions about this template, feel free to ask
3+
your Director for help!
4+
-->
5+
6+
7+
<!--
8+
SECTION: Header
9+
---------
10+
Request new headers from you Director to fit your workshop!
11+
-->
12+
13+
![Alt Text (This should be your workshop title written so it's screenreader-compatible)](./Default_Main_Header_Light.png#gh-light-mode-only)
14+
![Alt Text (This should be your workshop title written so it's screenreader-compatible)](./Default_Main_Header_Dark.png#gh-dark-mode-only)
15+
16+
The official ACM AI <!-- Your Series Name --> repository.
17+
18+
<!--
19+
SECTION: Table of Contents
20+
---------
21+
Mandatory Sections:
22+
- File Directory Structure
23+
- Getting Started
24+
- Give an interesting description of your workshop!
25+
- E.g. you can use the marketing descriptiong (w/o the emojis
26+
and make the nouns general ('you' becomes 'the reader'))
27+
- Resources
28+
- Images, papers, etc
29+
Other Possible Sections:
30+
- Datasets
31+
- Separate from 'Resources' to distinguish between inspiration and
32+
things like datasets used in a notebook
33+
- Anything else you'd like, but try not to be redundant!
34+
-->
35+
36+
<!--
37+
SECTION: File Directory Structure
38+
---------
39+
Write out your File Directory Structure below (make sure it's up-to-date)
40+
-->
41+
42+
# 1. File Directory Structure
43+
44+
```bash
45+
nlp-series
46+
| -- workshop-1
47+
| -- [Workshop 1 Resources]
48+
| -- ...
49+
| -- Default_Main_Header_Dark.png
50+
| -- Default_Main_Header_Light.png
51+
| -- ...
52+
| -- README.md
53+
```
54+
55+
<!--
56+
SECTION: Getting Started
57+
---------
58+
Brief description of your workshop here
59+
-->
60+
61+
# 2. Getting Started
62+
63+
## 2.1 Workshop 1
64+
65+
<!--
66+
You can write something up for each worksop or use their marketing descriptions.
67+
-->
68+
69+
This workshop is so great guys trust me.
70+
71+
<!--
72+
SECTION: Resources
73+
---------
74+
Make sure to cite everything you use, whether directly or for inspiration!
75+
-->
76+
77+
# 3. Resources
78+
79+
## 3.1 Workshop 1
80+
81+
<!--
82+
List all your resources for each workshop; DO NOT skimp on this part!
83+
-->
84+
85+
- [*Pale Blue Dot*](https://www.youtube.com/watch?v=wupToqz1e2g&ab_channel=carlsagandotcom) by Carl Sagan from carlsagandotcom on YouTube
86+
87+
<!--
88+
SECTION: Author Info
89+
---------
90+
Make sure to give yourself credit for your work by listing yourself and
91+
your partners below! Add your LinkedIn and GitHub!
92+
-->
93+
94+
# 4. Author Info
95+
96+
- Person One: [LinkedIn](<!-- LinkedIn link -->) | [GitHub](<!-- GitHub link -->)
97+
- Person Two: [LinkedIn](<!-- LinkedIn link -->) | [GitHub](<!-- GitHub link -->)

0 commit comments

Comments
 (0)