nit

Author: tcchiao

doc/demo.ipynb

@@ -2,10 +2,10 @@
  "cells": [
   {
    "cell_type": "markdown",
-   "id": "registered-bahrain",
+   "id": "vocal-florida",
    "metadata": {},
    "source": [
-    "# xbatcher demo\n",
+    "# demo\n",
     "\n",
     "Author: Cindy Chiao\n",
     "Last Modified: Nov 16, 2021\n",
@@ -21,7 +21,7 @@
   {
    "cell_type": "code",
    "execution_count": 1,
-   "id": "engaged-nicaragua",
+   "id": "stable-worst",
    "metadata": {},
    "outputs": [],
    "source": [
@@ -32,7 +32,7 @@
   },
   {
    "cell_type": "markdown",
-   "id": "violent-walker",
+   "id": "stopped-syndication",
    "metadata": {},
    "source": [
     "## Example data\n",
@@ -43,7 +43,7 @@
   {
    "cell_type": "code",
    "execution_count": 2,
-   "id": "furnished-vanilla",
+   "id": "involved-insulin",
    "metadata": {},
    "outputs": [
     {
@@ -566,7 +566,7 @@
   {
    "cell_type": "code",
    "execution_count": 3,
-   "id": "motivated-sustainability",
+   "id": "extended-springfield",
    "metadata": {},
    "outputs": [
     {
@@ -599,7 +599,7 @@
   },
   {
    "cell_type": "markdown",
-   "id": "muslim-policy",
+   "id": "incorrect-spank",
    "metadata": {},
    "source": [
     "## Batch generation\n",
@@ -614,7 +614,7 @@
   {
    "cell_type": "code",
    "execution_count": 4,
-   "id": "brown-danish",
+   "id": "superb-riverside",
    "metadata": {},
    "outputs": [
     {
@@ -1040,7 +1040,7 @@
   },
   {
    "cell_type": "markdown",
-   "id": "supported-equipment",
+   "id": "czech-covering",
    "metadata": {},
    "source": [
     "We can verify that the outputs have the expected shapes. \n",
@@ -1051,7 +1051,7 @@
   {
    "cell_type": "code",
    "execution_count": 5,
-   "id": "equal-profile",
+   "id": "brilliant-period",
    "metadata": {},
    "outputs": [
     {
@@ -1069,7 +1069,7 @@
   },
   {
    "cell_type": "markdown",
-   "id": "approximate-hurricane",
+   "id": "polished-change",
    "metadata": {},
    "source": [
     "There are 145 lat points and 192 lon points, thus we're expecting 145 * 192 = 27840 samples in a batch."
@@ -1078,7 +1078,7 @@
   {
    "cell_type": "code",
    "execution_count": 6,
-   "id": "identified-prototype",
+   "id": "tamil-wagon",
    "metadata": {},
    "outputs": [
     {
@@ -1096,7 +1096,7 @@
   },
   {
    "cell_type": "markdown",
-   "id": "tropical-danish",
+   "id": "seeing-straight",
    "metadata": {},
    "source": [
     "## Controlling the size/shape of batches\n",
@@ -1107,7 +1107,7 @@
   {
    "cell_type": "code",
    "execution_count": 7,
-   "id": "circular-array",
+   "id": "confused-consent",
    "metadata": {},
    "outputs": [
     {
@@ -1559,7 +1559,7 @@
   },
   {
    "cell_type": "markdown",
-   "id": "broadband-romance",
+   "id": "regulated-double",
    "metadata": {},
    "source": [
     "## Last batch behavior\n",
@@ -1570,7 +1570,7 @@
   {
    "cell_type": "code",
    "execution_count": 8,
-   "id": "funny-garbage",
+   "id": "fatty-satellite",
    "metadata": {},
    "outputs": [
     {
@@ -2005,7 +2005,7 @@
   },
   {
    "cell_type": "markdown",
-   "id": "affecting-preview",
+   "id": "sought-democracy",
    "metadata": {},
    "source": [
     "## Overlapping inputs\n",
@@ -2017,7 +2017,7 @@
   {
    "cell_type": "code",
    "execution_count": 9,
-   "id": "improved-coating",
+   "id": "improved-avatar",
    "metadata": {},
    "outputs": [
     {
@@ -2473,7 +2473,7 @@
   },
   {
    "cell_type": "markdown",
-   "id": "contrary-throat",
+   "id": "raising-acrylic",
    "metadata": {},
    "source": [
     "We can inspect the samples in a batch for a lat/lon pixel, noting that the overlap only applies within a batch and not across. Thus, within the 20 time points in a batch, we can get 11 samples each with 10 time points and 9 time points allowed to overlap."
@@ -2482,7 +2482,7 @@
   {
    "cell_type": "code",
    "execution_count": 10,
-   "id": "accepting-hundred",
+   "id": "colored-recipe",
    "metadata": {},
    "outputs": [
     {
@@ -2944,7 +2944,7 @@
   },
   {
    "cell_type": "markdown",
-   "id": "enclosed-investing",
+   "id": "democratic-horse",
    "metadata": {},
    "source": [
     "## Example applications\n",
@@ -2957,7 +2957,7 @@
   {
    "cell_type": "code",
    "execution_count": 11,
-   "id": "vulnerable-terminology",
+   "id": "fatal-reflection",
    "metadata": {},
    "outputs": [
     {
@@ -3005,7 +3005,7 @@
   },
   {
    "cell_type": "markdown",
-   "id": "primary-dance",
+   "id": "minus-sphere",
    "metadata": {},
    "source": [
     "We can also use the Xarray's \"stack\" method to transform these into 2D inputs (n_samples, n_features) suitable for other machine learning algorithms implemented in libraries such as [sklearn](https://scikit-learn.org/stable/) and [xgboost](https://xgboost.readthedocs.io/en/stable/). In this case, we are expecting 9 x 9 x 9 = 729 features total."
@@ -3014,7 +3014,7 @@
   {
    "cell_type": "code",
    "execution_count": 12,
-   "id": "numerous-computer",
+   "id": "future-honey",
    "metadata": {},
    "outputs": [
     {
@@ -3055,14 +3055,15 @@
   },
   {
    "cell_type": "markdown",
-   "id": "addressed-collapse",
+   "id": "russian-transaction",
    "metadata": {},
    "source": [
     "## What's next?\n",
     "\n",
     "There are many additional useful features that were yet to be implemented in the context of batch generation for downstream machine learning model training purposes. One of the current efforts is adding a set of data loaders (see [working PR for PyTorch data loader](https://github.com/pangeo-data/xbatcher/pull/25)). \n",
     "\n",
     "Additional features of interest can include: \n",
+    "\n",
     "1. Handling overlaps across batches. The common use case of batching in machine learning training involves generating all samples, then group them into batches. When overlap is enabled, this yields different results compared to first generating batches then creating possible samples within each batch. \n",
     "\n",
     "2. Shuffling/randomization of samples across batches. It is often desirable for each batch to be grouped randomly instead of along a specific dimension. \n",
@@ -3072,13 +3073,13 @@
     "4. Handling preprocessing steps. For example, data augmentation, scaling/normalization, outlier detection, etc. \n",
     "\n",
     "\n",
-    "Interested users are welcomed to submit an issue in GitHub. "
+    "More thoughts on 1. and 2. can be found in [this issue](https://github.com/pangeo-data/xbatcher/issues/30). Interested users are welcomed to comment or submit other issues in GitHub. "
    ]
   },
   {
    "cell_type": "code",
    "execution_count": null,
-   "id": "continent-property",
+   "id": "analyzed-saudi",
    "metadata": {},
    "outputs": [],
    "source": []