feat: Add dataset

README.md

@@ -0,0 +1,112 @@
+---
+annotations_creators: []
+language_creators:
+- other
+languages:
+- en
+licenses:
+- cc-by-sa-3.0
+- cc-by-nc-2.5
+multilinguality:
+- monolingual
+pretty_name: XKCD
+size_categories:
+- 1K<n<10K
+source_datasets: []
+task_categories:
+- image-to-text
+- feature-extraction
+task_ids: []
+---
+
+# Dataset Card for "XKCD"
+
+## Table of Contents
+- [Table of Contents](#table-of-contents)
+- [Dataset Description](#dataset-description)
+  - [Dataset Summary](#dataset-summary)
+- [Dataset Structure](#dataset-structure)
+  - [Data Instances](#data-instances)
+  - [Data Fields](#data-fields)
+- [Dataset Creation](#dataset-creation)
+- [Considerations for Using the Data](#considerations-for-using-the-data)
+- [Additional Information](#additional-information)
+  - [Licensing Information](#licensing-information)
+  - [Contributions](#contributions)
+
+## Dataset Description
+
+- **Homepage:** [https://xkcd.com/](https://xkcd.com/), [https://www.explainxkcd.com](https://www.explainxkcd.com)
+- **Repository:** [Hugging Face repository](https://huggingface.co/datasets/olivierdehaene/xkcd/tree/main)
+
+### Dataset Summary
+
+XKCD is an export of all XKCD comics with their transcript and explanation scrapped from 
+[https://explainxkcd.com](https://explainxkcd.com).
+
+## Dataset Structure
+
+### Data Instances
+
+- `id`: `1`
+- `title`: `Barrel - Part 1`
+- `image_title`: `Barrel - Part 1`
+- `url`: `https://www.xkcd.com/1`
+- `image_url`: `https://imgs.xkcd.com/comics/barrel_cropped_(1).jpg`
+- `explained_url`: `https://www.explainxkcd.com/wiki/index.php/1:_Barrel_-_Part_1`
+- `transcript`: `[A boy sits in a barrel which is floating in an ocean.] Boy: i wonder where i'll float next?
+[A smaller frame with a zoom out of the boy in the barrel seen from afar. The barrel drifts into the distance. Nothing 
+else can be seen.]`
+- `explanation`: `The comic shows a young boy floating in a barrel in an ocean that doesn't have a visible end. It 
+comments on the unlikely optimism and perhaps naïveté people sometimes display. The boy is completely lost and seems 
+hopelessly alone, without any plan or control of the situation. Yet, rather than afraid or worried, he is instead 
+quietly curious: "I wonder where I'll float next?" Although not necessarily the situation in this comic, this is a 
+behavior people often exhibit when there is nothing they can do about a problematic situation for a long time; they may 
+have given up hope or developed a cavalier attitude as a coping mechanism. The title text expands on the philosophical 
+content, with the boy representing the average human being: wandering through life with no real plan, quietly 
+optimistic, always opportunistic and clueless as to what the future may hold. The isolation of the boy may also 
+represent the way in which we often feel lost through life, never knowing quite where we are, believing that there is 
+no one to whom to turn. This comic could also reflect on Randall's feelings towards creating xkcd in the first place; 
+unsure of what direction the web comic would turn towards, but hopeful that it would eventually become the popular web 
+comic that we know today. This is the first in a six-part series of comics whose parts were randomly published during 
+the first several dozen strips. The series features a character that is not consistent with what would quickly become 
+the xkcd stick figure style. The character is in a barrel. In 1110: Click and Drag there is a reference to this comic 
+at 1 North, 48 East . After Randall released the full The Boy and his Barrel story on xkcd, it has been clear that the 
+original Ferret story should also be included as part of the barrel series. The full series can be found here . They 
+are listed below in the order Randall chose for the short story above: `
+
+### Data Fields
+
+- `id`
+- `title`
+- `url`: xkcd.com URL
+- `image_url`
+- `explained_url`: explainxkcd.com URL
+- `transcript`: english text transcript of the comic
+- `explanation`: english explanation of the comic
+
+## Dataset Creation
+
+The dataset was scrapped from both explainxkcd.com and xkcd.com.
+The dataset is therefore licensed under the Creative Commons Attribution-ShareAlike 3.0 license for
+the `transcript` and `explanation` fields, while the image itself is licensed under the
+Creative Commons Attribution-NonCommercial 2.5 license.
+
+See the [Copyrights](https://www.explainxkcd.com/wiki/index.php/explain_xkcd:Copyrights) page from 
+explainxkcd.com for more explanations.
+
+## Considerations for Using the Data
+
+As the data was scrapped, it is entirely possible that some fields are missing part of the original data.
+
+## Additional Information
+
+### Licensing Information
+
+The dataset is licensed under the Creative Commons Attribution-ShareAlike 3.0 license for
+the `transcript` and `explanation` fields, while the images are licensed under the
+Creative Commons Attribution-NonCommercial 2.5 license.
+
+### Contributions
+
+Thanks to [@OlivierDehaene](https://github.com/OlivierDehaene) for adding this dataset.

dataset.jsonl

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

requirements.txt

@@ -0,0 +1,4 @@
+aiolimiter==1.0.0
+aiohttp==3.8.1
+beautifulsoup4==4.11.1
+pandas==1.4.2

scrapper.py

@@ -0,0 +1,204 @@
+import aiohttp
+import asyncio
+import re
+
+import pandas as pd
+
+from pathlib import Path
+from aiolimiter import AsyncLimiter
+from typing import Dict, List
+from bs4 import BeautifulSoup
+from bs4.element import Tag
+
+LIST_COMICS_500_URL = (
+    "https://www.explainxkcd.com/wiki/index.php/List_of_all_comics_(1-500)"
+)
+LIST_COMICS_FULL_URL = (
+    "https://www.explainxkcd.com/wiki/index.php/List_of_all_comics_(full)"
+)
+
+
+def walk_tag(initial_tag: Tag, end_tag_name: str) -> str:
+    """
+    Walk the HTML tree and aggregates all text between an
+    initial tag and an end tag.
+
+    Parameters
+    ----------
+    initial_tag: BeautifulSoup
+    end_tag_name: str
+
+    Returns
+    -------
+    aggregated_text: str
+    """
+    result = []
+    current_tag = initial_tag
+
+    # Walk the HTML
+    while True:
+        if current_tag.name in ["p", "dl"]:
+            result.append(current_tag.get_text(separator=" ", strip=True))
+        elif current_tag.name == end_tag_name:
+            # We reached the end tag, break
+            break
+        current_tag = current_tag.next_sibling
+    return "\n".join(result)
+
+
+async def parse_url_html(
+    session: aiohttp.ClientSession, url: str, throttler: AsyncLimiter
+) -> BeautifulSoup:
+    """
+    Parse the HTML content of a given URL.
+    The request is sent asynchronously and using a provided request throttler.
+    If the request fails, we retry up to 5 times.
+
+    Parameters
+    ----------
+    session: aiohttp.ClientSession
+    url: str
+    throttler: AsyncLimiter
+
+    Returns
+    -------
+    BeautifulSoup
+    """
+    for _ in range(5):
+        try:
+            # prevent issues with rate limiters
+            async with throttler:
+                async with session.get(url, raise_for_status=True) as resp:
+                    html = await resp.text()
+            return BeautifulSoup(html, "html.parser")
+        # request failed
+        except aiohttp.ClientError:
+            continue
+
+
+async def scrap_comic(
+    session: aiohttp.ClientSession, explained_url: str, throttler: AsyncLimiter
+) -> Dict[str, str]:
+    """
+    Try to scrap all information for a given XKCD comic using its `explainxkcd.com` URL
+
+    Parameters
+    ----------
+    session: aiohttp.ClientSession
+    explained_url: str
+    throttler: AsyncLimiter
+
+    Returns
+    -------
+    Dict[str, str]
+    """
+    soup = await parse_url_html(session, explained_url, throttler)
+
+    # Parse id and title
+    title_splits = soup.find("h1").text.split(":")
+    if len(title_splits) > 1:
+        id = title_splits[0]
+        title = "".join(title_splits[1:]).strip()
+    else:
+        id = None
+        title = "".join(title_splits).strip()
+
+    # Parse explanation
+    explanation_soup = soup.find("span", {"id": "Explanation"})
+    try:
+        explanation = walk_tag(explanation_soup.parent, "span")
+    except:
+        explanation = None
+
+    # Parse transcript
+    transcript_soup = soup.find("span", {"id": "Transcript"})
+    try:
+        transcript = walk_tag(transcript_soup.parent, "span")
+    except:
+        transcript = None
+
+    xkcd_url = f"https://www.xkcd.com/{id}"
+    xkcd_soup = await parse_url_html(session, xkcd_url, throttler)
+
+    # Parse image title
+    try:
+        image = xkcd_soup.find("div", {"id": "comic"}).img
+        if title in image:
+            image_title = image["title"]
+        else:
+            image_title = image["alt"]
+    except:
+        image_title = None
+
+    # Parse image url
+    try:
+        image_url = xkcd_soup.find(text=re.compile("https://imgs.xkcd.com"))
+    except:
+        image_url = None
+
+    return dict(
+        id=id,
+        title=title,
+        image_title=image_title,
+        url=xkcd_url,
+        image_url=image_url,
+        explained_url=explained_url,
+        transcript=transcript,
+        explanation=explanation,
+    )
+
+
+async def scap_comic_urls(
+    session: aiohttp.ClientSession, comic_list_url: str
+) -> List[str]:
+    """
+    Scrap all XKCD comic URLs from the `explainxkcd.com` website.
+
+    Parameters
+    ----------
+    session: aiohttp.ClientSession
+    comic_list_url: str
+
+    Returns
+    -------
+    urls: List[str]
+    """
+    async with session.get(comic_list_url) as resp:
+        html = await resp.text()
+    soup = BeautifulSoup(html, "html.parser")
+
+    # Hack to easily find comics
+    create_spans = soup.find_all("span", {"class": "create"})
+    return [
+        "https://www.explainxkcd.com" + span.parent.a["href"] for span in create_spans
+    ]
+
+
+async def main():
+    """
+    Scrap XKCD dataset
+    """
+    # Throttle to 10 requests per second
+    throttler = AsyncLimiter(max_rate=10, time_period=1)
+    async with aiohttp.ClientSession() as session:
+        # Get all comic urls
+        comic_urls = await scap_comic_urls(
+            session, LIST_COMICS_500_URL
+        ) + await scap_comic_urls(session, LIST_COMICS_FULL_URL)
+
+        # Scrap all comics asynchronously
+        data = await asyncio.gather(
+            *[scrap_comic(session, url, throttler) for url in comic_urls]
+        )
+
+    df = (
+        pd.DataFrame.from_records(data)
+        .dropna(subset=["id"])
+        .astype({"id": "int32"})
+        .sort_values("id")
+    )
+    df.to_json(Path(__file__).parent / "dataset.jsonl", orient="records", lines=True)
+
+
+if __name__ == "__main__":
+    asyncio.run(main())