Upload Gradio config

data/offer_retailer.csv

@@ -0,0 +1,386 @@
+OFFER,RETAILER,BRAND
+Spend $50 on a Full-Priced new Club Membership,SAMS CLUB,SAMS CLUB
+"Beyond Meat® Plant-Based products, spend $25",,BEYOND MEAT
+Good Humor Viennetta Frozen Vanilla Cake,,GOOD HUMOR
+"Butterball, select varieties, spend $10 at Dillons Food Store",DILLONS FOOD STORE,BUTTERBALL
+"GATORADE® Fast Twitch®, 12-ounce 12 pack, at Amazon Storefront*",AMAZON,GATORADE
+Emmy's Organics® Cookies OR Brownie Snaps,,EMMYS POP UP
+"Dr Pepper®, Regular OR Zero Sugar Strawberries and Cream 12 pack, at select retailers",UNITED SUPERMARKETS,DR PEPPER
+"Arnold, Brownberry, Oroweat® Small Slice bread, at Walmart",WALMART,ARNOLD BROWNBERRY OROWEAT
+Barilla® Pesto Sauce,,BARILLA
+"Any General Mills™ products, buy 2
+Good Rewards Members Only",,ANNIES HOMEGROWN GROCERY
+Egglife Egg White Wraps at Aldi,ALDI,EGGLIFE
+Spend $20 at Zaxby's,ZAXBYS,ZAXBYS
+Spend $10 at Subway,SUBWAY,SUBWAY
+"DOVE® Chocolate, select sizes, buy 1",,DOVE CHOCOLATE
+Hellmann's® OR Best Foods® Garlic Aioli OR Spicy Mayonnaise,,HELLMANNS BEST FOODS
+"M&M'S®, select sizes, buy 1",,M&MS
+"GATORLYTE® OR GATORADE™ Fit Single Serve Bottle, select varieties, buy 2",,GATORADE
+"Beyond Steak™ Plant-Based seared tips, 10 ounce at Target",TARGET,BEYOND MEAT
+Red Gold Tomato Ketchup,,RED GOLD
+Gillette Venus ® for Pubic Hair & Skin spend $20,,GILLETTE VENUS
+Spend $140 at Shaws,SHAWS,SHAWS
+"L'Oréal Paris Hair color, select varieties, spend $19 at Target",TARGET,LOREAL PARIS HAIR COLOR
+Simply Spiked™ Lemonade 12 pack+,,SIMPLY SPIKED
+"Gorton's, at select retailers",SHOP RITE,GORTONS
+Shop 2 times at ACME,ACME,ACME
+"Butterball, select varieties, spend $10 at Ralphs",RALPHS,BUTTERBALL
+"Beyond Steak™ Plant-Based seared tips, 10 ounce, buy 2 at H-E-B",H-E-B,BEYOND MEAT
+"Butterball, select varieties, Spend $10 at Ruler Foods",RULER FOODS,BUTTERBALL
+Spend $20 at KFC,KFC,KFC
+Spend $15 at Nekter,NEKTER JUICE BAR,NEKTER
+Order online at Zaxbys.com,ZAXBYS,ZAXBYS
+"Butterball, select varieties, spend $10 at King Soopers",KING SOOPERS,BUTTERBALL
+Order from Casey's app or Caseys.com,CASEYS GENERAL STORE,CASEYS GENERAL STORE
+"Tru-Ray® Premium Construction Paper, spend $10",,TRURAY
+"Flonase Allergy Relief, at Walmart",WALMART,FLONASE
+Spend $25 at KFC,KFC,KFC
+"Gorton's Air Fried Butterfly Shrimp, at Walmart",WALMART,GORTONS
+"CESAR® Wet Dog Food, spend $20",,CESAR
+"TWIX®, select sizes",,TWIX
+"M&M'S® chocolate candies, select varieties",,M&MS
+"Hidden Valley® Ranch Salad Dressing OR Secret Sauce, select varieties",,HIDDEN VALLEY RANCH
+Spend $210 at Randalls,RANDALLS,RANDALLS
+"Cooked Perfect® Meatballs, at Walmart",WALMART,COOKED PERFECT
+Spend $25 at Casey's,CASEYS GENERAL STORE,CASEYS GENERAL STORE
+"Perfect Keto Barista Blend Collagen & MCTs, online at Amazon",AMAZON,PERFECT KETO
+"Creativity Street®, spend $10",,CREATIVITY STREET
+"Crunchmaster® Crackers, spend $4",,CRUNCHMASTER
+"Tyson Products, select varieties, spend $20 at Sam's Club",SAMS CLUB,BALL PARK FRANK
+"L'Oréal Paris Makeup, spend $35 at Target",TARGET,LOREAL PARIS COSMETICS
+Spend $25 at Subway,SUBWAY,SUBWAY
+Any Vons receipt,VONS,VONS
+"Chosen Foods® Mayo, select varieties",,CHOSEN FOODS
+"L'Oréal Paris Men Expert hair color, spend $19 at Walmart",WALMART,LOREAL PARIS HAIR COLOR
+Spend $185 at Shaws,SHAWS,SHAWS
+Spend $150 at Vons,VONS,VONS
+"Wine from TheBarrelRoom.com, spend $30",GALLO.COM,ALAMOS
+"General Mills™ products, select brands, spend $35",,ANNIES HOMEGROWN GROCERY
+"PepsiCo® Beverage, 7.5-ounce 10 pack, select varieties, at Amazon Storefront*",AMAZON,PEPSI
+"Sara Lee® bread, select varieties, buy 2 at Walmart®",WALMART,SARA LEE
+"Sara Lee® or Alfaros® Artesano bread, buy 5",,ALFAROS
+"Bai® Antioxidant, 6 pack, buy 2 at Walmart",WALMART,BAI
+Spend $5 in-store at Casey's,CASEYS GENERAL STORE,CASEYS GENERAL STORE
+"Reese's Chocolate Cones, 8 count at GIANT OR MARTIN’S",MARTINS FOODS,KLONDIKE
+Spend $25 at Fresh Thyme Market,FRESH THYME MARKET,FRESH THYME MARKET
+Any Albertsons receipt,ALBERTSONS,ALBERTSONS
+Shop 2 times at Albertsons,ALBERTSONS,ALBERTSONS
+Select beverages AND prepared food items at Casey's,CASEYS GENERAL STORE,CASEYS GENERAL STORE
+QUEEN V® The VIP & The Wingwoman Soft Touch Silicone Vibrator at Walmart,WALMART,QUEEN V
+"Back to the Roots Grow Seed Starting Pots OR Germination Trays, at Walmart or Target",TARGET,BACK TO THE ROOTS
+"Dove Hand Wash, select varieties, buy 2 at Target",TARGET,DOVE
+"Frutero Ice Cream, 1 pint",,FRUTERO
+Red Gold Tomato Juice,,RED GOLD
+"Bio-Oil® Skincare Oil OR Gel, select varieties",,BIO OIL
+Spend $65 at Albertsons,ALBERTSONS,ALBERTSONS
+"Welch's®Fruit Snacks, select varieties, buy 2",,WELCHS FRUIT SNACKS
+Talenti Mini Bars,,TALENTI
+Visit OR order online from Casey's 7 times,CASEYS GENERAL STORE,CASEYS GENERAL STORE
+"Simply Spiked™ Signature Peach 12-pack or larger, buy 2",,SIMPLY SPIKED
+"Molson Coors®, select varieties, 12 pack+",,COORS LIGHT
+"Welch's® Zero Sugar Fruity Bites, 6 pack+, online at Amazon",AMAZON,WELCHS FRUIT SNACKS
+"PepsiCo® Variety Pack, select varieties, at Amazon Storefront*",AMAZON,PEPSI
+Spend $100 at Vons,VONS,VONS
+Spend $15 at Subway,SUBWAY,SUBWAY
+Spend $35 at Fresh Thyme Market,FRESH THYME,FRESH THYME MARKET
+Sign up for The Club Card or The Club+ Card full-priced membership* (New Members Only),BJS WHOLESALE,BJS WHOLESALE
+"Marinela® sweet baked goods, buy 2",,MARINELA
+"Back to the Roots Soils, select varieties and sizes, at Walmart",WALMART,BACK TO THE ROOTS
+"Any General Mills™ products, spend $60",,ANNIES HOMEGROWN
+"Welch's® Fruit Snacks, select varieties, 6 count+, buy 3",,WELCHS FRUIT SNACKS
+Spend $90 at Tom Thumb,TOM THUMB,TOM THUMB
+Spend $5 on single-serve prepared food items at Casey's,CASEYS GENERAL STORE,CASEYS GENERAL STORE
+"Coors Light®, Miller Lite® OR VIZZY™ 12 pack+",,VIZZY
+"Cooked Perfect® Meatballs, Homestyle OR Turkey, at Walmart",WALMART,COOKED PERFECT
+12 Pack OR 2 Liter AND Whole Pizza Pie at Casey's,CASEYS GENERAL STORE,CASEYS GENERAL STORE
+"General Mills™ products, select brands, spend $7 at Convenience Stores",,ANNIES HOMEGROWN GROCERY
+Gillette Venus ® for Pubic Hair & Skin,,GILLETTE VENUS
+"Barilla® Pasta, select varieties, buy 2",,BARILLA
+Little Bites® Spend $10 at Walmart®,WALMART,ENTENMANNS
+Envy Apples pre-packed bags,,ENVY
+Shop 2 times at Tom Thumb,TOM THUMB,TOM THUMB
+"Ben & Jerry's Frozen Creme Brulee Non Dairy Dessert, 16 ounce",,BEN AND JERRYS
+"Purex® laundry detergent, select varieties, at Walmart",WALMART,PUREX
+Whole Pizza at Casey's,CASEYS GENERAL STORE,CASEYS GENERAL STORE
+Shop 2 times at Safeway,SAFEWAY,SAFEWAY
+"Any General Mills™ products, spend $30",,ANNIES HOMEGROWN
+"Ben & Jerry's® Doggie Desserts, 4 count",,BEN AND JERRYS
+Sol® 6 pack+,,SOL CERVEZA
+"George's Farmers Market Chicken Wings, at Sam's Club",SAMS CLUB,GEORGES FARMERS MARKET
+"Michael Angelo's® OR Rao's® Frozen Entrees, spend $10",,RAO'S
+"Sargento Sliced Cheese, spend $25",,SARGENTO
+"Sargento Sliced Cheese, spend $12",,SARGENTO
+Country Crock® Plant Based Butter at Walmart,WALMART,COUNTRY CROCK PLANT BUTTER
+"Perfect Keto Beauty + Sleep Collagen, online at Amazon",AMAZON,PERFECT KETO
+"DOVE® chocolate, select varieties",,DOVE CHOCOLATE
+Simply Spiked™ 12 pack+,,SIMPLY SPIKED
+"Perfect Keto Bars, online at Amazon",AMAZON,PERFECT KETO
+"Gillette Venus ® for Pubic Hair & Skin, spend $20",,GILLETTE VENUS
+AleveX™ at Walmart,WALMART,ALEVE
+"Envy Apples, pre-packed bags",,ENVY
+"Ben & Jerry's Frozen Sugar Cookie Dough Chunks, 8 ounce",,BEN AND JERRYS
+"L’Oréal Paris Men Expert hair color, spend $9 at Walmart",WALMART,LOREAL PARIS HAIR COLOR
+"Reese's Peanut Butter Bar, 6 count, at GIANT OR MARTIN’S",THE GIANT CO,GOOD HUMOR
+"Magnum Non-Dairy Hazelnut Crunch Ice Cream Bars, 3 count",,MAGNUM ICE CREAM
+"Butterball, select varieties, spend $10 at Fred Meyer",FRED MEYER,BUTTERBALL
+"Thomas'® Bagel Thins®, buy 2",,THOMAS
+Spend $60 at TGI Friday's,TGI FRIDAYS,TGI FRIDAYS
+"Artesano® buns, buy 2 at Walmart®",WALMART,SARA LEE ARTESANO
+"STARBURST®, select sizes, buy 1",,STARBURST
+Fresh Step® Outstretch® Cat Litter,,FRESH STEP
+"Sara Lee® or Alfaros® Artesano bread, spend $8",,ALFAROS
+"Back to the Roots Dry Plant Food, 5 pounds, at The Home Depot",THE HOME DEPOT,BACK TO THE ROOTS
+"Burt's Bees Sensitive Lotions and Creams, select varieties, at Walmart",WALMART,BURTS BEES
+"Durex® Massage & Play 2 in 1 Pleasure Gel, select varieties, at Walmart or Target",TARGET,DUREX
+"Coors Light®, Miller Lite® OR VIZZY™ 12 packs+, buy 4",,VIZZY
+LIFE SAVERS®,,LIFESAVERS
+"Butterball, select varieties, spend $10 at Kroger",KROGER,BUTTERBALL
+"RESPAWN® by 5® GUM, at Walmart",WALMART,5 GUM
+"Back to the Roots Garden Soil, 1 cubic foot, at Lowe's Home Improvement",LOWES HOME IMPROVEMENT,BACK TO THE ROOTS
+"SiO® Beauty Patches, online at Siobeauty.com",SIOBEAUTY.COM,SIO BEAUTY
+Wesson® Oil Products,,WESSON
+"Bubbies Pickles, Sauerkraut, and Condiments at Whole Foods or Sprouts",SPROUTS FARMERS MARKET,BUBBIES
+Michael Angelo's® Sauce at Walmart,WALMART,MICHAEL ANGELO'S
+Spend $155 at Pavilions,PAVILIONS,PAVILIONS
+CESAR® Wet Dog Food Singles,,CESAR
+Spend $90 at ACME,ACME,ACME
+"Hidden Valley® Ranch Seasoning Mix Packet, 1 count",,HIDDEN VALLEY RANCH
+"Sargento® products, select varieties",,SARGENTO
+"Welch's® Fruit Snacks, 250 count, online at Amazon",AMAZON,WELCHS FRUIT SNACKS
+"Ben & Jerry's®, select varieties",,BEN AND JERRYS
+Simply Spiked™ Signature Peach 12 pack+,,SIMPLY SPIKED
+"Beech-Nut snacks, select varieties",,BEECHNUT
+"Sargento® products, select varieties, buy 3",,SARGENTO
+Spend $250 at ACME,ACME,ACME
+Wings OR Cheesy Breadsticks at Casey's,CASEYS GENERAL STORE,CASEYS GENERAL STORE
+"Butterball, select varieties, spend $10 at Smith's",SMITHS,BUTTERBALL
+"Perfect Keto Collagen Peptides, online at Amazon",AMAZON,PERFECT KETO
+"Perfect Keto MCT Oil Powder, online at Amazon",AMAZON,PERFECT KETO
+Hellmann's® OR Best Foods® AND Sargento® Cheese Slices,,HELLMANNS BEST FOODS
+Brita® Pitcher AND Filter,,BRITA
+Spend $90 at Star Market,STAR MARKET,STAR MARKET
+"SNICKERS®, select sizes, buy 1",,SNICKERS
+"Kodiak® products, select varieties, spend $10",,KODIAK CAKES FLAPJACK & WAFFLE MIX
+Bays® English Muffins,,BAYS
+"Super Coffee, 12 ounce single serve, buy 3",,SUPER COFFEE
+"Sara Lee® bread select varieties, buy 2",WALMART,SARA LEE
+GOYA® Coconut Water,,GOYA
+Spend $35 at TGI Friday's,TGI FRIDAYS,TGI FRIDAYS
+Spend $110 at Randalls,RANDALLS FOOD MARKETS,RANDALLS
+"Reese's Chocolate Cones, 8 count at GIANT OR MARTIN’S",GIANT FOOD,KLONDIKE
+Whole Pizza Pie at Casey's,CASEYS GENERAL STORE,CASEYS GENERAL STORE
+Shop 2 times at Star Market,STAR MARKET,STAR MARKET
+"Hidden Valley® Ranch Seasoning, select varieties",,HIDDEN VALLEY RANCH
+"General Mills™ products, select varieties, spend $12",,ANNIES HOMEGROWN GROCERY
+Blue Apron Meal Kits,BLUE APRON,BLUE APRON
+"Aleve® products, select varieties, 80 count+ at Walmart",WALMART,ALEVE
+"Welch's® Juicefuls® Juicy Fruit Snacks, 14 count, at Target",TARGET,WELCHS FRUIT SNACKS
+"Welch's® Fruit Snacks, select varieties, 6 count+, buy 2",,WELCHS FRUIT SNACKS
+"Sign up for McAlister's Deli Rewards, tap for details",MCALISTERS DELI,MCALISTERS DELI
+"Arbos Cheese Dip, 12 ounce, buy at Central Market",CENTRAL MARKET,ARBOS
+L'Oréal Paris Excellence Hair Color at Target,TARGET,LOREAL PARIS HAIR COLOR
+"Kradle, select varieties, spend $20 at Walmart",WALMART,KRADLE
+Frozen OR Fountain Drink at Casey's,CASEYS GENERAL STORE,CASEYS GENERAL STORE
+"Arnold, Brownberry, Oroweat® Keto bread, buy 2",,ARNOLD BROWNBERRY OROWEAT
+Shop 2 times at Shaw's,SHAWS,SHAWS
+"Welch's®Fruit Snacks, spend $8",,WELCHS FRUIT SNACKS
+"Children's Astepro® Allergy, 22 count at Dollar General",DOLLAR GENERAL STORE,ASTEPRO
+Spend $10 in-store at Casey's,CASEYS GENERAL STORE,CASEYS GENERAL STORE
+"Fresh bakery item, select varieties, at Casey's",CASEYS GENERAL STORE,CASEYS GENERAL STORE
+"SNICKERS® chocolate candy bar, select varieties",,SNICKERS
+Rao's® Frozen Pizza,,RAO'S
+"GATORADE® Fast Twitch®, 12-ounce single serve, buy 2 at Kroger",FRED MEYER,GATORADE
+"Bimbo® sweet baked goods, buy 2",,BIMBO
+Any Shaw's receipt,SHAWS,SHAWS
+"Gorton's, at select retailers",STOP & SHOP,GORTONS
+"Butterball, select varieties, spend $10 at Food 4 Less",FOOD4LESS,BUTTERBALL
+NatuChips® Plantain Chips,,NATUCHIPS
+"Beech-Nut pouches, buy 8",,BEECHNUT
+Spend $45 at Zaxby's,ZAXBYS,ZAXBYS
+"Back to the Roots Raised Bed Gardening Kit with Soil, Seeds and Plant Food, at Target",TARGET,BACK TO THE ROOTS
+"Ben & Jerry's®, select varieties, spend $12",,BEN AND JERRYS
+Any ACME receipt,ACME,ACME
+Spend $220 at Tom Thumb,TOM THUMB,TOM THUMB
+"Promised Land Dairy Milk, 52-ounce",,PROMISED LAND DAIRY
+"Welch's® Fruit 'n Yogurt® Snacks, 18 count, at Walmart",WALMART,WELCHS FRUIT SNACKS
+Hidden Valley® Ranch Seasoning Shaker,,HIDDEN VALLEY RANCH
+"CORE® Hydration, select varieties, at Walmart",WALMART,CORE HYDRATION
+When you join Costco as a Gold Star Member* (New Members Only),COSTCO,COSTCO
+Whole pizza at Casey's,CASEYS GENERAL STORE,CASEYS GENERAL STORE
+Spend $40 at Farmer Boys,FARMER BOYS,FARMER BOYS
+"Colgate® Toothpaste AND Colgate® Toothbrush, select varieties at Walmart or Target",TARGET,COLGATE TOOTHBRUSHES
+"L'Oréal Paris Hair color, select varieties, spend $25 at Target",TARGET,LOREAL PARIS HAIR COLOR
+"TWIX®, select varieties",,TWIX
+Spend $15 at KFC,KFC,KFC
+Spend $275 at Vons,VONS,VONS
+"EXTRA®, select varieties",,EXTRA
+"Ben & Jerry's® Doggie Desserts, 4 ounce, buy 2",,BEN AND JERRYS
+"Klondike Cones, spend $10 at Walmart ",WALMART,KLONDIKE
+"Reese's Peanut Butter Bar, 6 count, at GIANT OR MARTIN’S",MARTINS FOODS,GOOD HUMOR
+"Beyond Steak™ Plant-Based seared tips, 10 ounce at H-E-B",H-E-B,BEYOND MEAT
+"Kradle, select products, online at Chewy.com",CHEWY,KRADLE
+Spend $120 at Star Market,STAR MARKET,STAR MARKET
+Shop 2 times at Vons,VONS,VONS
+Wonderworks™ Keto* Friendly Cereal,,WONDERWORKS
+"MTN DEW® Kickstart, 16-ounce 12 count, select varieties, at Amazon Storefront*",AMAZON,MOUNTAIN DEW
+When you join Costco as an Executive Member* (New Members Only),COSTCO,COSTCO
+"Adult Astepro® Allergy, 22 count at Dollar General",DOLLAR GENERAL STORE,ASTEPRO
+Shop 2 times at Pavilions,PAVILIONS,PAVILIONS
+"SKITTLES®, select varieties",,SKITTLES
+"Stubborn Soda OR Bundaberg Ginger Beer, select varieties, at Amazon Storefront*",AMAZON,STUBBORN SODA
+"BallPark® buns, buy 2",,BALL PARK POP UPS
+12 Pack OR 2 Liter AND Whole Pizza at Casey's,CASEYS GENERAL STORE,CASEYS GENERAL STORE
+Spend $220 at Star Market,STAR MARKET,STAR MARKET
+Frozen OR Fountain Drink at Casey's ,CASEYS GENERAL STORE,CASEYS GENERAL STORE
+Spend $45 at TGI Friday's,TGI FRIDAYS,TGI FRIDAYS
+Visit OR order online from Casey's 3 times,CASEYS GENERAL STORE,CASEYS GENERAL STORE
+Spend $210 at Randalls,RANDALLS FOOD MARKETS,RANDALLS
+Visit OR order online from Casey's 5 times,CASEYS GENERAL STORE,CASEYS GENERAL STORE
+Any Tom Thumb receipt,TOM THUMB,TOM THUMB
+"Butterball, select varieties, spend $10 at Fry's Food Store",FRYS FOOD STORE,BUTTERBALL
+"ORBIT®, select sizes, buy 1",,ORBIT
+12 pack OR 2 liter AND Whole Pizza at Casey's,CASEYS GENERAL STORE,CASEYS GENERAL STORE
+"Molson Coors®, select varieties, 12 Pack+, buy 2",,TOPO CHICO HARD SELTZER
+"Thomas'®, select varieties, spend $10",,THOMAS
+"Beyond Steak™ Plant-Based seared tips, 10 ounce, buy 2 at Target",TARGET,BEYOND MEAT
+Whole Pizza at Casey's ,CASEYS GENERAL STORE,CASEYS GENERAL STORE
+"EXTRA®, select sizes",,EXTRA
+Gorton's at select retailers,STOP & SHOP,GORTONS
+Brita® Standard OR Elite Filters,,BRITA
+Spend $300 at Shaws,SHAWS,SHAWS
+Spend $50 at Fresh Thyme Market,FRESH THYME MARKET,FRESH THYME MARKET
+"Starry™ Lemon Lime Soda multipacks, at Kroger",DILLONS GROCERY,STARRY
+"Barilla® pasta, select varieties, buy 3",,BARILLA
+"Fresh Bakery Products at Casey's, select varieties",CASEYS GENERAL STORE,CASEYS GENERAL STORE
+"Coors Light®, Miller Lite® OR VIZZY™ 12 packs+, buy 2",,VIZZY
+"Kradle, select varieties, online at Amazon",AMAZON,KRADLE
+"Starry™ Lemon Lime Soda, 7.5-ounce 10 pack, at Amazon Storefront*",AMAZON,STARRY
+"EVOLVE® Plant-Based Protein Shake, 4 count, select varieties, at Whole Foods",WHOLE FOODS MARKET,EVOLVE
+"Burt's Bee's® Facial Wipes, select varieties, 30 count at Walmart",WALMART,BURTS BEES
+"Aleve® products AND AleveX™, select varieties, at Walmart",WALMART,ALEVE
+"Beyond Meat® Plant-Based products, spend $15",,BEYOND MEAT
+"GOYA® Adobo Seasoning, 8 ounce+",,GOYA
+"Tyson Products, select varieties, spend $15 at Walmart",WALMART,AIDELLS
+Spend $210 at Safeway,SAFEWAY,SAFEWAY
+Klondike Cones at Walmart ,WALMART,KLONDIKE
+Spend $110 at Albertsons,ALBERTSONS,ALBERTSONS
+"Bubbies Pickles, Sauerkraut, OR Condiments at Whole Foods or Sprouts",SPROUTS FARMERS MARKET,BUBBIES
+"Sara Lee® or Alfaros® Artesano bread, buy 2",,ALFAROS
+"Beyond Meat® Plant-Based products, spend $20",,BEYOND MEAT
+Spend $10 on Casey's branded packaged products,CASEYS GENERAL STORE,CASEYS GENERAL STORE
+Any Randalls receipt,RANDALLS FOOD MARKETS,RANDALLS
+"Arber, at Target",TARGET,ARBER
+"Häagen-Dazs®, 28 ounce, at GROCERY* stores",,HAAGEN DAZS
+Spend $130 at ACME,ACME,ACME
+"Spend $110 on a Full-Priced new Plus Membership and receive an ADDITIONAL 10,000 points",SAMS CLUB,SAMS CLUB
+"Butterball, select varieties, spend $10 at QFC",QFC,BUTTERBALL
+Spend $100 at Pavilions,PAVILIONS,PAVILIONS
+"Glad® Trash Bags, 4 OR 8 Gallon",,GLAD
+Tostitos® Toppers™,,TOSTITOS
+:ratio™ KETO* Friendly Cereal OR Granola,,RATIO
+"Burt's Bees® products, select varieties, at Walmart",WALMART,BURTS BEES
+"Bio-Oil® products, select varieties",,BIO OIL
+"André® California, Champagne OR Sparkling Wines, 750mL bottle",,ANDRE
+Spend $20 at Farmer Boys,FARMER BOYS,FARMER BOYS
+"Any General Mills™ products, spend $50",,ANNIES HOMEGROWN
+Chosen Foods® Dressings,,CHOSEN FOODS
+Spend $30 at Dickey's Barbecue Pit,DICKEYS BARBECUE PIT,DICKEYS BARBECUE PIT
+Degree for Men OR Women Dry Spray,,DEGREE
+"Coors Light®, Miller Lite® OR VIZZY™ 12 packs+, buy 3",,VIZZY
+Back to the Roots Microgreens Grow Kit OR Seed Refill at Walmart,WALMART,BACK TO THE ROOTS
+Spend $40 at KFC,KFC,KFC
+"Bai® Antioxidant, 6 pack, at Walmart",WALMART,BAI
+Spend $20 at Dickey's Barbecue Pit,DICKEYS BARBECUE PIT,DICKEYS BARBECUE PIT
+Spend $25 at TGI Friday's,TGI FRIDAYS,TGI FRIDAYS
+"L'Oréal Paris Hair color, select varieties, spend $9 at Target",TARGET,LOREAL PARIS HAIR COLOR
+"Sargento Sliced Cheese, spend $18",,SARGENTO
+"SKITTLES®, select sizes",,SKITTLES
+"LIFESAVERS®, any size, buy 1",,LIFESAVERS
+"L'Oréal Paris Makeup, spend $30 at Target",TARGET,LOREAL PARIS COSMETICS
+Spend $115 at Tom Thumb,TOM THUMB,TOM THUMB
+Any Randalls receipt,RANDALLS,RANDALLS
+Spend $75 at Randalls,RANDALLS,RANDALLS
+Shop 2 times at Randalls,RANDALLS FOOD MARKETS,RANDALLS
+"GATORADE® Fast Twitch®, 12-ounce single serve",,GATORADE
+Spend $10 at Nekter,NEKTER JUICE BAR,NEKTER
+"Brownie Brittle® Snacks, select varieties, buy 2",,BROWNIE BRITTLE
+Cheerios™ Oat Crunch Berry Cereal,,CHEERIOS
+Glad® ForceFlex Max Strength Trash Bags,,GLAD
+"GATORADE® Fast Twitch®, 12-ounce single serve, at Kroger",DILLONS GROCERY,GATORADE
+Spend $10 at CVS,CVS,CVS
+"OxiClean™ Laundry Stain Removers, select varieties at Walmart",WALMART,OXICLEAN
+Country Crock® Plant Based Cream at Walmart,WALMART,COUNTRY CROCK PLANT BUTTER
+2 Pack OR 2 Liter AND Whole Pizza at Casey's,CASEYS GENERAL STORE,CASEYS GENERAL STORE
+Arnold® Grains Almighty,,ARNOLD BROWNBERRY OROWEAT
+"Snuggle® Liquid Fabric Softener, at Walmart",WALMART,SNUGGLE
+"Hidden Valley® Ranch Night Seasoning Mix, 1 count",,HIDDEN VALLEY RANCH
+"Kradle, select varieties, at Pet Supplies Plus",PET SUPPLIES PLUS,KRADLE
+"Back to the Roots Soils, select varieties and sizes, at Lowes",LOWES HOME IMPROVEMENT,BACK TO THE ROOTS
+"Butterball, select varieties, spend $10 at Mariano's",MARIANOS,BUTTERBALL
+"CORE® Hydration, select varieties, buy 2 at Walmart",WALMART,CORE HYDRATION
+Spend $40 at Dickey's Barbecue Pit,DICKEYS BARBECUE PIT,DICKEYS BARBECUE PIT
+"General Mills™ snacks, select brands, spend $10",,BUGLES
+"Back to the Roots Soils, select varieties, at Walmart or Lowes",LOWES HOME IMPROVEMENT,BACK TO THE ROOTS
+"Barilla® pasta, select varieties, buy 4",,BARILLA
+"GATORLYTE® OR GATORADE™ Fit Single Serve Bottle, select varieties",,GATORADE
+"Burt's Bees® Sensitive Lotions and Creams, select varieties, at Walmart",WALMART,BURTS BEES
+"Arber, at Walmart",WALMART,ARBER
+"Coors Light®, Miller Lite® OR VIZZY™ 12 packs+, buy 5",,VIZZY
+Any Pavilions receipt,PAVILIONS,PAVILIONS
+Back to the Roots Grow Kits at Walmart or The Home Depot,WALMART,BACK TO THE ROOTS
+Any Safeway receipt,SAFEWAY,SAFEWAY
+"Welch's® Fruit Snacks, select varieties, 6 count+",,WELCHS FRUIT SNACKS
+Back to the Roots Grow Hydroponic Grow Kit OR Refill Bundle at Walmart,WALMART,BACK TO THE ROOTS
+"Ben & Jerry's Wake & No Bake Cookie Dough Ice Cream, 16 ounce",,BEN AND JERRYS
+"ORBIT®, select varieties",,ORBIT
+"GATORADE® Fast Twitch®, 12-ounce single serve, buy 2 at Kroger",FOOD4LESS,GATORADE
+"Butterball, select varieties, spend $10 at Pick 'n Save OR Metro Market",PICK N SAVE,BUTTERBALL
+Hellmann's | Best Foods Vegan Dressing or Spread,,HELLMANNS BEST FOODS
+"Rao's®, Pasta OR Sauce, spend $10",,RAO'S
+L'Oreal Paris True Match Foundation at Target,TARGET,LOREAL PARIS COSMETICS
+"Sara Lee® or Alfaros® Artesano bread, spend $20",,ALFAROS
+Spend $220 at Albertsons,ALBERTSONS,ALBERTSONS
+"Perfect Keto Super Reds, online at Amazon",AMAZON,PERFECT KETO
+The Rustik Oven® bread,,RUSTIK OVEN
+Gorton's at select retailers,WALMART,GORTONS
+"Back to the Roots Seeds, at Walmart",WALMART,BACK TO THE ROOTS
+Nature Valley™ Protein Granola,,NATURE VALLEY
+Brita® Pitcher OR Dispenser,,BRITA
+Spend $30 at CVS,CVS,CVS
+"Back to the Roots Organic Kits and Planters, at Target",TARGET,BACK TO THE ROOTS
+"Sir Kensington's® Condiments, buy 2",,SIR KENSINGTONS
+"Perfect Keto Exogenous Ketones Powder, online at Amazon",AMAZON,PERFECT KETO
+Select Beverages AND Prepared Food Item at Casey's,CASEYS GENERAL STORE,CASEYS GENERAL STORE
+"Back to the Roots Potting Mix, 1 cubic foot, at Lowe's Home Improvement",LOWES HOME IMPROVEMENT,BACK TO THE ROOTS
+"Barilla® pasta, select varieties, buy 2",,BARILLA
+Any Star Market receipt,STAR MARKET,STAR MARKET
+"Squirrel, The Bedside Perch, online at Amazon",AMAZON,SQUIRREL
+"Fresh Bakery items, select varieties, at Casey's",CASEYS GENERAL STORE,CASEYS GENERAL STORE
+Ben & Jerry's® Churray For Churros™ Ice Cream,,BEN AND JERRYS
+Sir Kensington's® Condiments,,SIR KENSINGTONS
+"Dove Hand Wash, select varieties at Target",TARGET,DOVE
+Spend $15 at Burger King,BURGER KING,BURGER KING
+Cameron’s Coffee EcoPods,,CAMERON'S COFFEE
+L'Oréal Paris True Match Foundation at Target,TARGET,LOREAL PARIS COSMETICS
+"Sara Lee® Delightful bread, buy 2",,SARA LEE
+"Welch's® Juicefuls® Juicy Fruit Snacks, buy 2",,WELCHS FRUIT SNACKS
+Spend $35 at Subway,SUBWAY,SUBWAY
+"Dixon® Safety Carpenter Pencil, 10 count, at Lowe’s®",LOWES HOME IMPROVEMENT,DIXON
+Spend $115 at Safeway,SAFEWAY,SAFEWAY
+"Breyers Reese's Ice Cream, select varieties, at GIANT OR MARTIN’S",MARTINS FOODS,BREYERS
+Shop 2 times at Randalls,RANDALLS,RANDALLS
+"Jack Link's®, select varieties",,JACK LINKS
+"Persil® ProClean®, select varieties, at Walmart",WALMART,PERSIL
+"Back to the Roots Organic 3-In-1 Seed Starting Mix 12 quart, at Walmart or Target",TARGET,BACK TO THE ROOTS
+"STARBURST®, select varieties",,STARBURST
+"Super Coffee, 12 ounce single serve",,SUPER COFFEE
+Spend $90 at Safeway,SAFEWAY,SAFEWAY
+Spend $5 on brisket mac & cheese sandwich OR other single-serve prepared food item,CASEYS GENERAL STORE,CASEYS GENERAL STORE
+Spend $50 at Chewy.com,CHEWY,CHEWY
+Simply Organic Seasoning Mixes OR Spices,,SIMPLY ORGANIC
+Spend $10 at KFC,KFC,KFC
+Sargento Product,,SARGENTO
+Thomas'® Bagel Thins,,THOMAS
+Spend $270 at Pavilions,PAVILIONS,PAVILIONS
+"Back to the Roots Soils, select varieties, at Walmart",WALMART,BACK TO THE ROOTS

