Add example

README.md

@@ -19,6 +19,8 @@ print(list(tracker))
 display(tracker.to_frame())
 ```
 
+See our example of [visualising transformer activations & gradients using UMAP](tests/Example.ipynb).
+
 ## License
 
 Copyright (c) 2023 Graphcore Ltd. Licensed under the MIT License ([LICENSE](LICENSE)).

dev

@@ -130,6 +130,19 @@ def doc() -> None:
             "tensor_tracker",
         ]
     )
+    run(
+        [
+            "jupyter",
+            "nbconvert",
+            "--to",
+            "html",
+            "tests/Example.ipynb",
+            "--output-dir",
+            "doc/tensor_tracker",
+            "--output",
+            "example.html",
+        ]
+    )
 
 
 @cli("--skip", nargs="*", default=[], help="commands to skip")

requirements-dev.txt

@@ -1,8 +1,8 @@
 -r requirements.txt
 black
 flake8
-ipykernel
 isort
+jupyter
 mypy
 pandas
 pandas-stubs

tensor_tracker/core.py

@@ -33,6 +33,8 @@
 
  - Manually register/unregister hooks:
   `tracker = Tracker(); tracker.register(...); tracker.unregister()`
+
+See also: example of [visualising transformer activations & gradients using UMAP](example.html).
 """
 
 import dataclasses