Merge pull request #110 from tornede/develop

Update version to 1.2.0

- Feature
  - Added logtables functionality, allowing to incrementally log information during the execution of an experiment, which is described in detail in the documentation.
  - Documentation of the usage of ``PyExperimenter`` has been reworked in large parts. 
- Examples
  - An additional logtable example has been added.
  - An issue of the example notebook has been fixed causing them to fail due to missing directories. 
  - Improved general example to cover extended functionality of ``PyExperimenter.reset_experiments()``.
- Fix
  - Start date is now set when pulling an experiment.
  - Supported Python version is now >= 3.9.
  - Changed row identification in ResultProcessor to experiment ID instead of checking keyfields.
  - Stack traces are now correctly logged into the mysql database, as the used mysql connector implementation has been changed to C. 
  - Changed multiprocessing to joblib due to issues with the example notebooks.
  - The ``random_order`` parameter is not needed anymore for the execution, therefore it has been removed. 
  - Documentation of ``PyExperimenter.reset_experiments()`` has been updated to reflect the changes in the functionality.
- Tests
  - Tests covering the new functionality of logtables have been added.

Author: tornede

.github/workflows/tests.yml

@@ -8,7 +8,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ "ubuntu-latest", "macos-latest", "windows-latest" ]
-        python-version: [ "3.7", "3.8", "3.9", ]
+        python-version: ["3.9", ]
     defaults:
       run:
         shell: bash
@@ -41,4 +41,4 @@ jobs:
         run: |
           source $VENV
           # Ignore the MySQL test, as it requires a MySQL server:
-          pytest --ignore=test/test_run_experiments/test_run_mysql_experiment.py
+          pytest --ignore=test/test_run_experiments/test_run_mysql_experiment.py --ignore=test/test_logtables/test_mysql.py

.vscode/settings.json

@@ -2,6 +2,7 @@
 	"autoDocstring.docstringFormat": "sphinx",
 	"editor.codeActionsOnSave": {
 		"source.organizeImports": true,
+		"formatting": true
 	},
 	"editor.formatOnSave": true,
 	"python.formatting.autopep8Args": [
@@ -30,6 +31,8 @@
 		"iterrows",
 		"keyfield",
 		"keyfields",
+		"logtable",
+		"logtables",
 		"meshgrid",
 		"resultfields",
 		"Tanja",
@@ -39,6 +42,9 @@
 	"terminal.integrated.env.linux": {
 		"PYTHONPATH": "${workspaceFolder}"
 	},
+	"terminal.integrated.env.windows": {
+		"PYTHONPATH": "${workspaceFolder}"
+	},
 	"jupyter.notebookFileRoot": "${workspaceFolder}",
 	"restructuredtext.confPath": "${workspaceFolder}\\docs",
 	"python.pythonPath": "~/anaconda3/envs/py-experimenter",
@@ -51,5 +57,6 @@
 		"**/.git/objects/**": true,
 		"**/.git/subtree-cache/**": true,
 		"**/node_modules/*/**": true
-	}
+	},
+	"esbonio.sphinx.confDir": "${workspaceFolder}/docs/source"
 }

AUTHORS.rst

@@ -5,10 +5,10 @@ Authors
 Core Development Team
 ---------------------
 
-- `Tanja Tornede <mailto:tanja.tornede@upb.de?subject=[PyExperimenter]/>`_
-- `Alexander Tornede <mailto:alexander.tornede@upb.de?subject=[PyExperimenter]/>`_
-- `Lukas Fehring <mailto:fehring2@mail.uni-paderborn.de?subject=[PyExperimenter]/>`_
-- `Helena Graf <mailto:helena.graf@upb.de?subject=[PyExperimenter]/>`_
+- `Tanja Tornede <mailto:t.tornede@ai.uni-hannover.de?subject=[PyExperimenter]/>`_
+- `Alexander Tornede <mailto:a.tornede@ai.uni-hannover.de?subject=[PyExperimenter]/>`_
+- `Lukas Fehring <mailto:lukas.fehring@stud.uni-hannover.de?subject=[PyExperimenter]/>`_
+- `Helena Graf <mailto:h.graf@ai.uni-hannover.de?subject=[PyExperimenter]/>`_
 - `Jonas Hanselle <mailto:jonas.hanselle@upb.de?subject=[PyExperimenter]/>`_
 - `Felix Mohr <mailto:felix.mohr@unisabana.edu.co?subject=[PyExperimenter]/>`_
 - `Marcel Wever <mailto:marcel.wever@ifi.lmu.de?subject=[PyExperimenter]/>`_

CHANGELOG.rst

@@ -2,6 +2,39 @@
 Changelog
 =========
 
+
+v1.2.0 (04/04/2023)
+===================
+
+Feature
+-------
+
+- Added logtables functionality, allowing to incrementally log information during the execution of an experiment, which is described in detail in the documentation.
+- Documentation of the usage of ``PyExperimenter`` has been reworked in large parts. 
+
+Examples
+--------
+- An additional logtable example has been added.
+- An issue of the example notebook has been fixed causing them to fail due to missing directories. 
+- Improved general example to cover extended functionality of ``PyExperimenter.reset_experiments()``.
+
+Fix
+---
+
+- Start date is now set when pulling an experiment.
+- Supported Python version is now >= 3.9.
+- Changed row identification in ResultProcessor to experiment ID instead of checking keyfields.
+- Stack traces are now correctly logged into the mysql database, as the used mysql connector implementation has been changed to C. 
+- Changed multiprocessing to joblib due to issues with the example notebooks.
+- The ``random_order`` parameter is not needed anymore for the execution, therefore it has been removed. 
+- Documentation of ``PyExperimenter.reset_experiments()`` has been updated to reflect the changes in the functionality.
+
+Tests
+-----
+
+- Tests covering the new functionality of logtables have been added.
+
+
 v1.1.0 (21/11/2022)
 ===================
 

docs/source/conf.py

@@ -59,6 +59,19 @@
 #
 html_theme = 'sphinx_rtd_theme'
 
+html_theme_options = {
+    'logo_only': False,
+    'display_version': True,
+    'prev_next_buttons_location': 'bottom',
+    'style_external_links': True,
+    # Toc options
+    'collapse_navigation': True,
+    'sticky_navigation': True,
+    'navigation_depth': 4,
+    'includehidden': True,
+    'titles_only': False
+}
+
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".