AdhyanshVerma commited on
Commit
8232d17
Β·
verified Β·
1 Parent(s): e7c5666

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +9 -8
README.md CHANGED
@@ -29,7 +29,7 @@ pretty_name: osti
29
  | **Conference Papers** | 246,227 |
30
  | **With Full-Text Available** | 558,050 (100%) |
31
  | **Date Range** | 1943 – Present |
32
- | **Metadata Size** | ~228 MB (Parquet) |
33
  | **Estimated PDF Corpus** | ~80–150 GB |
34
  | **Source** | [OSTI.GOV API v1](https://www.osti.gov/api/v1/docs) |
35
 
@@ -44,7 +44,7 @@ This dataset was harvested using the **Lazy Pointer** architecture: metadata and
44
  β”‚ YOUR MACHINE (30GB RAM, 20GB Disk) β”‚
45
  β”‚ β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”‚
46
  β”‚ β”‚ Metadata Harvest │───▢│ SQLite / Parquet β”‚ β”‚
47
- β”‚ β”‚ (REST API) β”‚ β”‚ (228 MB) β”‚ β”‚
48
  β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β”‚
49
  β”‚ β”‚ β”‚
50
  β”‚ β–Ό β”‚
@@ -77,8 +77,8 @@ This dataset was harvested using the **Lazy Pointer** architecture: metadata and
77
 
78
  | File | Description | Size |
79
  |------|-------------|------|
80
- | `osti_metadata.parquet` | Core dataset with all metadata + lazy pointers | ~228 MB |
81
- | `osti_metadata.sqlite` | SQLite source (optional, for local querying) | ~350 MB |
82
 
83
  ---
84
 
@@ -95,7 +95,8 @@ This dataset was harvested using the **Lazy Pointer** architecture: metadata and
95
  "publication_date": "2002-09-01", # ISO-8601 date
96
  "subjects": '["energy", "building"]', # JSON list of keywords
97
  "fulltext_url": "https://www.osti.gov/servlets/purl/944980", # PDF URL
98
- "pdf_downloaded": 0 # 0 = not yet fetched, 1 = fetched
 
99
  }
100
  ```
101
 
@@ -117,7 +118,7 @@ This dataset was harvested using the **Lazy Pointer** architecture: metadata and
117
  ```python
118
  import pandas as pd
119
 
120
- df = pd.read_parquet("osti_metadata.parquet")
121
  print(f"Total records: {len(df)}")
122
 
123
  # Filter by subject
@@ -200,7 +201,7 @@ contract = df[df['abstract'].str.contains('DE-AC02', case=False, na=False)]
200
  1. **Reconnaissance** β€” Queried OSTI API to count records per `product_type` with `has_fulltext=true`
201
  2. **Metadata Harvest** β€” Streamed 558K records via REST API (500 records/page), parsed with `ijson`, stored in SQLite
202
  3. **Checkpointing** β€” Saved `last_page` after every API request to survive crashes
203
- 4. **Compression** β€” Converted SQLite to Parquet with Zstd compression (~35% smaller)
204
  5. **Upload** β€” Pushed Parquet to Hugging Face, freed local disk
205
 
206
  ### Rate Limiting
@@ -279,4 +280,4 @@ This is a living dataset. To contribute:
279
 
280
  ---
281
 
282
- *Built with 16GB RAM, 1TB disk, 12 v-cores, and 8TB of Hugging Face storage. No scraping β€” just polite API harvesting.* πŸš€
 
29
  | **Conference Papers** | 246,227 |
30
  | **With Full-Text Available** | 558,050 (100%) |
31
  | **Date Range** | 1943 – Present |
32
+ | **Metadata Size** | ~348 MB (Parquet) |
33
  | **Estimated PDF Corpus** | ~80–150 GB |
34
  | **Source** | [OSTI.GOV API v1](https://www.osti.gov/api/v1/docs) |
35
 
 
44
  β”‚ YOUR MACHINE (30GB RAM, 20GB Disk) β”‚
45
  β”‚ β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” β”‚
46
  β”‚ β”‚ Metadata Harvest │───▢│ SQLite / Parquet β”‚ β”‚
47
+ β”‚ β”‚ (REST API) β”‚ β”‚ (348 MB) β”‚ β”‚
48
  β”‚ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β”‚
49
  β”‚ β”‚ β”‚
50
  β”‚ β–Ό β”‚
 
77
 
78
  | File | Description | Size |
79
  |------|-------------|------|
80
+ | `osti_metadata.parquet` | Core dataset with all metadata + lazy pointers | ~348 MB |
81
+ | `osti_metadata.sqlite` | SQLite source (optional, for local querying) | ~1 GB |
82
 
83
  ---
84
 
 
95
  "publication_date": "2002-09-01", # ISO-8601 date
96
  "subjects": '["energy", "building"]', # JSON list of keywords
97
  "fulltext_url": "https://www.osti.gov/servlets/purl/944980", # PDF URL
98
+ "pdf_downloaded": 0, # 0 = not yet fetched, 1 = fetched
99
+ "harvested_at": "20260719_163215" # Harvest batch timestamp
100
  }
101
  ```
102
 
 
118
  ```python
119
  import pandas as pd
120
 
121
+ df = pd.read_parquet("osti/osti_metadata.parquet")
122
  print(f"Total records: {len(df)}")
123
 
124
  # Filter by subject
 
201
  1. **Reconnaissance** β€” Queried OSTI API to count records per `product_type` with `has_fulltext=true`
202
  2. **Metadata Harvest** β€” Streamed 558K records via REST API (500 records/page), parsed with `ijson`, stored in SQLite
203
  3. **Checkpointing** β€” Saved `last_page` after every API request to survive crashes
204
+ 4. **Compression** β€” Converted SQLite to Parquet with PyArrow row-group chunking to optimize memory
205
  5. **Upload** β€” Pushed Parquet to Hugging Face, freed local disk
206
 
207
  ### Rate Limiting
 
280
 
281
  ---
282
 
283
+ *Built with 16GB RAM, 1TB disk, 12 v-cores, and 8TB of Hugging Face storage. No scraping β€” just polite API harvesting.* πŸš€