junming-qiu commited on
Commit
6af42d6
1 Parent(s): 6ed43e2

readme edits

Browse files
Documentation/config.png ADDED
Documentation/end_result.png ADDED
Documentation/step3.png ADDED
Documentation/terminal.png ADDED
README.md CHANGED
@@ -1,9 +1,32 @@
1
  # Toxic-Tweets
2
 
3
- <b><font size='6'>Docker Mac Installation Instructions</font></b>
4
- 1. Download and install Docker client
5
- 2. Open Docker client
6
- 3. Click "Dev Environments" > "Create"
7
- 4. Install Docker and Containers extension on VS Code
8
- 5. Link github and create environment.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
9
 
 
1
  # Toxic-Tweets
2
 
3
+ <h1>Motivation</h1>
4
+ <p>The internet has been converted from a tool offering unprecedented utility to mankind to a tool that can can destabilize societies and ven cause individuals to take their own lives.
5
+
6
+ Discussing things you care about can be difficult. The threat of abuse and harassment online means that many people stop expressing themselves and give up on seeking different opinions. Platforms struggle to effectively facilitate conversations, leading many communities to limit or completely shut down user comments.
7
+
8
+ The Conversation AI team, a research initiative founded by Jigsaw and Google (both a part of Alphabet) are working on tools to help improve online conversation. One area of focus is the study of negative online behaviors, like toxic comments (i.e. comments that are rude, disrespectful or otherwise likely to make someone leave a discussion). So far they’ve built a range of publicly available models served through the Perspective API, including toxicity. But the current models still make errors, and they don’t allow users to select which types of toxicity they’re interested in finding (e.g. some platforms may be fine with profanity, but not with other types of toxic content).</p>
9
+
10
+ <a href="https://pantelis.github.io/artificial-intelligence/aiml-common/projects/nlp/finetuning-language-models-tweets/index.html">Source</a>
11
+ <h1>Installation</h1>
12
+
13
+ <p>For this project, I am using VSCode as my IDE with "Docker" and "Dev Containers" extensions installed. I will be creating a Docker dev envronment to build my project in, as it allows for standardization of libraries across machines.</p>
14
+
15
+ <h2>Docker Dev Environment Creation Instructions using Docker Desktop</h2>
16
+ <ol>
17
+ <li>Download and install Docker <a href="https://www.docker.com/">client</a></li>
18
+ <li>Open Docker client</li>
19
+ <li>Click "Dev Environments" > "Create" > "Get Started" > "Choose Source" > <i>Link/Create a Git <a href="https://github.com/Junming-Qiu/Toxic-Tweets.git">repo</a></i> > "Continue"</li>
20
+ <li>The environment is created and running</li>
21
+ <li>In the "Dev Environments" tab, select the running container and click "OPEN IN VSCODE"</li>
22
+ </ol>
23
+ <img src="./Documentation/end_result.png"/>
24
+ <img src="./Documentation/step3.png"/>
25
+ <img src="./Documentation/config.png"/>
26
+ <p>Verify that the container is running by running "docker ps" in the command line</p>
27
+ <img src="./Documentation/terminal.png"/>
28
+ <p>For CLI creation of a dev environment, use this <a href="https://docs.docker.com/desktop/dev-environments/set-up/">resource</a></p>
29
+
30
+ <h2></h2>
31
+
32