Adjust readmes

[SebastianZimmeck]

We will update all readmes per the format of the entity linking readme (related issue). @atlasharry, @bella-tassone, and @a-jacewicz will do a first pass for their respective repos. Then, @furkmak and @Meiqingx and I can take a look.

[SebastianZimmeck]

Per @Meiqingx, if a repo has a preppackaged library, the readme can be shorter with just:

1. Install instructions for the library
2. Use instruction for the library (either in the readme or in the code itself via comments)

[atlasharry]

Hi everyone I have created a checklist for all the repos we have based on this sheet. The
assignees are all based on the previous Google Drive mentions task. Please feel free to add more repos to the list and delete the assignees if you think you are not familiar/someone else is more familiar with this repo

• [x] creative_overview (Aleks) with this repo
• [x] face_url_scraper_2022 (Harry)
• [x] fb_ad_scraper (Harry)
• [x] google_ads_archive (Harry)
• [x] image-video-data-preparation (Bella)
• [x] automatic-speech-recognition (Bella)
• [x] aws-rekognition-image-video-processing (Bella)
• [x] data-post-production (Aleks)
• [x] entity_linking_2022 (Harry)
• [x] ABSA (Aleks)
• [x] race_of_focus (Aleks)
• [x] ad_tone (Aleks)
• [x] party_classifier_pdid (Harry)
• [x] party_classifier (Harry)
• [x] attack_like (Bella)
• [x] ad_goal_classifier (Bella)
• [x] issue_classifier (Bella)
• [x] datasets (Aleks)
• [x] fb_ads_import (Harry)
• [x] fb_agg_reports_import (Harry)
• [x] fb_pd_id (Harry)
• [x] fb_page_names (Harry)

[atlasharry]

I think based on the previous experience on entity linking 2022's readme, finishing all repos this week might be too ambitious. @SebastianZimmeck @Meiqingx, do you have a suggested speed/ milestone we should set up for this task?

[SebastianZimmeck]

Thank you, @atlasharry!

Yes, three weeks, by the end of the semester, would be a reasonable timeline from my perspective.

[a-jacewicz]

@furkmak I believe that the README for the creative_overview repo should be good to go, I saw that you were the one who originally made the README and as such was hoping you could look over it one last time and either mark it as ready to go or give me feedback on what should be changed. Let me know if you think someone else would be better suited for doing this!

[furkmak]

Hi @a-jacewicz, the Readme looks good on my end.

[SebastianZimmeck]

I will go through @atlasharry's list above and check that the readmes are good to go.

[SebastianZimmeck]

@a-jacewicz, for creative_overview, can you fix the readme as to the following points:

Race of Focus

Scripts in this repository focus on what political race an ad is about (based on what candidates are mentioned in an ad). It needs to use the entity linker. It only contains data files (rdata and csv).

This description is not clear. I tried to fix it from what I understood. Still, the first sentence says that there are scripts in the repo and the last sentence says that there are only data files. Which is it? What resources does that repo contain and what is their purpose?

For

Issue classifier

Issue classifier trained on 2018 and 2020 ads --- both TV and Facebook, designed to be applied to uncoded 2022 ads. Based on WMP issue coding --- not Kantar.

What is "Kantar"?

[a-jacewicz]

Have worked through the points raised for the README for Creative_Overview.

[a-jacewicz]

The race-of-focus and the ad_tone repo both require the 'google_2020_adid_var1.csv.gz' file, which currently does not have a Figshare link and also is not in any public repo as far as I know. These repos READMEs can't be considered finished until how we're sharing this file is resolved.