data/offered_brands.pkl

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:b4d562168ec2efa207d65d6dc88d9c3c07cb7ffc106906cd66d0370173cf7289
+size 1345

data/product_upper_category_dict.json

@@ -0,0 +1 @@
+{"ALCOHOL": ["Beer", "Malt Beverages", "Hard Seltzers, Sodas, Waters, Lemonades & Teas", "Hard Ciders", "Wine", "Spirits"], "ANIMALS & PET SUPPLIES": ["Dog Supplies"], "BABY & TODDLER": ["Baby Bathing", "Potty Training", "Baby Safety", "Diapering", "Baby Health"], "BEAUTY": ["Cosmetic Tools", "Makeup", "Nail Care", "Body Fragrances"], "BEVERAGES": ["Coffee", "Meal Replacement Beverages", "Vegetable Juices", "Drink Mixes", "Tea", "Energy Drinks", "Water", "Fruit Juices", "Carbonated Soft Drinks"], "CANDY": ["Gum"], "DAIRY": ["Cream", "Dairy Alternatives", "Dairy", "Yogurt", "Milk", "Cheese", "Butter & Margarine", "Eggs", "Refrigerated Doughs"], "DELI & BAKERY": ["Leafy Salads", "Deli Counter", "Bakery", "Prepared Meals"], "FROZEN": ["Frozen Fruits", "Frozen Desserts", "Frozen Sides", "Frozen Meals", "Frozen", "Frozen Vegetables", "Ice", "Frozen Breads & Doughs", "Frozen Pizza & Pizza Snacks", "Frozen Breakfast", "Frozen Plant-Based Meat", "Frozen Appetizers"], "FROZEN MEAT": ["Frozen Turkey", "Frozen Chicken", "Frozen Beef", "Frozen Seafood"], "HEALTH & WELLNESS": ["Feminine Hygeine", "Sexual Health", "Foot Care", "Deodorant & Antiperspirant", "Skin Care", "Oral Care", "Eye Care", "First Aid", "Hair Care", "Hair Removal", "Adult Incontinence", "Bath & Body", "Medicines & Treatments"], "HOME & GARDEN": ["Decor"], "HOUSEHOLD SUPPLIES": ["Household Cleaning Supplies", "Household Supplies", "Pest Control", "Food Storage", "Laundry Supplies"], "MATURE": ["Tobacco Products", "Mature"], "MEAT & SEAFOOD": ["Plant-Based Meat"], "ORAL CARE": ["Toothpaste"], "PANTRY": ["Cooking & Baking", "Packaged Seafood", "Nut Butters & Jam", "Cereal, Granola, & Toaster Pastries", "Condiments", "Packaged Meals & Sides", "Soup & Broth", "Bread", "Sauces & Marinades", "Packaged Fruit & Applesauce", "Pickled Goods", "Dressings", "Packaged Meat", "Pasta & Noodles", "Packaged Vegetables", "Rice & Grains"], "PASTA & NOODLES": ["Dry Pasta", "Fresh Pasta"], "PASTA SAUCE": ["Red Pasta Sauce", "Alfredo & White Pasta Sauce", "Pesto Sauce"], "PUFFED SNACKS": ["Popcorn"], "SNACKS": ["Candy", "Pretzels", "Snack Mixes", "Dips & Salsa", "Crackers", "Dessert Toppings", "Puffed Snacks", "Jerky & Dried Meat", "Chips", "Nuts & Seeds", "Cookies", "Trail Mix", "Fruit & Vegetable Snacks", "Snack Cakes", "Pudding & Gelatin"], "SPIRITS": ["Rum", "Vodka"], "SPORTS DRINKS & ENHANCED WATERS": ["Sports Drinks"]}

