kurry commited on
Commit
940ff6d
·
verified ·
1 Parent(s): cf88a3b

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +90 -3
README.md CHANGED
@@ -1,3 +1,90 @@
1
- ---
2
- license: apache-2.0
3
- ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ ---
2
+ # HF Dataset Card metadata
3
+ pretty_name: "AMZN SEC Filings – Chunk-level Corpus (10-K, 10-Q, 8-K)"
4
+ license: mit
5
+ language:
6
+ - en
7
+ tags:
8
+ - finance
9
+ - sec-edgar
10
+ - chromadb
11
+ - retrieval
12
+ - embeddings
13
+ - amzn
14
+ task_categories:
15
+ - text-retrieval
16
+ - question-answering
17
+ size_categories:
18
+ - 100K<n<1M
19
+ source_datasets:
20
+ - external:sec-edgar # original raw source
21
+ ---
22
+ # AMZN SEC Filings – Chunk-level Corpus (10-K, 10-Q, 8-K)
23
+
24
+ <p align="center">
25
+ <img alt="Amazon logo" width="120" src="https://upload.wikimedia.org/wikipedia/commons/a/a9/Amazon_logo.svg">
26
+ </p>
27
+
28
+ A ready-to-use, **chunk-level** corpus of Amazon's (AMZN) recent SEC filings
29
+ (10-K, 10-Q, and 8-K).
30
+ Each paragraph *and* sentence is stored together with rich metadata,
31
+ making the dataset ideal for:
32
+
33
+ * semantic search / RAG pipelines (ChromaDB, FAISS, Weaviate, …)
34
+ * question-answering over financial filings
35
+ * experimenting with financial-domain embeddings
36
+
37
+ > Time span : last **5 fiscal years** (rolling window, as of 2025-05-11)
38
+ > Collection : 10-K, 10-Q, 8-K (including MD&A summaries & optional exhibits)
39
+ > Granularity: ~1000-char paragraphs **and** ≤80-token sentences
40
+
41
+ ---
42
+
43
+ ## Contents
44
+
45
+ 1. [Dataset structure](#dataset-structure)
46
+ 2. [Download & usage](#quick-start)
47
+ 3. [Creation process](#creation-process)
48
+ 4. [Intended use](#intended-use)
49
+ 5. [Limitations & ethical considerations](#limitations--ethical-considerations)
50
+ 6. [Citation](#citation)
51
+ 7. [License](#license)
52
+ 8. [Contact](#contact)
53
+
54
+ ---
55
+
56
+ ## Dataset structure
57
+
58
+ The data are stored in Arrow (the native format of 🤗 `datasets`)
59
+ so they can be accessed in-memory or streamed on-the-fly.
60
+
61
+ | Column | Type | Description |
62
+ |---------------|------|------------------------------------------------------------------------|
63
+ | `text` | str | Plain-text chunk (paragraph or sentence) |
64
+ | `metadata` | dict | All fields defined in `FilingMetadata` (ticker, cik, filing_type, …) |
65
+ | `id` | str | SHA-1 hash → unique, deterministic identifier |
66
+ | `chunk_type`* | str | Paragraph / sentence / summary / exhibit / press_release |
67
+
68
+ *`chunk_type` is embedded inside `metadata`.
69
+
70
+ Total size: **≈ 200-400 k chunks** (depends on new filings).
71
+
72
+ ### Example metadata object
73
+
74
+ ```json
75
+ {
76
+ "ticker": "AMZN",
77
+ "cik": "0001018724",
78
+ "company_name": "AMAZON.COM, INC.",
79
+ "filing_type": "10-K",
80
+ "filing_date": "2025-02-02",
81
+ "filing_period": "2024-12-31",
82
+ "filing_url": "https://www.sec.gov/Archives/...",
83
+ "section_id": "item7",
84
+ "section_title": "Management’s Discussion and Analysis",
85
+ "section_level": 1,
86
+ "chunk_index": 3,
87
+ "chunk_count": 42,
88
+ "chunk_type": "paragraph"
89
+ }
90
+ ```