DTAT: backend._config and Imageio fix (#303)

* Add files via upload

* style, typos

* attempt fix: imread.v3

* Update features.py

* attempt fix: npz instead of npy

* u

* reverted to normal

* fix: imageio.v3 as iio

Author: Pwhsky

deeptrack/features.py

@@ -4533,9 +4533,9 @@ def get(
 
         # Try to load the image using various readers.
         try:
-            import imageio
+            import imageio.v3 as iio
 
-            image = [imageio.v3.imread(file) for file in path]
+            image = [iio.imread(file) for file in path]
         except (IOError, ImportError, AttributeError):
             try:
                 image = [np.load(file, **load_options) for file in path]

tutorials/3-advanced-topics/DTAT399F_backend._config.ipynb

@@ -0,0 +1,171 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# deeptrack.backend._config\n",
+    "\n",
+    "<a href=\"https://colab.research.google.com/github/DeepTrackAI/DeepTrack2/blob/develop/tutorials/3-advanced-topics/DTAT399F_backend._config.ipynb\" target=\"_parent\"><img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open In Colab\"/></a>"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "# !pip install deeptrack  # Uncomment if running on Colab/Kaggle."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "This advanced tutorial introduces the backend._config module."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## 1. What is `_config`?\n",
+    "\n",
+    "The `_config` module defines a configuration management system for handling devices (CPU/GPU) and numerical computation backend libraries like `numpy`, `cupy`, `torch`."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## 2. Instancing a Config object"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from deeptrack.backend._config import Config\n",
+    "\n",
+    "configuration = Config()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## 3. Setting Device to GPU\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "name": "stderr",
+     "output_type": "stream",
+     "text": [
+      "/tmp/ipykernel_10742/2569479069.py:1: DeprecationWarning: (enable/disable)_gpu is deprecated. Use set_device instead\n",
+      "  configuration.enable_gpu()\n"
+     ]
+    }
+   ],
+   "source": [
+    "configuration.set_device(\"gpu\")\n",
+    "\n",
+    "# Or equivalently:\n",
+    "configuration.enable_gpu() # Deprecated but available for compatability."
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## 4. Disabling GPU\n",
+    "Disabling the GPU, and thus enabling the CPU is done with the `set_device` function."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": 47,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "configuration.set_device(\"cpu\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## 5. Set Backend library to Torch\n",
+    "By default, the backend computation library is Numpy, but this can be changed with the `set_backend` function."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "configuration.set_backend_torch() \n",
+    "\n",
+    "# Or equivalently:\n",
+    "configuration.set_backend(\"torch\")"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "## 5. Enabling/Disabling Image Wrapping\n",
+    "Image wrapping is a function which wraps the output of a feature into a list for formatting purposes. By default this is disabled.\n",
+    "To enable Image Wrapping in the config file, you specify this with the `enable_mage_wrapper()` function."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/plain": [
+       "<deeptrack.backend._config.Config.wrapper_enabled_context.<locals>.NullContext at 0x7f5419416a10>"
+      ]
+     },
+     "execution_count": 58,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "configuration.enable_image_wrapper()"
+   ]
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": ".venv",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.10.12"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}