Updating README and adding tutorials.

README.md

@@ -1,3 +1,43 @@
----
-license: cdla-permissive-2.0
----
+# Spawning-15m
+
+![Spawning-15m](./assets/spawning-logo.png)
+
+# Summary
+**Spawning-15m** dataset is a collection of about 15 million CC0/PD image-caption pairs for the purpose of training generative image models.
+
+# About
+Training a state-of-the-art generative image model typically requires vast amounts of images from across the internet. Training with images from across the web introduces several data quality issues: the presence of copyright material, low quality images and captions, violent or nsfw content, PII, decaying dataset quality via broken links, etc. Additionally, downloading from the original image hosts introduces an undue burden to those hosts, impacting services for legitimate users. 
+
+The Spawning-15m dataset aims to resolve these issues through collecting only public domain and cc0 licensed images, automated recaptioning of image data, quality and safety filtering, and hosting the images in the dataset on dedicated cloud storage separate from the original image hosts. These innovations make Spawning-15m the largest safe and reliable public image dataset available.
+
+Built and curated with [Source.Plus](https://source.plus).
+
+# Overview
+This dataset has two components. The first is the `metadata`, which contains the image urls, captions, image dimensions, etc. The second component are the `images`.
+
+## Metadata
+The metadata is made available through a series of parquet files with the following schema:
+- `id`: A unique identifier for the image.
+- `url`: The URL of the image.
+- `s3_key`: The S3 file key of the image.
+- `caption`: A caption for the image.
+- `md5_hash`: The MD5 hash of the image file.
+- `mime_type`: The MIME type of the image file.
+- `width`: The width of the image in pixels.
+- `height`: The height of the image in pixels.
+- `license_type`: The URL of the license.
+
+## Images
+The image files are all hosted in the AWS S3 bucket `spawning-15m`. The URLs to the images files are all maintained in the metadata files.
+
+# Tutorials
+
+[Working with the Metadata](./tutorials/metadata.md)
+
+[Downloading Images](./tutorials/images.md)
+
+# License
+The dataset is licensed under the [CDLA-Permissive-2.0](https://cdla.dev/permissive-2-0/).
+
+# Reporting Issues
+We've gone through great lengths to ensure the dataset is free from objectionable and infringing content. If you find any issues or have any concerns, please report them to us at [[email protected]](mailto:[email protected]), along with the id of the relevant item.

tutorials/images.md

@@ -0,0 +1,29 @@
+# Downloading Images
+Once you have the URLs or S3 file keys from the metadata ([follow the steps here here]("./metadata.md")), you can download the images through any standard means.
+
+#### cURL
+Download an image from a url to a local image file with the name `image.png`:
+```bash
+curl -O image.png https://spawning-15m.s3.us-west-2.amazonaws.com/image.png
+```
+#### Python
+Download an image from a url to a local image file with the name `image.png`:
+```python
+import requests
+
+url = "https://spawning-15m.s3.us-west-2.amazonaws.com/image.png"
+response = requests.get(url)
+with open('image.png', 'wb') as f:
+    f.write(response.content)
+```
+#### img2dataset
+You can also use the `img2dataset` tool to quickly download images from a metadata file. The tool is available [here](https://github.com/rom1504/img2dataset).  The example below will download all the images to a local `images` directory.
+```bash
+img2dataset download --url_list spawning-15m-metadata.001.parquet --input_format parquet --url_col url --caption_col caption --output-dir images/
+```
+
+#### S3 CLI
+Download an image from an S3 bucket to an image with the name `image.png`:
+```bash
+aws s3 cp s3://spawning-15m/image.png image.png
+```

tutorials/metadata.md

@@ -0,0 +1,30 @@
+# Working with the Metadata
+The metadata files are in parquet format, and contain the following attributes:
+- `id`: A unique identifier for the image.
+- `url`: The URL of the image.
+- `s3_key`: The S3 file key of the image.
+- `caption`: A caption for the image.
+- `md5_hash`: The MD5 hash of the image file.
+- `mime_type`: The MIME type of the image file.
+- `width`: The width of the image in pixels.
+- `height`: The height of the image in pixels.
+- `license_type`: The URL of the license.
+
+#### Open a metadata file
+The files are in parquet format, and can be opened with a tool like `pandas` in Python. 
+```python
+import pandas as pd
+df = pd.read_parquet('spawning-15m-metadata.001.parquet')
+```
+
+#### Get URLs from metadata 
+Once you have opened a maetadata file with pandas, you can get the URLs of the images with the following command:
+```python
+urls = df['url']
+```
+
+#### Get S3 File Keys from metadata 
+You can also get the S3 file keys, which can be used to download the images using the S3 CLI:
+```python
+s3_keys = df['s3_key']
+```