gradio_deploy.py

@@ -0,0 +1,62 @@
+import gradio as gr
+import pandas as pd
+import numpy as np
+
+import pickle, json
+from src.utils import *
+
+##### Start #####
+
+# load operation data
+path1 = "data/brand_belong_category_dict.json"
+path2 = "data/product_upper_category_dict.json"
+path3 = "data/offered_brands.pkl"
+path4 = "data/offer_retailer.csv"
+
+with open(path1, 'r') as f:
+    brand_belong_category_dict = json.load(f)
+
+with open(path2, 'rb') as f:
+    category_dict = json.load(f)
+
+with open(path3, 'rb') as f:
+    offered_brands = pickle.load(f)
+
+df_offers_brand_retailer = pd.read_csv(path4)
+
+examples = [
+    ["Simply Spiked Lemonade 12 pack at Walmart"],
+    ["Back to the Roots Garden Soil, 1 cubic foot, at Lowe's Home Improvement"],
+    ["Costco Member subscription"],
+    ["Apple watch coupon at Best Buy"],
+    ["A giraffe at Lincoln Park Zoo"]
+]
+
+def main(sentence: str, score_type: str, threshold_cosine: float, threshold_jaccard: float):
+    threshold = threshold_cosine if score_type == "cosine" else threshold_jaccard    
+    results = search_offers(sentence, df_offers_brand_retailer, category_dict, brand_belong_category_dict, score_type, threshold)
+    message, processed_results = process_output(results)
+    return message, processed_results
+
+def process_output(output):
+    """Function to process the output"""
+    if output is None or output.empty:
+        return "We couldn't find your results, please try our examples or search again", None
+    else:
+        return "We found some great offers!", output
+
+iface = gr.Interface(
+    fn=main,
+    inputs=[
+        gr.Textbox(lines=1, placeholder="Type here..."),
+        gr.Dropdown(choices=["cosine", "jaccard"], label="Score Type"),
+        gr.Slider(minimum=0, maximum=1, step=0.1, label="Threshold for Cosine Similarity"),
+        gr.Slider(minimum=0, maximum=1, step=0.1, label="Threshold for Jaccard Similarity")
+    ],
+    outputs=[gr.Textbox(placeholder="Message..."), gr.Dataframe()],
+    examples=examples,
+    live=False,
+)
+
+if __name__ == "__main__":
+    iface.launch()

