Update README.md

README.md

@@ -20,6 +20,10 @@ license: apache-2.0
 
 ![ROOTS Dataset Scatterplot](./datashader.png)
 
+What follows is research code. It is by no means optimized for speed, efficiency, or readability.
+
+## Data loading, tokenizing and sharding
+
 ```python
 import os
 import numpy as np
@@ -53,6 +57,7 @@ dset = load_dataset(..., split="train")
 
 dset = dset.map(batch_tokenize, batched=True, batch_size=64, num_proc=28)
 
+dset_name = "roots_subset"
 max_shard_size = convert_file_size_to_int('300MB')
 dataset_nbytes = dset.data.nbytes
 num_shards = int(dataset_nbytes / max_shard_size) + 1
@@ -63,6 +68,11 @@ for shard_index in tqdm(range(num_shards)):
     shard = dset.shard(num_shards=num_shards, index=shard_index, contiguous=True)
     shard.to_parquet(f"{dset_name}/tokenized/tokenized-{shard_index:03d}.parquet")
 
+```
+
+## Embedding
+
+```python
 client = Client() # To keep track of dask computation
 client
 
@@ -90,7 +100,11 @@ tsne = TSNE(
 )
 
 tsne_embedding = tsne.fit(X)
+```
+
+## Plotting
 
+```python
 df = pd.DataFrame(data=tsne_embedding, columns=['x','y'])
 agg = ds.Canvas(plot_height=600, plot_width=600).points(df, 'x', 'y')
 img = ds.tf.shade(agg, cmap=cc.fire, how='eq_hist')