jakegrigsby commited on
Commit
484cdac
·
verified ·
1 Parent(s): 09289d0

Add README

Browse files
Files changed (1) hide show
  1. README.md +27 -0
README.md ADDED
@@ -0,0 +1,27 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ # Pokemon Showdown Replay Dataset
2
+
3
+ A collection of parsed Pokemon Showdown replays organized by format (gen1ou, gen2ou, etc.).
4
+
5
+ ## Structure
6
+
7
+ Each format is provided as a separate tar.gz file in the data/ directory:
8
+
9
+ - data/gen1ou.tar.gz - Generation 1 OU format replays
10
+ - data/gen2ou.tar.gz - Generation 2 OU format replays
11
+ ...etc.
12
+
13
+ ## Usage
14
+
15
+ To download and extract a specific format:
16
+
17
+ ```python
18
+ from huggingface_hub import hf_hub_download
19
+ import tarfile
20
+
21
+ # Download a specific format
22
+ file = hf_hub_download('jakegrigsby/pokemon-replays', 'data/gen1ou.tar.gz')
23
+
24
+ # Extract
25
+ with tarfile.open(file, 'r:gz') as tar:
26
+ tar.extractall()
27
+ ```