Update README.md

README.md

@@ -11,7 +11,7 @@ configs:
 - config_name: default
   data_files:
   - split: train
-    path: "elliquiy-rp_2023-04.parquet"
+    path: "*.parquet"
 ---
 
 # Elliquiy roleplaying forum data
@@ -29,6 +29,38 @@ During the scraping procedure (occurred on April 2023) some information like tex
 
 Given the text formatting used by many users, complete and thorough conversion to Markdown seems very difficult without losing information in the process or causing other issues.
 
+# Basic usage
+
+The files need PyArrow installed from pip. FastParquet will not work properly due to the nested data structure (I might change this in the future if it's too much of an issue).
+
+```python
+import pandas
+
+# Load one dataframe
+df = pandas.read_parquet('elliquiy-rp_2023-04_train-00000-of-00005.parquet')
+
+# Load the shareGPT-like message group from one specific row into a standard Python list
+messages = list(df.iloc[2350].messages)
+
+```
+
+Showing thread metadata from one specific row after loading the data:
+
+```text
+In [2]: df.iloc[2350]
+Out[2]: 
+thread-id                                                        11897
+thread-title                           The League of Extraordinary ...
+category-id                                                         65
+category-name                             Noncon: Human-Freeform Solos
+participant-count                                                    3
+message-count                                                      242
+word-count-total                                                 35197
+word-count-median                                                136.0
+messages         {'from': 'OrdinaryName', 'from-alternative': 'User...
+Name: 2350, dtype: object
+```
+
 # Dataset field explanation
 ## Threads
 | Field | Explanation