Update README.md

README.md

@@ -1,4 +1,16 @@
 ---
+language:
+- en
+multilinguality:
+- monolingual
+size_categories:
+- 1M<n<10M
+task_categories:
+- feature-extraction
+- sentence-similarity
+pretty_name: HotpotQA
+tags:
+- sentence-transformers
 dataset_info:
 - config_name: triplet
   features:
@@ -94,3 +106,70 @@ configs:
   - split: train
     path: triplet-all/train-*
 ---
+
+# Dataset Card for HotpotQA
+
+This is a reformatting of the HotpotQA dataset used to train the [BGE-M3 model](https://huggingface.co/BAAI/bge-m3). See the full BGE-M3 dataset in [Shitao/bge-m3-data](https://huggingface.co/datasets/Shitao/bge-m3-data).
+
+## Dataset Subsets
+
+### `triplet` subset
+
+* Columns: "anchor", "positive", "negative"
+* Column types: `str`, `str`, `str`
+* Examples:
+    ```python
+    {
+      'anchor': 'What country of origin does House of Cosbys and Bill Cosby have in common?',
+      'positive': 'House of Cosbys House of Cosbys is an American animated sitcom created by Justin Roiland for the film festival Channel 101. The series centers on Mitchell Reynolds (Jeff Davis), who builds a cloning machine to make duplicates of his favorite comedian, Bill Cosby. The show stars Davis, Roiland, and a rotating cast of performers, many of whom were participants at Channel 101. The series premiered January 30, 2005, and was the number one-rated program on the site for three months. Four episodes of the series were created, which debuted at Channel 101 screenings and were posted online thereafter. The series concluded on June 26, 2005 with an "unofficial" fifth installment.',
+      'negative': 'House of Blues House of Blues is a chain of live music concert halls and restaurants in major markets throughout the United States. House of Blues\' first location, in Cambridge, Massachusetts\' Harvard Square, was opened in 1992 by Isaac Tigrett, co-founder of Hard Rock Cafe, and Dan Aykroyd, co-star of the 1980 film "The Blues Brothers".'
+    }
+    ```
+* Collection strategy: Reading the jsonl file in the `HotpotQA` directory in [Shitao/bge-m3-data](https://huggingface.co/datasets/Shitao/bge-m3-data) and taking only the first postiive and negative.
+* Deduplified: No
+
+### `triplet-20` subset
+
+* Columns: "anchor", "positive", "negative_1", "negative_2", "negative_3", "negative_4", "negative_5", "negative_6", "negative_7", "negative_8", "negative_9", "negative_10", "negative_11", "negative_12", "negative_13", "negative_14", "negative_15", "negative_16", "negative_17", "negative_18", "negative_19", "negative_20"
+* Column types: `str`, `str`, `str`, `str`, `str`, `str`, `str`, `str`, `str`, `str`, `str`, `str`, `str`, `str`, `str`, `str`, `str`, `str`, `str`, `str`
+* Examples:
+    ```python
+    {
+      'anchor': 'What country of origin does House of Cosbys and Bill Cosby have in common?',
+      'positive': 'House of Cosbys House of Cosbys is an American animated sitcom created by Justin Roiland for the film festival Channel 101. The series centers on Mitchell Reynolds (Jeff Davis), who builds a cloning machine to make duplicates of his favorite comedian, Bill Cosby. The show stars Davis, Roiland, and a rotating cast of performers, many of whom were participants at Channel 101. The series premiered January 30, 2005, and was the number one-rated program on the site for three months. Four episodes of the series were created, which debuted at Channel 101 screenings and were posted online thereafter. The series concluded on June 26, 2005 with an "unofficial" fifth installment.',
+      'negative_1': 'House of Blues House of Blues is a chain of live music concert halls and restaurants in major markets throughout the United States. House of Blues\' first location, in Cambridge, Massachusetts\' Harvard Square, was opened in 1992 by Isaac Tigrett, co-founder of Hard Rock Cafe, and Dan Aykroyd, co-star of the 1980 film "The Blues Brothers".',
+      'negative_2': 'English Americans English Americans, also referred to as Anglo-Americans, are Americans whose ancestry originates wholly or partly in England, a country that is part of the United Kingdom of Great Britain and Northern Ireland.',
+      'negative_3': "Why Is There Air? Why Is There Air? (1965) is Bill Cosby's third album. It was recorded at the Flamingo Hotel in Las Vegas, Nevada. It won the 1966 Grammy Award for Best Comedy Album.", 'negative_4': 'Doug E. Doug Douglas Bourne, (born January 7, 1970) better known as Doug E. Doug, is an American actor, comedian, screenwriter, producer, and film director. He started his career at age 17 as a stand-up comedian. He is best known for his roles as Griffin Vesey on the CBS sitcom "Cosby", Sanka Coffie in the film "Cool Runnings" and as the voice of Bernie in the animated film "Shark Tale".',
+      'negative_5': "Halsey House (Southampton, New York) The Halsey House is a historic house converted into a museum, in Southampton, New York. It was first built around 1648 by Thomas Halsey, a pioneer from Hertfordshire, England. Thomas's grandfather was William Halsey. William had the famed English country house The Golden Parsonage bestowed upon him by Henry VIII in the 16th century. It is here that Thomas Halsey's father was born, as well as Thomas Halsey himself.", 'negative_6': 'Johnny Bush Johnny Bush (born February 17, 1935 as John Bush Shinn III in Houston, Texas) is a country music singer, songwriter, and drummer. Bush, nicknamed the "Country Caruso," is best known for his distinctive voice and as the writer of "Whiskey River," a top-ten hit for himself and Willie Nelson\'s signature song. He is still popular in his native Texas.',
+      'negative_7': 'Stu Gardner Stuart Gardner is an American musician and composer. He is known for his collaborations with Bill Cosby, and for co-writing "Kiss Me", the theme song of Cosby\'s sitcom "The Cosby Show".',
+      'negative_8': 'Corrie (surname) Corrie is a unisex surname in the English language. The name has several different etymological origins. The name is found in numbers in the north of Ireland. The surname has been borne by a noted Scottish family, that was originally seated in what is today the civil parish of Hutton and Corrie.',
+      'negative_9': 'Bushwick Bill Richard Stephen Shaw (born December 8, 1966), better known by the stage name Bushwick Bill, is a Jamaican-born American rapper. He is a member of the hip hop group Geto Boys.',
+      'negative_10': "William Messner-Loebs William Messner-Loebs ( ; born William Francis Loebs, Jr.; February 19, 1949) is an American comics artist and writer from Michigan, also known as Bill Loebs and Bill Messner-Loebs. His hyphenated surname is a combination of his and his wife Nadine's unmarried surnames.", 'negative_11': 'Sesame Street international co-productions "Sesame Street" international co-productions are educational children\'s television series based on the American "Sesame Street" but tailored to the countries in which they are produced. Shortly after the debut of "Sesame Street" in the United States in 1969, television producers, teachers, and officials of several countries approached the show\'s producers and the executives of Sesame Workshop (2000-present) about the possibility of airing international versions of "Sesame Street". Creator Joan Ganz Cooney hired former CBS executive Michael Dann to field offers to produce versions of the show in other countries.',
+      'negative_12': 'Bill Bryson William McGuire "Bill" Bryson {\'1\': ", \'2\': ", \'3\': ", \'4\': "} ( ; born December 8, 1951) is a best-selling Anglo-American author of books on travel, the English language, science, and other non-fiction topics. Born in the United States, he has been a resident of Britain for most of his adult life, returning to the United States between 1995 and 2003. He served as the chancellor of Durham University from 2005 to 2011.',
+      'negative_13': 'Graham Nash Graham William Nash, OBE (born 2 February 1942) is a British-American singer-songwriter and musician. Nash is known for his light tenor voice and for his songwriting contributions as a member of the English pop/rock group the Hollies and the folk-rock supergroup Crosby, Stills & Nash. Nash became an American citizen on 14 August 1978 and holds dual citizenship of the United Kingdom and United States.',
+      'negative_14': 'List of Tyler Perry\'s House of Payne episodes "Tyler Perry\'s House of Payne" is an American comedy-drama television series created and produced by playwright, director, and producer Tyler Perry. The show revolved around a multi-generational family living under one roof in Atlanta led by patriarch Curtis Payne and his wife Ella. The show premiered in syndication on June 21, 2006, and new episodes were broadcast exclusively on TBS from June 6, 2007, until August 10, 2012. While primarily a comedy sitcom, "House of Payne" was known for featuring dark themes and subject matter, such as substance abuse and addiction. It also had elements of slapstick. The storyline of the show is serialized, with many references to past episodes, creating a continuing story arc.',
+      'negative_15': 'Clair Huxtable Clair Olivia Huxtable (née Hanks) is a fictional character who appears in the American sitcom "The Cosby Show". Portrayed by actress Phylicia Rashad, Clair, the wife of Dr. Cliff Huxtable and mother of their five children, is the matriarch of the show\'s central Huxtable family. Working as a lawyer, Clair values the importance of maintaining a successful career while running a strong household. The character debuted alongside her family in "The Cosby Show"\'s pilot, "Theo\'s Economic Lesson", which premiered on September 20, 1984.',
+      'negative_16': 'Bad Boy Bill Bad Boy Bill (born William Renkosik) is a disc jockey (DJ) from Chicago, Illinois, U.S. who plays an assortment of house music.',
+      'negative_17': 'Bill Bunbury Bill Bunbury (born 7 October 1940, in Glastonbury, England) is a former radio broadcaster and producer for the Australian Broadcasting Corporation, and an accomplished historian and writer.',
+      'negative_18': 'Ranch-style house Ranch (also known as; American ranch, California ranch, rambler, or rancher) is a domestic architectural style originating in the United States. The ranch house is noted for its long, close-to-the-ground profile, and wide open layout. The house style fused modernist ideas and styles with notions of the American Western period of wide open spaces to create a very informal and casual living style. While the original style of the ranch was very informal and basic in design, starting around the early 1960s, many ranch homes constructed in the United States (particularly in the Sun Belt region) were increasingly built with more dramatic features like varying roof lines, cathedral ceilings, sunken living rooms, and extensive landscaping and grounds.',
+      'negative_19': '8:15 12:15 8:15 12:15 is the eighth comedy album by Bill Cosby. It was his first double-disc album. It was also his first record not released strictly by Warner Bros. Records label but by Tetragrammaton Records (which was co-owned by Cosby at the time) instead.',
+      'negative_20': 'The Parliaments The Parliaments were a doo-wop quintet from Plainfield, New Jersey, formed in the back room of a barbershop in the late 1950s and named after the cigarette brand. After some early personnel changes their lineup solidified with George Clinton, Ray Davis, Fuzzy Haskins, Calvin Simon, and Grady Thomas. Clinton was group leader and manager, and part owner of the barbershop where the group convened to entertain customers. The group later evolved into the funk bands Parliament and Funkadelic, which found success in the 1970s.'
+    }
+    ```
+* Collection strategy: Reading the jsonl file in the `HotpotQA` directory in [Shitao/bge-m3-data](https://huggingface.co/datasets/Shitao/bge-m3-data) and taking the first 20 negatives for each sample (note: the large majority of samples have 20 negatives, some had 21).
+* Deduplified: No
+
+### `triplet-all` subset
+
+* Columns: "anchor", "positive", "negative"
+* Column types: `str`, `str`, `str`
+* Examples:
+    ```python
+    {
+      'anchor': 'What country of origin does House of Cosbys and Bill Cosby have in common?',
+      'positive': 'House of Cosbys House of Cosbys is an American animated sitcom created by Justin Roiland for the film festival Channel 101. The series centers on Mitchell Reynolds (Jeff Davis), who builds a cloning machine to make duplicates of his favorite comedian, Bill Cosby. The show stars Davis, Roiland, and a rotating cast of performers, many of whom were participants at Channel 101. The series premiered January 30, 2005, and was the number one-rated program on the site for three months. Four episodes of the series were created, which debuted at Channel 101 screenings and were posted online thereafter. The series concluded on June 26, 2005 with an "unofficial" fifth installment.',
+      'negative': 'House of Blues House of Blues is a chain of live music concert halls and restaurants in major markets throughout the United States. House of Blues\' first location, in Cambridge, Massachusetts\' Harvard Square, was opened in 1992 by Isaac Tigrett, co-founder of Hard Rock Cafe, and Dan Aykroyd, co-star of the 1980 film "The Blues Brothers".'
+    }
+    ```
+* Collection strategy: Reading the jsonl file in the `HotpotQA` directory in [Shitao/bge-m3-data](https://huggingface.co/datasets/Shitao/bge-m3-data) and taking each positive and each negative, but making a separate triplet with all.
+* Deduplified: No