Upload README.md with huggingface_hub

README.md

@@ -15,60 +15,58 @@ configs:
   default: true
   data_files:
   - split: train
-    path: "parquet/paper_nodes.parquet"
+    path: "paper_nodes/*.parquet"
 - config_name: paper_category_edges
   default: false
   data_files:
   - split: train
-    path: "parquet/paper_category_edges.parquet"
+    path: "paper_category_edges/*.parquet"
 - config_name: paper_knn
   default: false
   data_files:
   - split: train
-    path: "parquet/paper_knn.parquet"
+    path: "paper_knn/*.parquet"
 - config_name: category_nodes
   default: false
   data_files:
   - split: train
-    path: "parquet/category_nodes.parquet"
+    path: "category_nodes/*.parquet"
 - config_name: category_knn
   default: false
   data_files:
   - split: train
-    path: "parquet/category_knn.parquet"
+    path: "category_knn/*.parquet"
 - config_name: topic_nodes
   default: false
   data_files:
   - split: train
-    path: "parquet/topic_nodes.parquet"
+    path: "topic_nodes/*.parquet"
 - config_name: paper_topic_edges
   default: false
   data_files:
   - split: train
-    path: "parquet/paper_topic_edges.parquet"
+    path: "paper_topic_edges/*.parquet"
 - config_name: year_nodes
   default: false
   data_files:
   - split: train
-    path: "parquet/year_nodes.parquet"
+    path: "year_nodes/*.parquet"
 - config_name: paper_year_edges
   default: false
   data_files:
   - split: train
-    path: "parquet/paper_year_edges.parquet"
+    path: "paper_year_edges/*.parquet"
 - config_name: paper_embeddings
   default: false
   data_files:
   - split: train
-    path: "parquet/paper_embeddings.parquet"
+    path: "paper_embeddings/*.parquet"
 - config_name: paper_fulltext_embeddings
   default: false
   data_files:
   - split: train
-    path: "parquet/paper_fulltext_embeddings.parquet"
+    path: "paper_fulltext_embeddings/*.parquet"
 ---
-# Generated from Research Library:
-https://github.com/peytontolbert/Research_Library
 
 # Paper Universe Graph Dataset
 
@@ -105,6 +103,24 @@ This dataset preserves:
 - `paper_embeddings`: `1000000` rows
 - `paper_fulltext_embeddings`: `1000000` rows
 
+## Loading
+
+```python
+from datasets import load_dataset
+
+paper_nodes = load_dataset("YOUR_NAMESPACE/YOUR_DATASET", "paper_nodes")
+paper_category_edges = load_dataset("YOUR_NAMESPACE/YOUR_DATASET", "paper_category_edges")
+paper_knn = load_dataset("YOUR_NAMESPACE/YOUR_DATASET", "paper_knn")
+category_nodes = load_dataset("YOUR_NAMESPACE/YOUR_DATASET", "category_nodes")
+category_knn = load_dataset("YOUR_NAMESPACE/YOUR_DATASET", "category_knn")
+topic_nodes = load_dataset("YOUR_NAMESPACE/YOUR_DATASET", "topic_nodes")
+paper_topic_edges = load_dataset("YOUR_NAMESPACE/YOUR_DATASET", "paper_topic_edges")
+year_nodes = load_dataset("YOUR_NAMESPACE/YOUR_DATASET", "year_nodes")
+paper_year_edges = load_dataset("YOUR_NAMESPACE/YOUR_DATASET", "paper_year_edges")
+paper_embeddings = load_dataset("YOUR_NAMESPACE/YOUR_DATASET", "paper_embeddings")
+paper_fulltext_embeddings = load_dataset("YOUR_NAMESPACE/YOUR_DATASET", "paper_fulltext_embeddings")
+```
+
 ## Notes
 
 - `paper_nodes` stores metadata references and coordinates, not the full paper body.