Merge pull request #42 from score-p/feature/scorep_feedback

Feature/scorep feedback

Author: elwer

.github/workflows/unit_test.yml

@@ -11,7 +11,7 @@ on:
 
 jobs:
   build:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     steps:
       # Checks-out repository under $GITHUB_WORKSPACE
       - uses: actions/checkout@v4
@@ -49,8 +49,8 @@ jobs:
         
       - name: Run userpersistence tests
         run: |
-          python -m unittest tests/test_userpersistence.py
+          python -m unittest tests.test_userpersistence
           
       - name: Run kernel tests
         run: |
-          python -m unittest tests/test_kernel.py
+          python -m unittest tests.test_kernel

README.md

@@ -152,6 +152,17 @@ MODE=[disk,memory]
 ```
 
 When using persistence in `disk` mode, user can also define directory to which serializer output will be saved with `SCOREP_KERNEL_PERSISTENCE_DIR` environment variable.
+```
+%env SCOREP_KERNEL_PERSISTENCE_DIR=path/to/dir
+```
+To see the detailed report for marshalling steps - `JUMPER_MARSHALLING_DETAILED_REPORT` environment variable can be set.
+```
+%env JUMPER_MARSHALLING_DETAILED_REPORT=1
+```
+You can disable visual animations shown during long-running tasks by setting the `JUMPER_DISABLE_PROCESSING_ANIMATIONS` environment variable.
+```
+%env JUMPER_DISABLE_PROCESSING_ANIMATIONS=1
+```
 
 `%%execute_with_scorep`
 
@@ -235,6 +246,11 @@ Similar yields for cloudpickle. Use the `%%marshalling_settings` magic command t
 
 When dealing with big data structures, there might be a big runtime overhead at the beginning and the end of a Score-P cell. This is due to additional data saving and loading processes for persistency in the background. However this does not affect the actual user code and the Score-P measurements.
 
+## Logging Configuration
+To adjust logging and obtain more detailed output about the behavior of the JUmPER kernel, refer to the `src/logging_config.py` file.
+
+This file contains configuration options for controlling the verbosity, format, and destination of log messages. You can customize it to suit your debugging or monitoring needs.
+
 # Future Work
 
 The kernel is still under development. The following is on the agenda:

examples/ExampleBasic.ipynb

@@ -466,19 +466,75 @@
   {
    "cell_type": "markdown",
    "metadata": {},
-   "source": []
+   "source": [
+    "### Large array processing with Score-P\n",
+    "This example illustrates the steps involved in the marshalling process when a cell instrumented with Score-P is executed with a large data payload as input.\n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import time\n",
+    "import numpy as np\n",
+    "\n",
+    "def generate_array_with_size(size_mb, dtype=np.float32):\n",
+    "    size_bytes = size_mb * 1024 * 1024\n",
+    "    element_size = np.dtype(dtype).itemsize\n",
+    "    num_elements = size_bytes // element_size\n",
+    "    array = np.zeros(num_elements, dtype=dtype)\n",
+    "    return array\n",
+    "\n",
+    "big_array = generate_array_with_size(size_mb=1000)"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Enable marshalling detailed report for each step."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "%env JUMPER_MARSHALLING_DETAILED_REPORT=1"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Run cell with Score-P"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "%%execute_with_scorep\n",
+    "big_array\n",
+    "time.sleep(4)"
+   ]
   }
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "scorep-python",
+   "display_name": "JUmPER",
    "language": "python",
-   "name": "scorep-python"
+   "name": "jumper"
   },
   "language_info": {
    "file_extension": ".py",
    "mimetype": "text/plain",
-   "name": "Any text"
+   "name": "python"
   }
  },
  "nbformat": 4,