growing emoji example: store gif in task/figures/ dir

Author: henrykrumb

ncalab/utils.py

@@ -61,7 +61,7 @@ def pad_input(x: torch.Tensor, nca: "BasicNCAModel", noise: bool = True) -> torc
     return x
 
 
-def NCALab_banner():
+def print_NCALab_banner():
     """
     Show NCALab banner on terminal.
     """

tasks/growing_emoji/.gitignore

@@ -1,2 +1,5 @@
 # search results
 *.csv
+
+# generated figures
+figures/

tasks/growing_emoji/eval_growing_emoji.py

@@ -1,11 +1,18 @@
 #!/usr/bin/env python3
 import os
 import sys
+from pathlib import Path
 
 root_dir = os.path.abspath(os.path.join(os.path.dirname(__file__), "../.."))
 sys.path.append(root_dir)
 
-from ncalab import GrowingNCAModel, WEIGHTS_PATH, get_compute_device
+from ncalab import (
+    GrowingNCAModel,
+    WEIGHTS_PATH,
+    get_compute_device,
+    print_NCALab_banner,
+    fix_random_seed,
+)
 
 import click
 
@@ -14,6 +21,10 @@
 import matplotlib.pyplot as plt  # type: ignore[import-untyped]
 import matplotlib.animation as animation  # type: ignore[import-untyped]
 
+TASK_PATH = Path(__file__).parent
+FIGURE_PATH = TASK_PATH / "figures"
+FIGURE_PATH.mkdir(exist_ok=True)
+
 
 @click.command()
 @click.option(
@@ -23,6 +34,9 @@
     "--gpu-index", type=int, default=0, help="Index of GPU to use, if --gpu in use."
 )
 def eval_growing_emoji(gpu: bool, gpu_index: int):
+    print_NCALab_banner()
+    fix_random_seed()
+
     device = get_compute_device(f"cuda:{gpu_index}" if gpu else "cpu")
 
     nca = GrowingNCAModel(
@@ -60,7 +74,9 @@ def update(i):
         repeat=True,
         repeat_delay=3000,
     )
-    animation_fig.save("artwork/growing_emoji.gif")
+    out_path = FIGURE_PATH / "growing_emoji.gif"
+    animation_fig.save(out_path)
+    click.secho(f"Done. You'll find the generated GIF in {out_path} .")
 
 
 if __name__ == "__main__":

tasks/growing_emoji/finetune_growing_emoji.py

@@ -23,7 +23,7 @@
     BasicNCATrainer,
     WEIGHTS_PATH,
     get_compute_device,
-    NCALab_banner,
+    print_NCALab_banner,
     print_mascot,
     fix_random_seed,
 )
@@ -32,7 +32,7 @@
 def finetune_growing_emoji(
     batch_size: int, hidden_channels: int, gpu: bool, gpu_index: int
 ):
-    NCALab_banner()
+    print_NCALab_banner()
     print_mascot(
         "Things are getting really exciting now!\n"
         "You're about to finetune a pre-trained NCA\n"

tasks/growing_emoji/search_growing_emoji.py

@@ -15,7 +15,7 @@
     GrowingNCADataset,
     GrowingNCAModel,
     get_compute_device,
-    NCALab_banner,
+    print_NCALab_banner,
     print_mascot,
     ParameterSearch,
     ParameterSet,
@@ -35,7 +35,7 @@ def search_growing_emoji(
     Main function to run the "growing emoji search" example task.
     """
     # Display prologue
-    NCALab_banner()
+    print_NCALab_banner()
     print_mascot(
         "You are about to run a hyperparameter search.\n"
         "\n"

tasks/growing_emoji/train_growing_emoji.py

@@ -14,14 +14,12 @@
 sys.path.append(root_dir)
 
 from ncalab import (
-    AutoStepper,
     GrowingNCADataset,
     GrowingNCAModel,
     BasicNCATrainer,
     WEIGHTS_PATH,
     get_compute_device,
-    NCALab_banner,
-    print_mascot,
+    print_NCALab_banner,
     fix_random_seed,
     Pool,
 )
@@ -38,20 +36,11 @@ def train_growing_emoji(
     :param batch_size [int]: Minibatch size.
     :param hidden_channels [int]: Hidden channels the NCA will use.
     """
-    # Display prologue
-    NCALab_banner()
-    print_mascot(
-        "You are about to run the growing lizard emoji example,\n"
-        "a true NCA classic! To learn more about it, visit:\n"
-        "\n"
-        "https://distill.pub/2020/growing-ca/ \n"
-        "(Ctrl+click to open URL)\n"
-    )
-    print()
+    print_NCALab_banner()
     fix_random_seed()
 
     # Create tensorboard summary writer
-    writer = SummaryWriter(comment="Growing NCA (Lizard)")
+    writer = SummaryWriter(comment=" Growing NCA (Lizard)")
 
     # Select device, try to use GPU or fall back to CPU
     device = get_compute_device(f"cuda:{gpu_index}" if gpu else "cpu")