src/utils.py

@@ -0,0 +1,283 @@
+# helper functions
+from typing import List, Dict, Tuple
+import re
+from sklearn.feature_extraction.text import CountVectorizer
+from sklearn.metrics.pairwise import cosine_similarity
+import pandas as pd
+import numpy as np
+
+from IPython.display import clear_output
+
+import spacy
+from spacy.tokens import DocBin
+from spacy.training import offsets_to_biluo_tags
+import en_fetch_ner_spacy_tsf
+nlp = en_fetch_ner_spacy_tsf.load()
+clear_output()
+
+import nltk
+nltk.download('stopwords')
+
+from nltk.corpus import stopwords
+stop_words = set(stopwords.words('english'))
+additional_stop_words = {'pack'}
+stop_words.update(additional_stop_words)
+clear_output()
+
+
+def single_text_cleaner(text: str, remove_stopwords: bool=False, upper_case: bool = False, remove_punctuation: bool=True) -> str:
+    """Clean one single text input. By default it will convert text to lower case"""
+    if upper_case:
+        text = text.upper()
+    else:
+        text = text.lower()
+    if remove_punctuation:
+        text = re.sub(r'[^a-z\s]', '', text)
+    if remove_stopwords:
+        words = text.split()
+        words = [word for word in words if word not in stop_words]
+        text = ' '.join(words)
+    return text
+
+def list_text_cleaner(texts: List[str], upper_case: bool = False, remove_stopwords: bool = False, remove_punctuation: bool=True) -> List[str]:
+    """Takes in a list of strings and returns a list of cleaned strings without stop words. 
+    Current tasks: 
+    - remove non-alphabetical characters
+    - converting to lower cases
+    - remove stop words (optional)"""
+    cleaned_texts = [single_text_cleaner(text, remove_stopwords, upper_case, remove_punctuation) for text in texts]
+    return cleaned_texts
+
+def match_product_category(s1: list[str], s2: list[str]) -> str:
+    """Find if items of a list is in one list of product categories"""
+    return next((p for c in s1 for p in s2 if c in p), None) # this will stop after finding first match, which saves time
+
+def find_category(search_input: str, search_dict: Dict) -> str:
+    """Find the category of a search input based on a dictionary of categories
+    Args:
+    - search_input: a string
+    - search_dict: a dictionary of product categories
+    """
+    search_list = list_text_cleaner(re.split(r'[,\s]+', search_input), remove_stopwords=True)
+    search_list = [c for c in search_list if len(c)>0] # sometimes there are empty strings
+    matched_category = False
+    for k, v in search_dict.items():
+        v = list_text_cleaner(v, remove_punctuation=False)
+        search_results = match_product_category(search_list, v)
+        if search_results is not None:
+            matched_category = True
+            return k, search_results
+        else:
+            # print(f'Function find_category: No category {k} has matched for input: {search_input}') 
+            continue
+    if not matched_category:
+        print(f'Function find_category: No category has matched for input: {search_input}')
+        return None
+    
+
+def check_entity(search_input) -> bool:
+    """Takes in a search input and checks if it contains any entities"""
+    doc = nlp(search_input)
+    if len(doc.ents) > 0:
+        return doc
+    else:
+        return False
+
+def get_cosine_sim(input_text: str, texts: List[str]) -> pd.DataFrame:
+    """Calculate the cosine similarity of the input text against a list of texts
+    Takes in:
+    - input_text: a string
+    - texts: a list of strings
+    Returns a dataframe with two columns: Sentence Text and Cosine Similarity Score
+    """
+    input_text_cleaned = list_text_cleaner([input_text], remove_stopwords=True)[0]
+    cleaned_texts = list_text_cleaner(texts, remove_stopwords=True)
+    all_texts = [input_text_cleaned] + cleaned_texts
+    vectors = get_vectors(*all_texts)
+    sim_matrix = cosine_similarity(vectors)
+    # Get the similarity scores of the input_text against all other texts
+    sim_scores = sim_matrix[0, 1:]
+    data = {'OFFER': texts, 'Cosine Similarity Score': sim_scores}
+    df = pd.DataFrame(data)
+    df = df.sort_values(by='Cosine Similarity Score', ascending=False).reset_index(drop=True)
+    return df
+
+def get_vectors(*strs: str) -> np.ndarray:
+    text = list(strs)
+    vectorizer = CountVectorizer()
+    vectorizer.fit(text)
+    return vectorizer.transform(text).toarray()
+
+def jaccard_similarity(s1: List[str], s2: List[str]) -> float:
+    """Takes in two lists and returns the Jaccard similarity score (3 digits)"""
+    intersection = set(s1).intersection(set(s2))
+    n = len(intersection)
+    score = round(n / (len(s1) + len(s2) - n), 3)
+    return score
+
+def get_jaccard_sim(input_text: str, texts: List[str]) -> pd.DataFrame:
+    """Calculate the Jaccard similarity of the input text against a list of texts
+    Takes in:
+    - input_text: a string
+    - texts: a list of strings
+    Returns a dataframe with two columns: Sentence Text and Jaccard Similarity Score
+    """
+    cleaned_input_text = list_text_cleaner([input_text], remove_stopwords=True)[0].split()
+    cleaned_texts = list_text_cleaner(texts, remove_stopwords=True)
+    
+    jaccard_scores = [jaccard_similarity(cleaned_input_text, text.split()) for text in cleaned_texts]
+    
+    data = {'OFFER': texts, 'Jaccard Similarity Score': jaccard_scores}
+    df = pd.DataFrame(data)
+    # sort based on the similarity score
+    df = df.sort_values(by='Jaccard Similarity Score', ascending=False).reset_index(drop=True)
+    return df
+
+def find_column(df: pd.DataFrame, keyword: str) -> str:
+    """Function to find the first column containing a specific keyword. Note that we assume there will only be one score at most for a similarity score dataframe"""
+    cols = [col for col in df.columns if keyword.lower() in col.lower()]
+    return cols[0] if cols else None
+
+def extract_similar_offers(data: pd.DataFrame, threshold: float = 0.0) -> pd.DataFrame:
+    """Takes in the results from get_cosine_sim() and get_jaccard_sim(); returns a dataframe of similar offers with scores > threshold"""
+    score = find_column(data, 'score')
+    similar_offers = data[data[score] >= threshold]
+    similar_offers[score] = similar_offers[score].apply(lambda x: round(x, 3)) # round to 3 digits
+    return similar_offers
+
+def category_to_brand(category: str, offered_brands: List, brand_belong_category_dict: Dict) -> List[str]:
+    """Use case: when a user searches for a category, we return a list of brands in that category"""
+    # checks if the category is in the dictionary keys
+    if category.upper() in brand_belong_category_dict.keys():
+        search_brands = brand_belong_category_dict[category.upper()] # becase all keys are in upper case
+        result = list(set(search_brands) & set(offered_brands))
+        print(f"Function category_to_brand | Found {category} in offered brand") 
+        return result 
+    else:
+        print(f"Function category_to_brand | No offered brand is found in {category}")
+        return None
+
+class CatchErros(Exception):
+    class ParamsInputError(Exception):
+        pass
+    class SearchFailedError(Exception):
+        pass
+    class UnknownError(Exception):
+        pass
+
+
+def offer_finder_by_category(search_input: str, search_category_tuple: Tuple, category_dict: Dict, offered_brands: List, 
+                             brand_belong_category_dict: Dict, score: str, threshold: float = 0.0) -> pd.DataFrame:
+    """Find offers based on a category identified from search input.
+    Args:
+    - search_input: a string
+    - search_category_tuple: a tuple of (upper_category, product_category)
+    - category_dict: a dictionary of categories. Keys are upper categories and values are lists of product categories
+    - offered_brands:  a dataframe of offers (OFFER, BRAND, RETAILER) that are avaialble in our database
+    - brand_belong_category_dict: a dictionary of brands and the categories they belong to
+    - score: a string of either 'cosine' or 'jaccard'
+    - threshold: a float between 0 and 1
+
+    Returns a dataframe of similar offers, ordered by highest score
+    """
+    # we assume people just search one category at a time
+    # search_category_tuple = find_category(search_input, category_dict)
+    product_category, upper_category = search_category_tuple[1], search_category_tuple[0] # ('Alcohol', 'beer')
+    print(f'Function offer_finder_by_category | Found items:\n- Search input: {search_input}\n- Product category: {product_category}\n- Upper category: {upper_category}')
+    potential_brands = category_to_brand(product_category, offered_brands, brand_belong_category_dict)
+    if potential_brands is not None:
+        potential_offers = offers[offers['BRAND'].isin(potential_brands)]['OFFER'].tolist()
+        if score == 'cosine':
+            cos_sim_score = get_cosine_sim(search_input, potential_offers)
+            output = extract_similar_offers(cos_sim_score, threshold)
+        elif score == 'jaccard':
+            jaccard_sim_score = get_jaccard_sim(search_input, potential_offers)
+            output = extract_similar_offers(jaccard_sim_score, threshold)
+        elif score not in ['cosine', 'jaccard']:
+            raise ValueError(f'Please enter a valid score: cosine or jaccard; Not {score}')
+        else: # this means something else is worng
+            raise UnknownError(f'Something must be broken. Please try again.')
+        return output
+    else:
+        potential_product_categories = category_dict[upper_category]
+        msg = f'{product_category} is not found. Do you wanna take a look at these similar offers in {upper_category}?\n We have: {potential_product_categories}' # we can still calculate similarity but this is computationally expensive
+        print(msg)
+        return None
+
+def offer_finder_by_entity(search_input: str, entities: Tuple, offers_data: pd.DataFrame, score: str, threshold: float=0.0) -> pd.DataFrame:
+    """Find offers based on entities identified from search input.
+    Args:
+    - search_input: a string
+    - entities: a tuple of entities
+    - offers_data: a dataframe of offers (OFFER, BRAND, RETAILER) that are avaialble in our database
+    - score: a string of either 'cosine' or 'jaccard'
+    - threshold: a float between 0 and 1
+
+    Returns a dataframe of similar offers, ordered by highest score
+    """
+    collects = [] # collect all the results if there are more than one entity
+    for ent in entities:
+        ent_name, ent_label = ent.text, ent.label_
+        print(f'Function offer_finder_by_entity | Found entity: {ent_name} with label: {ent_label}')
+        # filter offers by entity
+        df_tmp = offers_data[offers_data[ent_label.upper()] == ent_name.upper()]
+        if df_tmp.shape[0] > 0:
+            print(f'Function offer_finder_by_entity | Found {df_tmp.shape[0]} offer(s) for the brand/retailer: {ent_name}')
+            potential_offers = df_tmp['OFFER'].drop_duplicates().tolist()
+            if score == 'cosine':
+                cos_sim_score = get_cosine_sim(search_input, potential_offers)
+                output = extract_similar_offers(cos_sim_score, threshold)
+            elif score == 'jaccard':
+                jaccard_sim_score = get_jaccard_sim(search_input, potential_offers)
+                output = extract_similar_offers(jaccard_sim_score, threshold)
+            elif score not in ['cosine', 'jaccard']:
+                raise ValueError(f'Please enter a valid score: cosine or jaccard; Not {score}')
+            else: # this means something else is worng
+                raise UnknownError(f'Something must be broken. Please try again.')
+            collects.append(output)
+        else:
+            print(f'Function offer_finder_by_entity | No offer is found for the brand/retailer: {ent_name}')
+
+    if len(collects) > 0:
+        final_output = pd.concat(collects, ignore_index=True)# they should be using the same similarity score
+        score = find_column(collects[0], 'score') 
+        final_output = final_output.sort_values(by=score, ascending=False).reset_index(drop=True) # sort final_output by score
+        return final_output
+    elif len(collects) == 1:
+        return collects[0]
+    else:
+        print('###'*5 + 'FINAL SEARCH RESULTS' + '###'*5)
+        print('Function offer_finder_by_entity | No offer is found for any of the entities.')
+        return None
+
+
+def search_offers(search_input: str, offers: pd.DataFrame, category_dict: Dict, brand_belong_category_dict: Dict, score: str, score_threshold: float = 0.0):
+    """Main function. Takes in a serach_input and decide whether it can find entities or not. Then excecute the appropriate functions
+    Inputs:
+    - search_input: a string that a user enters
+    - offers: a dataframe of offers (OFFER, BRAND, RETAILER) that are avaialble in our database
+    - category_dict: a dictionary of categories. Keys are upper categories and values are lists of product categories
+    - brand_belong_category_dict: a dictionary of brands and the categories they belong to
+    - score: a string of either 'cosine' or 'jaccard'
+    - score_threshold: a float between 0 and 1
+
+    Returns a dataframe of similar offers, ordered by highest score
+    """
+    print(f'Function main | Search input: {search_input}')
+    check_ent = check_entity(search_input)
+    if not check_entity(search_input): # no entities found
+       # check category
+       cat_check = find_category(search_input, category_dict)
+       if cat_check is None:
+           raise SearchFailedError('No brand/retailer/category is found. Please try again.')
+       else:
+            # we assume people just search one category at a time
+            cat_tuple = cat_check # ('Alcohol', 'beer')
+            search_results = offer_finder_by_category(search_input, cat_tuple, category_dict, offers, brand_belong_category_dict, score, score_threshold)
+            return search_results
+    else:
+        entities = check_ent.ents # entities will be a tuple anyways
+        print(f'Found {len(entities)} entity object(s) in the search input.')
+        search_results = offer_finder_by_entity(search_input, entities, offers, score, score_threshold)
+        return search_results
+