Update README.md

README.md

@@ -53,7 +53,144 @@ configs:
     path: data/train-*
 ---
 
-# Material Contracts (Exhibit 10) from SEC 10-K, 8-K, and 10-Q filings from 1994 to 2024.
+# Material Contracts (Exhibit 10) from SEC
+
+## Table of Contents
+- [Dataset Card Creation Guide](#dataset-card-creation-guide)
+  - [Table of Contents](#table-of-contents)
+  - [Dataset Description](#dataset-description)
+    - [Dataset Summary](#dataset-summary)
+    - [Supported Tasks and Leaderboards](#supported-tasks-and-leaderboards)
+    - [Languages](#languages)
+  - [Dataset Structure](#dataset-structure)
+    - [Data Instances](#data-instances)
+    - [Data Fields](#data-fields)
+    - [Data Splits](#data-splits)
+  - [Dataset Creation](#dataset-creation)
+    - [Curation Rationale](#curation-rationale)
+    - [Source Data](#source-data)
+      - [Initial Data Collection and Normalization](#initial-data-collection-and-normalization)
+      - [Who are the source language producers?](#who-are-the-source-language-producers)
+    - [Annotations](#annotations)
+      - [Annotation process](#annotation-process)
+      - [Who are the annotators?](#who-are-the-annotators)
+    - [Personal and Sensitive Information](#personal-and-sensitive-information)
+  - [Considerations for Using the Data](#considerations-for-using-the-data)
+    - [Social Impact of Dataset](#social-impact-of-dataset)
+    - [Discussion of Biases](#discussion-of-biases)
+    - [Other Known Limitations](#other-known-limitations)
+  - [Additional Information](#additional-information)
+    - [Dataset Curators](#dataset-curators)
+    - [Licensing Information](#licensing-information)
+    - [Citation Information](#citation-information)
+    - [Contributions](#contributions)
+
+## Dataset Description
+
+- **Homepage:** NA
+- **Repository:** [Crawler](https://github.com/ChenghaoMou/edgar-crawler/tree/main)
+- **Paper:** NA
+- **Leaderboard:** NA
+- **Point of Contact:** mouchenghao at gmail dot com
+
+### Dataset Summary
+
+827437 material contracts (Exhibit 10) collected from sec.gov, specifically from 10-k, 10-Q, and 8-K, ranging from 1994 to Jan 2024. Exhibit 10 consists of a large collection of legal agreements and contracts. 
+
+### Supported Tasks and Leaderboards
+
+- `language-modeling` or `text-generation`: The dataset can be used to build language model in legal/finance domain.
+
+Currently, there is no leaderboard for this dataset.
+
+### Languages
+
+The primary language is US English with the rare instances of other languages.
+
+## Dataset Structure
+
+### Data Instances
+
+Please refer to the data viewer for examples.
+
+
+### Data Fields
+
+Please refer to the data viewer for examples.
+
+
+### Data Splits
+
+The dataset does not have a split by design. Everything is under train by convention.
+
+## Dataset Creation
+
+### Curation Rationale
+
+
+SEC EDGAR is a public available service from which one can query and access corporate filings. This collection of one specific exhibit files enables researchers to learn and model from contracts and agreements directly.
+
+
+### Source Data
+
+https://www.sec.gov/
+
+#### Initial Data Collection and Normalization
+
+
+The data is collected by year from all filings that are 10-K, 8-K, or 10-Q. Each exhibit is individually downloaded with all metadata information for maximum completeness. 
+
+
+#### Who are the source language producers?
+
+The Securities and Exchange Commission (SEC) requires public companies, certain company insiders, and broker-dealers to file periodic financial statements and other disclosures. Finance professionals and investors rely on SEC filings to make informed decisions when evaluating whether to invest in a company. SEC filings can be accessed for free at EDGAR, the commission's online database. 
+
+### Annotations
+
+NA
+
+#### Annotation process
+
+NA
+
+#### Who are the annotators?
+
+NA
+
+### Personal and Sensitive Information
+
+It might contain PII information (names, emails, job titles, companies) that are already public.
+
+## Considerations for Using the Data
+
+### Social Impact of Dataset
+
+This dataset could enable a better legal and finance language modeling capability.
+
+### Discussion of Biases
+
+Considering the source and language, it might produce overly US-centric legalese.
+
+### Other Known Limitations
+
+NA
+
+## Additional Information
+
+### Dataset Curators
+
+@chenghao
+
+### Licensing Information
+
+[Attribution-NonCommercial-ShareAlike 4.0 International](https://creativecommons.org/licenses/by-nc-sa/4.0/)
+
+### Citation Information
+
+NA
+
+### Contributions
+
+NA
 
-WIP. I started the crawling on Jan 14, 2024, and expect to finish in a month or two. I will upload the data in batches.