Create README.md

README.md

@@ -0,0 +1,127 @@
+---
+language:
+- en
+pretty_name: Genshin Impact
+size_categories:
+- 10K<n<100K
+---
+
+# Genshin Impact
+
+<!-- Provide a quick summary of the dataset. -->
+A collection of dataset entries from Genshin Impact's official wiki (HoYoLab), containing information *I* think is important in relation to AI models and it learning the world of Genshin itself.
+
+**Data Extends From Genshin Impact 1.0 - 4.4**
+
+## Dataset Details
+
+### Dataset Description
+
+<!-- Provide a longer summary of what this dataset is. -->
+
+The Genshin Impact dataset is a collection of (what I think are) important concepts, terms, people, dialogue and such regarding the Open-World Anime Gacha game 'Genshin Impact' from miHoYo Co. Ltd. (CN)/HoYoverse (GLB). 
+This dataset incorporates all entries created on the Genshin Impact wiki from miHoYo's HoYoLab site.
+
+Sections included in the dataset are:
+- Affiliations
+- Artifacts
+- Books
+- Character Archive
+- Definitions
+- Enemies and Monsters
+- Nations
+- Teyvat's Resources
+- Wildlife
+
+**Curated by:** Bronya-Rand
+
+**Dataset Structure based on** [anthracite-org/Stheno-Data-Filtered](https://huggingface.co/datasets/anthracite-org/Stheno-Data-Filtered)
+
+**Parsed from:** [HoYoLab](https://wiki.hoyolab.com/pc/genshin/home)
+
+**Language(s) (NLP):** English
+
+## Uses
+
+<!-- Address questions around how the dataset is intended to be used. -->
+- Add additional knowledge to AI models about Genshin Impact and it's characters.
+- Append to existing model knowledge of the Genshin Impact universe.
+- Use a more primary source of Genshin Impact knowledge.
+
+### Out-of-Scope Use
+
+<!-- This section addresses misuse, malicious use, and uses that the dataset will not work well for. -->
+This dataset does not contain anything that is "fandom" such as shipping and only comes from the HoYoWiki itself. 
+Training on this dataset should not bring any misuse nor malicious use regarding the Genshin Impact universe, it's characters nor miHoYo Co. Ltd./HoYoverse in 'theory' from generating on AI models.
+However, any usage of this dataset should at least follow 'common sense' terminology like all other datasets.
+
+**Everything in this dataset is SFW**
+
+## 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. -->
+- "page_id" - The page ID from HoYoLab
+- "wiki" - The wiki in question. (Genshin Impact/Honkai: Star Rail)
+- "page_name" - The name of the page (typically the name of a character/enemy/item/etc.)
+- "component_name" - The internal structure section from HoYoLab the data came from
+- "conversations" - A processed (or generic) conversation regarding the contents of the component.
+> This section has a mix of knowledge (What is a Vision) and voice-over conversions to a conversation (User: About Amber? Eula: ...)
+
+## Dataset Creation
+
+### Curation Rationale
+
+<!-- Motivation for the creation of this dataset. -->
+As I have made bots for both Honkai: Star Rail and Genshin Impact and made a lorebook for both franchises, I was somewhat inspired to bring HSR and Genshin Impact knowledge 
+more than waiting on Meta, Mistral, etc. to catch up so, in a attempt to make a dataset for a model I was keen to help on, I created a parser and fetcher long ago that 
+grabbed all HoYoLab entries and finally parsed it with HTML cleaning, specific data analysis and such (the original JSONs are a mess for AI to read).
+
+### Source Data
+
+<!-- This section describes the source data (e.g. news text and headlines, social media posts, translated sentences, ...). -->
+The source data is a mix of information about Nations, Character Backstories, Voice-Overs and such in the form of a conversation between a user and a assistant or user with the character.
+
+#### 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. -->
+**Selection Process**
+1. Is the wiki section detrimental to knowing how the Genshin Impact universe works?
+> Stuff related to player content (Action Cards, Tutorial, etc.) wouldn't apply here.
+2. Is the data important for character knowledge?
+3. Is the data important to explain a specific thing in the game lore (say Enkanomiya).
+
+**Data Cleanup**
+Custom Python Script using BeautifulSoup and `html_sanitizer` cleaning.
+
+#### 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. -->
+miHoYo Co. Ltd/HoYoverse and HoYoLab Editors
+
+#### 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. -->
+No personal information nor sensitive information is in this dataset.
+
+## Bias, Risks, and Limitations
+
+<!-- This section is meant to convey both technical and sociotechnical limitations. -->
+This dataset should not bring bias, but may come with a risk of malicious use regarding taking AI responses as "real" or official to the game or a concern for too much 
+"immersion" if one is focused too much on a conversation between a Genshin Impact character in the Genshin Impact world. 
+
+### Recommendations
+
+<!-- This section is meant to convey recommendations with respect to the bias, risk, and technical limitations. -->
+With everything AI, treat everything with a grain of salt and use common sense. Do not try to pass over generations with this dataset as official miHoYo dialogue between
+you and a Genshin Impact character and whatnot. This is supposed to be a fun dataset for all who wants to have a more knowledgeable AI about Genshin Impact itself.
+
+## Glossary
+
+<!-- If relevant, include terms and calculations in this section that can help readers understand the dataset or dataset card. -->
+- Affiliations - A term in the game referring to certain groups or organizations in the game (ATM seems to just be Fontaine areas/groups)
+- Artifacts - A term referring to gear one can obtain in dungeons, chests, etc.
+- Character Archive - Character information for all playable Genshin Impact characters.
+- Teyvat's Resources - All items that can be in a player's inventory in Genshin Impact.
+
+## Dataset Card Contact
+@bronya_rand - Discord