Implement repo readme template for all repos

[furkmak]

Hi, you can find the first version of the template here. I am still working on the setup part but in the meantime, feel free to suggest changes/improvements.

[SebastianZimmeck]

@atlasharry and @candace-walker, can you take a look?

[furkmak]

Hi, I shared with everyone a google doc. It is a basic template that we can apply to each repo. It has the basic sections we could use for each repo. You can provide feedback here or in the google doc.

[furkmak]

Hi, I shared with everyone a google doc. It is a basic template that we can apply to each repo. It has the basic sections we could use for each repo. You can provide feedback here or in the google doc.

Hi, hope you had a chance to look at the template. Feel free to let me know if you have any feedback.

[SebastianZimmeck]

@furkmak will take the lead on this with the help of @candace-walker and @atlasharry.

The template should be simple. At its core:

• What is in the repo?
• How do I run the code?
• Dependencies

Then, there may be smaller items like that this code is part of the overall project, acknowledgment to the NSF, ...

@furkmak, what is your estimate by when all readmes are revised?

[furkmak]

Hi @SebastianZimmeck,

I met with @atlasharry and @candace-walker today. We discussed the repos and I believe we have two timeframes going forward. First is the expected time to complete the revisions for all repos, except the google_2022 and fb_2022. We expect this to be completed around 5-6 weeks, finishing around 3 repos every week. The second timeframe is for the google_2022 and fb_2022 repos which will be dispersed into multiple repos. Thus, we expect another 2 weeks to complete the revisions of these repos. I will keep everyone posted of the progress. Here is a list of repos which I will update as they are completed:

• [x] Face Collection 2022
• [x] Facebook Ad Scraper
• [x] Facebook Ads Import
• [x] Google Ads Archive
• [x] Facebook Aggregate Reports Import
• [x] Facebook Page Names
• [x] TV 2020 Data
• [ ] Facebook Entities 2020
• [ ] Datasets
• [x] Facebook 2020
• [ ] Facebook 2022 (will be dispersed first)
• [ ] Google 2022 (will be dispersed first)
• [x] Entity Linking 2020
• [x] Entity Linking 2022
• [x] Race of Focus (Aleks)
• [x] Aspect-Based Sentiment Analysis
• [x] Ad-Level Party Classifier (Harry)
• [x] Party Classifier with Unique ID (Harry)
• [x] Ad Goal Classifier(Aleks)
• [x] Attack like (Harry)
• [x] Issue Classifier (Harry)
• [x] Ad Tone (Aleks)
• [x] Public Data (Aleks)

[SebastianZimmeck]

Thanks, @furkmak!

@furkmak, @candace-walker, and @atlasharry, let's have this done by October 24, the last day of the Fall break, five weeks from now. I created a milestone with due date October 24. Please add any related issue to the milestone.

[SebastianZimmeck]

@a-jacewicz will help out here as discussed.

[furkmak]

Here is the updated list with new repos:

• [x] Face Collection 2022
• [x] Facebook Ad Scraper
• [x] Facebook Ads Import
• [x] Google Ads Archive
• [x] Facebook Aggregate Reports Import
• [x] Facebook Page Names
• [x] TV 2020 Data
• [x] Facebook Entities 2020 (Sebastian; repo archived as it referenced duplicate data from the Datasets repo)
• [x] Datasets (@Meiqingx and @sheoftensaid)
• [x] Facebook 2020
• [x] image-video-data-preparation (Aleks)
• [x] Automatic speech recognition (Harry)
• [x] AWS-rekognition-image-video-processing (Harry)
• [x] Data post-production (Aleks)
• [x] Entity Linking 2020
• [x] Entity Linking 2022
• [x] Race of Focus (Aleks)
• [x] Aspect-Based Sentiment Analysis
• [x] Ad-Level Party Classifier (Harry)
• [x] Party Classifier with Unique ID (Harry)
• [x] Ad Goal Classifier(Aleks)
• [x] Attack like (Harry)
• [x] Issue Classifier (Harry)
• [x] Ad Tone (Aleks)
• [x] Public Data (Aleks)

This list is comprehensive. There will be no further repos.

[SebastianZimmeck]

Travis and Mike are putting some comments in the spreadsheet. @atlasharry and @a-jacewicz will make modifications to the repos as necessary based on the spreadsheet.

[SebastianZimmeck]

@atlasharry and @a-jacewicz finished the previous tasks.

@furkmak updated the following nine repos:

@a-jacewicz

• Entity linking 2022
• Race of focus
• Aspect-Based Sentiment Analysis (ABSA)
• Ad-level Party Classifier

@atlasharry

• Party Classifier with Unique ID
• Ad Goal Classifier
• Attack Like
• Issue Classifier
• Ad Tone

It will be good if @a-jacewicz and @atlasharry could check the new scripts and files, and if the readme still makes sense.

While going through this, please also make sure to update this spreadsheet with mentions of Google Drive files, if necessary: https://docs.google.com/spreadsheets/d/1blCmGz7mBOIrch1gL4z0xMcEGlZHOsdc09PmgLW9qZg/edit#gid=0

Note for @furkmak & @Meiqingx: While checking these repos, there will be some file paths that are in fb_2022 or google_2022 repos. Since these repos are dispersed into four new repos, these repo mentions should turn into Data-post-production. Similarly, the remaining repos with Drive mentions should also be corrected with new paths.

[SebastianZimmeck]

There may be some additional updates in the in individual repos. Other than that, this is done.