[SC-7587] Add logging image example to implement_custom_tests.ipynb notebook

notebooks/code_samples/custom_tests/implement_custom_tests.ipynb

@@ -200,7 +200,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 3,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -362,7 +362,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 7,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -395,7 +395,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": null,
+   "execution_count": 8,
    "metadata": {},
    "outputs": [],
    "source": [
@@ -806,6 +806,44 @@
     "![screenshot showing image custom test](../../images/image-in-custom-metric.png)"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "If you want to log an image as a test result, you can do so by passing the path to the image as a parameter to the custom test and then opening the file in the test function. Here's an example:"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "@vm.test(\"my_custom_tests.MyPNGCorrelationMatrix\")\n",
+    "def Image(path: str):\n",
+    "    \"\"\"Opens a png image file and logs it as a test result to ValidMind\"\"\"\n",
+    "    if not path.endswith(\".png\"):\n",
+    "        raise ValueError(\"Image must be a PNG file\")\n",
+    "\n",
+    "    # return raw image bytes\n",
+    "    with open(path, \"rb\") as f:\n",
+    "        return f.read()\n",
+    "    \n",
+    "run_test(\n",
+    "    \"my_custom_tests.MyPNGCorrelationMatrix\",\n",
+    "    params={\"path\": \"../../images/pearson-correlation-matrix.png\"},\n",
+    ").log()"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "The image is displayed in the test result:\n",
+    "\n",
+    "![screenshot showing image from file](../../images/pearson-correlation-matrix-test-output.png)"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -906,7 +944,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.13"
+   "version": "3.10.13"
   }
  },
  "nbformat": 4,

pyproject.toml

@@ -10,7 +10,7 @@ description = "ValidMind Library"
 license = "Commercial License"
 name = "validmind"
 readme = "README.pypi.md"
-version = "2.6.3"
+version = "2.6.4"
 
 [tool.poetry.dependencies]
 python = ">=3.8.1,<3.12"

validmind/__version__.py

@@ -1 +1 @@
-__version__ = "2.6.3"
+__version__ = "2.6.4"