-
Notifications
You must be signed in to change notification settings - Fork 0
/
datacheckpoint_format
259 lines (259 loc) · 11.2 KB
/
datacheckpoint_format
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
{
"cells": [
{
"cell_type": "markdown",
"metadata": {},
"source": [
"**If you lost points on the last checkpoint you can get them back by responding to TA/IA feedback** \n",
"\n",
"Update/change the relevant sections where you lost those points, make sure you respond on GitHub Issues to your TA/IA to call their attention to the changes you made here.\n",
"\n",
"Please update your Timeline... no battle plan survives contact with the enemy, so make sure we understand how your plans have changed."
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"# COGS 108 - Data Checkpoint"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"# Names\n",
"\n",
"- Raymond Williams\n",
"- Jefferson Chen\n",
"- Olivia Cai\n",
"- Patrick Maloney\n",
"- Stanley Pan"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"# Research Question"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Background and Prior Work"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"\n",
"- Include a general introduction to your topic\n",
"- Include explanation of what work has been done previously\n",
"- Include citations or links to previous work\n",
"\n",
"This section will present the background and context of your topic and question in a few paragraphs. Include a general introduction to your topic and then describe what information you currently know about the topic after doing your initial research. Include references to other projects who have asked similar questions or approached similar problems. Explain what others have learned in their projects.\n",
"\n",
"Find some relevant prior work, and reference those sources, summarizing what each did and what they learned. Even if you think you have a totally novel question, find the most similar prior work that you can and discuss how it relates to your project.\n",
"\n",
"References can be research publications, but they need not be. Blogs, GitHub repositories, company websites, etc., are all viable references if they are relevant to your project. It must be clear which information comes from which references. (2-3 paragraphs, including at least 2 references)\n",
"\n",
" **Use inline citation through HTML footnotes to specify which references support which statements** \n",
"\n",
"For example: After government genocide in the 20th century, real birds were replaced with surveillance drones designed to look just like birds.<a name=\"cite_ref-1\"></a>[<sup>1</sup>](#cite_note-1) Use a minimum of 2 or 3 citations, but we prefer more.<a name=\"cite_ref-2\"></a>[<sup>2</sup>](#cite_note-2) You need enough to fully explain and back up important facts. \n",
"\n",
"Note that if you click a footnote number in the paragraph above it will transport you to the proper entry in the footnotes list below. And if you click the ^ in the footnote entry, it will return you to the place in the main text where the footnote is made.\n",
"\n",
"To understand the HTML here, `<a name=\"#...\"> </a>` is a tag that allows you produce a named reference for a given location. Markdown has the construciton `[text with hyperlink](#named reference)` that will produce a clickable link that transports you the named reference.\n",
"\n",
"1. <a name=\"cite_note-1\"></a> [^](#cite_ref-1) Lorenz, T. (9 Dec 2021) Birds Aren’t Real, or Are They? Inside a Gen Z Conspiracy Theory. *The New York Times*. https://www.nytimes.com/2021/12/09/technology/birds-arent-real-gen-z-misinformation.html \n",
"2. <a name=\"cite_note-2\"></a> [^](#cite_ref-2) Also refs should be important to the background, not some randomly chosen vaguely related stuff. Include a web link if possible in refs as above.\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"# Hypothesis\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"\n",
"- Include your team's hypothesis\n",
"- Ensure that this hypothesis is clear to readers\n",
"- Explain why you think this will be the outcome (what was your thinking?)\n",
"\n",
"What is your main hypothesis/predictions about what the answer to your question is? Briefly explain your thinking. (2-3 sentences)"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"# Data"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Data overview\n",
"\n",
"For each dataset include the following information\n",
"- Dataset #1\n",
" - Dataset Name:\n",
" - Link to the dataset:\n",
" - Number of observations:\n",
" - Number of variables:\n",
"- Dataset #2 (if you have more than one!)\n",
" - Dataset Name:\n",
" - Link to the dataset:\n",
" - Number of observations:\n",
" - Number of variables:\n",
"- etc\n",
"\n",
"Now write 2 - 5 sentences describing each dataset here. Include a short description of the important variables in the dataset; what the metrics and datatypes are, what concepts they may be proxies for. Include information about how you would need to wrangle/clean/preprocess the dataset\n",
"\n",
"If you plan to use multiple datasets, add a few sentences about how you plan to combine these datasets."
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Dataset #1 (use name instead of number here)"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"## YOUR CODE TO LOAD/CLEAN/TIDY/WRANGLE THE DATA GOES HERE\n",
"## FEEL FREE TO ADD MULTIPLE CELLS PER SECTION "
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Dataset #2 (if you have more than one, use name instead of number here)"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"## YOUR CODE TO LOAD/CLEAN/TIDY/WRANGLE THE DATA GOES HERE\n",
"## FEEL FREE TO ADD MULTIPLE CELLS PER SECTION "
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"# Ethics & Privacy"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"- Thoughtful discussion of ethical concerns included\n",
"- Ethical concerns consider the whole data science process (question asked, data collected, data being used, the bias in data, analysis, post-analysis, etc.)\n",
"- How your group handled bias/ethical concerns clearly described\n",
"\n",
"Acknowledge and address any ethics & privacy related issues of your question(s), proposed dataset(s), and/or analyses. Use the information provided in lecture to guide your group discussion and thinking. If you need further guidance, check out [Deon's Ethics Checklist](http://deon.drivendata.org/#data-science-ethics-checklist). In particular:\n",
"\n",
"- Are there any biases/privacy/terms of use issues with the data you propsed?\n",
"- Are there potential biases in your dataset(s), in terms of who it composes, and how it was collected, that may be problematic in terms of it allowing for equitable analysis? (For example, does your data exclude particular populations, or is it likely to reflect particular human biases in a way that could be a problem?)\n",
"- How will you set out to detect these specific biases before, during, and after/when communicating your analysis?\n",
"- Are there any other issues related to your topic area, data, and/or analyses that are potentially problematic in terms of data privacy and equitable impact?\n",
"- How will you handle issues you identified?"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"# Team Expectations "
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"\n",
"Read over the [COGS108 Team Policies](https://github.com/COGS108/Projects/blob/master/COGS108_TeamPolicies.md) individually. Then, include your group’s expectations of one another for successful completion of your COGS108 project below. Discuss and agree on what all of your expectations are. Discuss how your team will communicate throughout the quarter and consider how you will communicate respectfully should conflicts arise. By including each member’s name above and by adding their name to the submission, you are indicating that you have read the COGS108 Team Policies, accept your team’s expectations below, and have every intention to fulfill them. These expectations are for your team’s use and benefit — they won’t be graded for their details.\n",
"\n",
"* *Team Expectation 1*\n",
"* *Team Expectation 2*\n",
"* *Team Expecation 3*\n",
"* ..."
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"# Project Timeline Proposal"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"Specify your team's specific project timeline. An example timeline has been provided. Changes the dates, times, names, and details to fit your group's plan.\n",
"\n",
"If you think you will need any special resources or training outside what we have covered in COGS 108 to solve your problem, then your proposal should state these clearly. For example, if you have selected a problem that involves implementing multiple neural networks, please state this so we can make sure you know what you’re doing and so we can point you to resources you will need to implement your project. Note that you are not required to use outside methods.\n",
"\n",
"\n",
"\n",
"| Meeting Date | Meeting Time| Completed Before Meeting | Discuss at Meeting |\n",
"|---|---|---|---|\n",
"| 1/20 | 1 PM | Read & Think about COGS 108 expectations; brainstorm topics/questions | Determine best form of communication; Discuss and decide on final project topic; discuss hypothesis; begin background research | \n",
"| 1/26 | 10 AM | Do background research on topic | Discuss ideal dataset(s) and ethics; draft project proposal | \n",
"| 2/1 | 10 AM | Edit, finalize, and submit proposal; Search for datasets | Discuss Wrangling and possible analytical approaches; Assign group members to lead each specific part |\n",
"| 2/14 | 6 PM | Import & Wrangle Data (Ant Man); EDA (Hulk) | Review/Edit wrangling/EDA; Discuss Analysis Plan |\n",
"| 2/23 | 12 PM | Finalize wrangling/EDA; Begin Analysis (Iron Man; Thor) | Discuss/edit Analysis; Complete project check-in |\n",
"| 3/13 | 12 PM | Complete analysis; Draft results/conclusion/discussion (Wasp)| Discuss/edit full project |\n",
"| 3/20 | Before 11:59 PM | NA | Turn in Final Project & Group Project Surveys |"
]
}
],
"metadata": {
"kernelspec": {
"display_name": "Python 3 (ipykernel)",
"language": "python",
"name": "python3"
},
"language_info": {
"codemirror_mode": {
"name": "ipython",
"version": 3
},
"file_extension": ".py",
"mimetype": "text/x-python",
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.9.7"
}
},
"nbformat": 4,
"nbformat_minor": 2
}