Upload README.md with huggingface_hub

README.md

@@ -5,4 +5,21 @@ configs:
   - split: train
     path: "*.parquet"
 ---
-Gemstones Training Dataset - Worker sharded version
+Gemstones Training Dataset - Worker sharded version
+
+**Disclaimer:** this is an approximation of the dataset used to train the Gemstones model suite. 
+Due to the randomized and sharded nature of the distributed training code, the only way to perfectly 
+reproduce the training bactches across the gpus is/was the run the training code. 
+This is the result of an attempt to simulate the way in which the training code loaded the data and
+stream it out to a portable file format for use in downstream analyses of the model suite.
+
+# Sharding format: worker parallel
+
+This version of th
+
+
+# Loading
+
+This data should be loadable using `load_dataset` in the standard manner to auto-download the data.
+Alternately, the dataset can be cloned using git to materialize the files locally, and then loaded
+using the default `parquet` builder as described here: https://huggingface.co/datasets/tomg-group-umd/gemstones_data_order_parallel