doc: guide to avoid importing module in wrong place

nubison · Dec 9, 2024 · fde4981 · fde4981
1 parent 08a259d
commit fde4981
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/example/model.ipynb b/example/model.ipynb
@@ -14,6 +14,8 @@
    "outputs": [],
    "source": [
     "# The `NubisonModel` class serves as a base class for creating custom user model classes.\n",
+    "# Note that modules required by UserModel must be imported within the NubisonModel class.\n",
+    "# This is because the UserModel is cloudpickled, and using modules imported outside of the NubisonModel class will cause errors.\n",
     "from nubison_model import NubisonModel\n",
     "\n",
     "class UserModel(NubisonModel):\n",