Update README.md

README.md

@@ -1,3 +1,177 @@
----
-license: cc-by-sa-4.0
----
+---
+license: cc-by-sa-4.0
+---
+
+# Dataset Card for SoccerWiki
+
+<!-- Provide a quick summary of the dataset. -->
+
+SoccerWiki is a large-scale multimodal soccer knowledge base, integrating rich domain knowledge about players, teams, referees, and venues to enable knowledge-driven reasoning.
+
+The dataset is built from [Wikipedia](https://www.wikipedia.org/) and [Flashscore](https://www.flashscore.com/). 
+
+It covers 9,471 players, 266 teams, 202 referees, and 235 venues. Each entity in the knowledge base includes the corresponding image and detailed attributes.
+
+
+## Dataset Details
+
+### Dataset Description
+
+<!-- Provide a longer summary of what this dataset is. -->
+
+- **Curated by:** [More Information Needed]
+- **Funded by [optional]:** [More Information Needed]
+- **Shared by [optional]:** [More Information Needed]
+- **Language(s) (NLP):** English
+
+### Licensing Information
+
+The data used in this project is sourced from Wikipedia https://www.wikipedia.org/ and Flashscore https://www.flashscore.com/. Please note the following:
+
+* **Wikipedia**: The content from Wikipedia is licensed under the [Creative Commons Attribution-Share-Alike License 4.0 (CC BY-SA 4.0)](https://creativecommons.org/licenses/by-sa/4.0/deed.en). You are free to use, share, and adapt the content, provided that you attribute the source and share any derivative works under the same license.
+
+* **Flashscore**: The data from Flashscore is used under their [Terms of Service](https://www.flashscore.com/terms/). Please refer to the specific terms provided by Flashscore for details on how the data may be used, including any restrictions or attribution requirements.
+
+Ensure that you follow the licensing conditions of these sources when using or distributing this dataset.
+
+
+### Dataset Sources
+
+<!-- Provide the basic links for the dataset. -->
+
+- **Repository:** [github](https://github.com/jyrao/SoccerAgent)
+- **Paper:** [arxiv](https://arxiv.org/abs/2505.03735)
+
+
+## Dataset Structure
+
+<!-- This section provides a description of the dataset fields, and additional information about the dataset structure such as criteria used to create the splits, relationships between data points, etc. -->
+
+``````
+└─ SoccerWiki
+     ├─ data
+     │   ├─ player
+     │   │   ├─ player1.json
+     │   │   ├─ player2.json
+     │   │   └─ ...
+     │   ├─ referee
+     │   ├─ team
+     │   └─ venue
+     └─ pic
+         ├─ player
+         │   ├─ player1
+         │   │   ├─ pic1.png
+         │   │   ├─ pic2.png
+         │   │   └─ ...
+         │   ├─ player2
+         │   │   ├─ pic1.png
+         │   │   ├─ pic2.png
+         │   │   └─ ...
+         │   └─ ...
+         ├─ referee
+         ├─ team
+         └─ venue
+
+``````
+
+Here is an example of the text data for a player:
+
+```json
+{
+    "FULL_NAME": "Aaron Hunt",
+    "UNICODE": "lls9wmxs",
+    "PLAYER_URL": "https://wikipedia.org/wiki/Aaron_Hunt",
+    "PLAYER_IMAGE_URL": "https://upload.wikimedia.org/wikipedia/commons/thumb/1/19/Aaron_Hunt_2018.jpg/150px-Aaron_Hunt_2018.jpg",
+    "INFOBOX": {
+        "Youth career": {
+            "1993–1997": "VfLOker",
+            ...
+        },
+        "Senior career*": {
+            "Total": "    413    (82)",
+            "2003–2007": "WerderBremenII    37    (9)",
+            ...
+        },
+        "International career": {
+            "2002": "GermanyU16    4    (1)",
+            ...
+        },
+        "Personal information": {
+            "Height": "1.83 m(6 ft0 in)[1]",
+            "Position(s)": "Attackingmidfielder",
+            "Date of birth": "(1986-09-04)4September1986(age 37)[1]",
+            "Place of birth": "Goslar,WestGermany[1]"
+        }
+    },
+    "CONTENT": {
+        "Honours": "Werder BremenDFB-Pokal: 2008–09 ...",
+        "References": {},
+        "Club career": "Hunt was born in Goslar, Lower Saxony. After spending his first season at Werder Bremen in the reserves the year the first team achieved the double, he ...",
+        "External links": "Aaron Hunt at WorldFootball.netAaron Hunt at kicker (in German)",
+        "Career statistics": {},
+        "International career": "Having a German father and an English mother, Hunt was eligible to play for both Germany or England..."
+    },
+    "IMAGES": [
+        "https://upload.wikimedia.org/wikipedia/commons/1/19/Aaron_Hunt_2018.jpg",
+        "https://upload.wikimedia.org/wikipedia/en/8/8a/OOjs_UI_icon_edit-ltr-progressive.svg"
+    ],
+    "SUMMARY": "Aaron Hunt is a German former professional footballer who ..."
+}
+```
+
+## Dataset Creation
+
+### Curation Rationale
+
+<!-- Motivation for the creation of this dataset. -->
+
+[More Information Needed]
+
+### Source Data
+
+<!-- This section describes the source data (e.g. news text and headlines, social media posts, translated sentences, ...). -->
+
+#### Data Collection and Processing
+
+<!-- This section describes the data collection and processing process such as data selection criteria, filtering and normalization methods, tools and libraries used, etc. -->
+
+[More Information Needed]
+
+#### Who are the source data producers?
+
+<!-- This section describes the people or systems who originally created the data. It should also include self-reported demographic or identity information for the source data creators if this information is available. -->
+
+[More Information Needed]
+
+#### Personal and Sensitive Information
+
+<!-- State whether the dataset contains data that might be considered personal, sensitive, or private (e.g., data that reveals addresses, uniquely identifiable names or aliases, racial or ethnic origins, sexual orientations, religious beliefs, political opinions, financial or health data, etc.). If efforts were made to anonymize the data, describe the anonymization process. -->
+
+[More Information Needed]
+
+## Bias, Risks, and Limitations
+
+<!-- This section is meant to convey both technical and sociotechnical limitations. -->
+
+[More Information Needed]
+
+### Recommendations
+
+<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
+
+Users should be made aware of the risks, biases and limitations of the dataset. More information needed for further recommendations.
+
+## Citation 
+
+<!-- If there is a paper or blog post introducing the dataset, the APA and Bibtex information for that should go in this section. -->
+
+        @article{rao2025soccceragent,
+            title={Multi-Agent System for Comprehensive Soccer Understanding},
+            author={Rao, Jiayuan and Li, Zifeng and Wu, Haoning and Zhang, Ya and Wang, Yanfeng and Xie, Weidi},
+            journal={arXiv preprint arXiv:2505.03735},
+            year={2025}
+        }
+
+## Dataset Card Contact
+
+If you have any questions, please feel free to contact jy_rao@sjtu.edu.cn or zifengli@sjtu.edu.cn.