Upload README.md with huggingface_hub

README.md

@@ -1,38 +1,82 @@
 ---
-license: mit
+license: cc-by-sa-4.0
 task_categories:
-- table-to-text
 - table-question-answering
 language:
 - en
 tags:
 - finance
 - 10k
-- agent
+- edgar
 size_categories:
 - 1M<n<10M
+configs:
+- config_name: column_documentation
+  data_files:
+  - split: train
+    path: data/column_documentation/column_documentation.parquet
+- config_name: company_addresses
+  data_files:
+  - split: train
+    path: data/company_addresses/company_addresses.parquet
+- config_name: column_comments
+  data_files:
+  - split: train
+    path: data/column_comments/column_comments.parquet
+- config_name: sqlite_sequence
+  data_files:
+  - split: train
+    path: data/sqlite_sequence/sqlite_sequence.parquet
+- config_name: table_documentation
+  data_files:
+  - split: train
+    path: data/table_documentation/table_documentation.parquet
+- config_name: companies
+  data_files:
+  - split: train
+    path: data/companies/companies.parquet
+- config_name: filings
+  data_files:
+  - split: train
+    path: data/filings/filings.parquet
+- config_name: financial_facts
+  data_files:
+  - split: train
+    path: data/financial_facts/financial_facts.parquet
+- config_name: company_tickers
+  data_files:
+  - split: train
+    path: data/company_tickers/company_tickers.parquet
+- config_name: table_comments
+  data_files:
+  - split: train
+    path: data/table_comments/table_comments.parquet
 ---
 
-# DDR-Bench: 10-K Financial Data
+# DDRBench 10K Financial Database
 
-This dataset contains structured financial data extracted from SEC 10-K filings. Please see https://huggingface.co/spaces/thinkwee/DDR_Bench for details.
+This dataset contains the structured SQLite database tables used in the **DDRBench 10K** evaluation task, converted to Parquet format.
 
-## Data Structure
+## Structure
+The dataset is split into multiple configurations, each representing a table from the original database:
 
-- **`data/`**: Optimized Parquet files for preview and efficient loading. (Automatically loaded by `load_dataset`)
-- **`raw/10k_financial_data.db`**: The original SQLite database (~1.1GB) for Agent environment simulation.
+- **companies**: Master table of companies (CIK, Name, etc.).
+- **financial_facts**: The core financial data (5M+ rows).
+- **filings**: Metadata about SEC filings.
+- **company_addresses**: Address information.
+- **company_tickers**: Ticker symbol mappings.
+- **table/column_documentation**: Metadata and comments explaining the schema.
 
 ## Usage
 
-### Quick check for data
+To load a specific table:
 
 ```python
 from datasets import load_dataset
 
-# Load the financial facts table
-ds = load_dataset("thinkwee/DDRBench_10K", data_files="data/financial_facts.parquet")
-```
+# Load the 'companies' table
+ds_companies = load_dataset("thinkwee/DDRBench_10K", "companies")
 
-### Run DDR-Bench
-- Download the `raw/10k_financial_data.db` and fill this DB file path to https://github.com/thinkwee/DDR_Bench/blob/main/config.yaml
-- Follow the instructions on https://github.com/thinkwee/DDR_Bench/blob/main/README.md to start
+# Load the main financial facts
+ds_facts = load_dataset("thinkwee/DDRBench_10K", "financial_facts")
+```