Update README.md

README.md

@@ -15,3 +15,221 @@ configs:
   - split: train
     path: data/train-*
 ---
+
+# 2K Book Titles Dataset
+
+## Dataset Description
+
+This dataset contains 2,000 book titles from various genres and time periods, ranging from classic literature to contemporary works. The dataset is designed for natural language processing tasks involving book titles, such as text generation, classification, or recommendation systems.
+
+## Dataset Structure
+
+### Data Fields
+
+- `book_title` (string): The title of the book
+
+### Data Splits
+
+The dataset contains a single split with 2,000 examples:
+
+| Split | Examples |
+|-------|----------|
+| train | 2,000    |
+
+# Example Json Schema
+
+```json
+{
+  "title": "Book Schema",
+  "description": "A schema for a book, including its title, author, and other details.",
+  "type": "object",
+  "properties": {
+    "title": {
+      "description": "The title of the book.",
+      "type": "string"
+    },
+    "author": {
+      "description": "The author of the book.",
+      "type": "string"
+    },
+    "publication_year": {
+      "description": "The year the book was published.",
+      "type": "integer",
+      "minimum": 0
+    },
+    "isbn": {
+      "description": "The International Standard Book Number.",
+      "type": "string",
+      "pattern": "^(978|979)-\\d{1,5}-\\d{1,7}-\\d{1,6}-\\d$"
+    },
+    "genres": {
+      "description": "A list of genres for the book.",
+      "type": "array",
+      "items": {
+        "type": "string"
+      },
+      "minItems": 1,
+      "uniqueItems": true
+    },
+    "is_available": {
+      "description": "A boolean indicating if the book is currently available.",
+      "type": "boolean"
+    },
+    "language": {
+      "description": "The language the book is written in.",
+      "type": "string"
+    },
+    "page_count": {
+      "description": "The total number of pages in the book.",
+      "type": "integer",
+      "minimum": 1
+    }
+  },
+  "required": [
+    "title",
+    "author",
+    "publication_year",
+    "isbn"
+  ]
+}
+```
+
+more complex version
+```json
+{
+  "$schema": "http://json-schema.org/draft-07/schema#",
+  "$id": "https://example.com/schemas/complex-book.json",
+  "title": "Book Schema",
+  "description": "A comprehensive schema for a book, including detailed author information, publication history, and subject classifications.",
+  "type": "object",
+  "properties": {
+    "title": {
+      "description": "The primary title of the book.",
+      "type": "string",
+      "minLength": 1,
+      "maxLength": 255
+    },
+    "subtitle": {
+      "description": "The secondary title of the book, if applicable.",
+      "type": "string"
+    },
+    "authors": {
+      "description": "A list of authors, with detailed information for each.",
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "name": {
+            "type": "string",
+            "description": "The full name of the author."
+          },
+          "birth_year": {
+            "type": "integer",
+            "minimum": 0,
+            "maximum": 2025
+          },
+          "nationality": {
+            "type": "string"
+          }
+        },
+        "required": [
+          "name"
+        ]
+      },
+      "minItems": 1
+    },
+    "publication_info": {
+      "description": "Detailed information about the book's publication history.",
+      "type": "object",
+      "properties": {
+        "publisher": {
+          "type": "string",
+          "minLength": 1
+        },
+        "publication_date": {
+          "type": "string",
+          "format": "date",
+          "description": "The original publication date in YYYY-MM-DD format."
+        },
+        "edition": {
+          "type": "integer",
+          "minimum": 1
+        }
+      },
+      "required": [
+        "publisher",
+        "publication_date"
+      ]
+    },
+    "identifiers": {
+      "description": "Standard identifiers for the book.",
+      "type": "object",
+      "properties": {
+        "isbn_13": {
+          "type": "string",
+          "pattern": "^(978|979)-\\d{1,5}-\\d{1,7}-\\d{1,6}-\\d$",
+          "description": "The ISBN-13 of the book."
+        },
+        "isbn_10": {
+          "type": "string",
+          "pattern": "^\\d{1}-\\d{3}-\\d{5}-\\d$",
+          "description": "The ISBN-10 of the book."
+        }
+      },
+      "required": [
+        "isbn_13"
+      ]
+    },
+    "categories": {
+      "description": "A hierarchical classification of the book's subjects.",
+      "type": "array",
+      "items": {
+        "type": "object",
+        "properties": {
+          "main_category": {
+            "type": "string"
+          },
+          "sub_categories": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          }
+        },
+        "required": [
+          "main_category"
+        ]
+      }
+    },
+    "stock_info": {
+      "description": "Current stock and availability information.",
+      "type": "object",
+      "properties": {
+        "quantity_in_stock": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "on_sale": {
+          "type": "boolean",
+          "default": false
+        }
+      },
+      "required": [
+        "quantity_in_stock"
+      ]
+    },
+    "summary": {
+      "description": "A brief synopsis of the book's plot or content.",
+      "type": "string",
+      "minLength": 50,
+      "maxLength": 300
+    }
+  },
+  "required": [
+    "title",
+    "authors",
+    "publication_info",
+    "identifiers"
+  ]
+}
+```