Update README.md

README.md

@@ -1,4 +1,16 @@
 ---
+language:
+- en
+multilinguality:
+- monolingual
+size_categories:
+- 100K<n<1M
+task_categories:
+- feature-extraction
+- sentence-similarity
+pretty_name: xsum
+tags:
+- sentence-transformers
 dataset_info:
   config_name: pair
   features:
@@ -18,3 +30,24 @@ configs:
   - split: train
     path: pair/train-*
 ---
+
+# Dataset Card for xsum
+
+This dataset is a collection of pairs of news articles and their summaries. See [xsum](https://huggingface.co/datasets/EdinburghNLP/xsum) for additional information.
+This dataset can be used directly with Sentence Transformers to train embedding models.
+
+## Dataset Subsets
+
+### `pair` subset
+
+* Columns: "article", "summary"
+* Column types: `str`, `str`
+* Examples:
+    ```python
+    {
+      'article': 'Denny Solomona crossed for Castleford, but Wigan led at half-time against the run of play through Lewis Tierney\'s try and Matty Smith\'s penalty kick.\nGrant Millington\'s try put the visitors back in front, before John Bateman went over to restore Wigan\'s two-point lead.\nNick Gregson got his first senior try and Bateman crossed again late on as Warriors climbed to third in the table.\nHaving suffered their heaviest defeat in Super League since 2005 with a 62-0 loss to Wakefield in their previous fixture, Wigan started slowl advantage when Luke Gale was sent to the sin-bin for dissent with the scores level in the first half, but Bateman\'s return to the side after two games out sparked the comeback.\nShaun Wane\'s team also welcomed back Dom Crosby, who made his first Super League appearance of the season having recovered from a hip injury.\nSolomona moved clear as Super League\'s leading try-scorer with his 13th of the season, but Tigers were frustrated by improved Wigan defence in the second period as they suffered their fourth defeat in a row at the DW Stadium.\nWigan coach Shaun Wane:\n"I don\'t want to keep going on about it. But, if you knew what we had gone through this week, there\'s so much toughness showed in that game against a really good Cas team.\n"The admiration I have got for my players, the desire to grind out the win with the circumstances that nobody knows about is unbelievable.\n"There were quite a few good performances, they are a good team and are well coached who know how to defend.\n"We\'re not the biggest team, but I thought the way we defended was outstanding."\nCastleford coach Daryl Powell:\n"That last try gave the score a bit of an easier look than it was. It was tight all the way through.\n"We lacked a little bit of quality in our play. I thought we defended awesome, they came at us in the second half with a game plan that put us under pressure.\n"They made minimal errors and kicked well and we couldn\'t find a spark to get us out of yardage and into good field position.\n"They deserved to win the game, they had more ball than us in decent field position and we had to work really hard to keep them out and that drained our energy reserves."\nWigan: Sarginson; Tierney, Bateman, Gildart, Charnley; Gregson, Smith; Mossop, Powell, Clubb, Tomkins, Isa, Sutton.\nReplacements: Crosby, Tautai, Burke, Bretherton.\nCastleford: Hampshire; Monaghan, Minikin, Webster, Solomona; Holmes, Gale; Lynch, Milner, Jewitt, Holmes, McMeeken, Massey.\nReplacements: McShane, Millington, Maher, Cook.\nReferee: Phil Bentham.',
+      'summary': 'Wigan moved level on points with Super League leaders Warrington by coming from behind to beat Castleford.',
+    }
+    ```
+* Collection strategy: Reading the xsum dataset from [embedding-training-data](https://huggingface.co/datasets/sentence-transformers/embedding-training-data).
+* Deduplified: No