Update README.md

README.md

@@ -1,3 +1,69 @@
----
-license: mit
----
+---
+license: mit
+pipeline_tag: audio-to-audio
+---
+FM Radio Super Resolution
+
+This is a model designed to upscale recordings of FM radio. It was created using the Aero architecture with a modified version of the "Aero" project:
+
+* Modified Project: https://github.com/pokepress/aero
+* Original: https://github.com/slp-rl/aero
+
+Usage: 
+1. Check out and install the modified version of the Aero project and put the checkpoint file in the working directory.
+2. If needed, convert the audio recordinng to 44.1 khz stereo.
+3. Call the new project with:
+   
+python predict.py experiment=aero_441-441 +filename="PATH_TO_AUDIO_FILE" +output="PATH_TO_OUTPUT_DIRECTORY" checkpoint_file="PATH_TO_CHECKPOINT_FILE"
+
+The model should be able to:
+* Reduce stereo hiss
+* Reduce certain kinds of static/interference
+* Reduce 19khz stereo pilot
+* Reduce overly warm bass frequencies (boost them 3 or so dB if you miss them)
+* Restore lost high & low frequencies (generally only up to 16khz since most training data is MP3-based)
+
+Transmitters Used: 
+* Scosche "TuneIn" FM transmitter
+* nulaxy KM28 FM transmitter
+* Monster iPod/iPhone FM transmitter
+
+Radios Used:
+* JVC PC-RM100 System (circa 1984)
+* Sony Walkman WM-F76 (Circa 1987)
+* Sony CFS 212 Boombox (circa 1988)
+* Aiwa CX NA202 System (circa 1999)
+* Kaito KA1103 (originally releaed 2004)
+* Eton Mini (circa 2017)
+* Retroid Pocket Flip (Android device with FM tuner-2023)
+
+Tracks Used:
+* The Age of Innosence Part 6 (Project Gutenberg-https://www.gutenberg.org/ebooks/8958)
+* Ghosts (Breuss Arrizabalaga Quintet-https://freemusicarchive.org/music/Breuss_Arrizabalaga_Quintet/)
+* Frequency Sweep (self-produced)
+* Peace Like A River (HoliznaCC0-https://freemusicarchive.org/music/holiznacc0/everything-hurts)
+* The News Update (Karen-https://freemusicarchive.org/music/Various_Artists/Party_Fun_With_Recorders_-_Volume_One)
+* Lawrence III discussion excerpt (self-produced)
+* Las Fábulas de Esopo Part 4 (Project Gutenberg-https://www.gutenberg.org/ebooks/21143)
+* Liian Paha Sappi Part 4 (Project Gutenberg-https://www.gutenberg.org/ebooks/20970)
+* Sticky and Addictive (Monplaisir-https://freemusicarchive.org/music/Monplaisir/Pretty_and_Invisible)
+* Time Gap (Monplaisir-https://freemusicarchive.org/music/Monplaisir/Relaxing_Ukulele)
+* Onder Moeders Vleugels Part 7 (Project Gutenberg-https://www.gutenberg.org/ebooks/26299)
+* Skipping in the No Standing Zone (Peter Gresser-https://freemusicarchive.org/music/Peter_Gresser/Reimagine_The_Game/Skipping_in_the_No_Standing_Zone/)
+* Peterchens Mondfahrt Part 8 (Project Gutenberg-https://www.gutenberg.org/ebooks/20684)
+* Vous etes belleaux (Rrrrrose Azerty-https://freemusicarchive.org/music/rrrrrose-azerty/fin-de-la-communication)
+* V. Ballet des poussins dans leurs coques Scherzino. Vivo leggiero (Skidmore College Orchestra-https://freemusicarchive.org/music/Skidmore_College_Orchestra/Mussorgskys_Pictures_at_an_Exhibition)
+* Stereo Tones (self-produced)
+* Positivity (Tadz-https://freemusicarchive.org/music/tadz/2020-2)
+* The Right of the People to Rule (Theodore Roosevelt-https://www.gutenberg.org/ebooks/10155)
+* Monteverdi's Toccata from L'Orfeo (The United States Army Old Guard Fife and Drum Corps-https://freemusicarchive.org/music/The_United_States_Army_Old_Guard_Fife_and_Drum_Corps/Celebrating_50_Years)
+* Three Hundred Tang Poems Part 81 (Project Gutenberg-https://www.gutenberg.org/ebooks/20968)
+* Tones and Noise (self-produced)
+* Main Stem (U.S. Army Blues-https://freemusicarchive.org/music/US_Army_Blues/Live_At_Blues_Alley)
+* Vince Krekeler Interview (self-produced)
+* Up, Then Down (Wax Lyricist-https://freemusicarchive.org/music/wax-lyricist/the-wax-lyricist)
+* Mom's Workout CD (Zane Little-https://freemusicarchive.org/music/zane-little/a-bag-of-chips)
+* Various computer-generated noise combinations (self-produced)
+
+Version History:
+* 1.0.0 (7/22/2024) First version published to Hugging Face