Update README.md

README.md

@@ -87,7 +87,9 @@ configs:
     path: data/train-*
 ---
 
-# Converting script
+# Descriptions
+
+## Converting script
 
 ```py
 import pickle
@@ -152,9 +154,42 @@ ds = Dataset.from_generator(gen)
 ds = ds.with_format("numpy")
 
 ds.push_to_hub("MLDS-NUS/polymer-dynamics_experimental-data")
+
+
+# upload by configs
+def gen(folder: str):
+
+    with open(DATA_DIR / f"{folder}.pkl", "rb") as f:
+        data = pickle.load(f)
+
+    for k, v in data.items():
+        frame = np.clip(v, 0, 255).astype(np.uint8)
+        left_rights = calc_left_right(255 - frame)
+        barycenters = calc_barycenter(255 - frame)
+
+        yield {
+            "config": folder,
+            "traj_id": k,
+            "shape": list(frame.shape),
+            "data": frame,
+            "left_right": left_rights,
+            "barycenter": barycenters,
+        }
+
+
+for config_name in ["30V_Jan24", "60V_Dec24"]:
+    ds = Dataset.from_generator(lambda cn=config_name: gen(cn))
+    ds = ds.with_format("numpy")
+
+    ds.push_to_hub(
+        "MLDS-NUS/polymer-dynamics_experimental-data",
+        config_name=config_name,
+        data_dir=f"{config_name}",
+    )
+
 ```
 
-# How to use
+## How to use
 
 Directly loading by [datasets](https://huggingface.co/docs/datasets/installation) is supported now!
 
@@ -163,11 +198,12 @@ from datasets import load_dataset
 import numpy as np
 
 
-hf_dataset = load_dataset("MLDS-NUS/polymer-dynamics_experimental-data")
-hf_dataset = hf_dataset.with_format("numpy")["train"]
+hf_dataset_30V = load_dataset("MLDS-NUS/polymer-dynamics_experimental-data", config_name="30V_Jan24")
+hf_dataset_60V = load_dataset("MLDS-NUS/polymer-dynamics_experimental-data", config_name="60V_Jan24")
+
+hf_dataset_30V = hf_dataset_30V.with_format("numpy")["train"]
+hf_dataset_60V = hf_dataset_60V.with_format("numpy")["train"]
 
-hf_dataset_30V = hf_dataset.filter(lambda x: x["config"] == "30V_Jan24")
-hf_dataset_60V = hf_dataset.filter(lambda x: x["config"] == "60V_Dec24")
 
 for sample in hf_dataset_30V:
   for k, v in sample.items():
@@ -188,3 +224,41 @@ left_right: <class 'numpy.ndarray'>, shape=(160, 2), dtype=int64
 barycenter: <class 'numpy.ndarray'>, shape=(160, 2), dtype=float32
 ```
 
+## How to contribute
+
+```py
+import numpy as np
+from datasets import Dataset
+
+
+def gen(config_name: str):
+
+    for data in get_database(config_name):
+
+        frame = ...
+        traj_id = ...
+        shape = ...
+        left_rights = ...
+        barycenters = ...
+
+        yield {
+            "config": config_name,
+            "traj_id": traj_id,
+            "shape": shape,
+            "data": data, # a np.ndarray object of shape `shape`
+            "left_right": left_rights,
+            "barycenter": barycenters,
+        }
+
+
+config_name = ...
+ds = Dataset.from_generator(lambda cn=config_name: gen(cn))
+ds = ds.with_format("numpy")
+
+ds.push_to_hub(
+    "MLDS-NUS/polymer-dynamics_experimental-data",
+    config_name=config_name,
+    data_dir=f"{config_name}",
+)
+
+```