Update version to 1.2.0 (#109)

* Update version and changelog
* Updated author email address
* Removed duplicated line of code
* Remove unnecessary "the" in document title

---------

Co-authored-by: Lukas Fehring <lukas.ferhing@stud.uni-hannover.de>

Author: tornede

.github/workflows/tests.yml

@@ -26,9 +26,6 @@ jobs:
         with:
           virtualenvs-create: true
           virtualenvs-in-project: true
-      - name: Disable Modern Dependency Installation
-        id: poetry-disable-modern
-        run: poetry config installer.modern-installation false
       - name: Load cached venv
         id: cached-poetry-dependencies
         uses: actions/cache@v3

AUTHORS.rst

@@ -7,7 +7,7 @@ Core Development Team
 
 - `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:fehring2@mail.uni-paderborn.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]/>`_

CHANGELOG.rst

@@ -2,6 +2,39 @@
 Changelog
 =========
 
+
+v1.2.0 (03/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/usage/execution.rst

@@ -1,7 +1,7 @@
 .. _execution:
 
 ============================
-Executing the PyExperimenter
+Executing PyExperimenter
 ============================
 
 The actual execution of ``PyExperimenter`` only needs a few lines of code. Please make sure that you have created the :ref:`experiment configuration file <experiment_configuration_file>` and defined the :ref:`experiment function <experiment_function>` beforehand. 

py_experimenter/database_connector.py

@@ -1,7 +1,6 @@
 import abc
 import logging
 from configparser import ConfigParser
-from datetime import datetime
 from typing import Dict, List, Optional, Tuple, Union
 
 import pandas as pd
@@ -320,8 +319,8 @@ def delete_table(self) -> None:
         self.execute(cursor, f'DROP TABLE IF EXISTS {self.table_name}')
         self.commit(connection)
 
-    def get_logtable(self, table_name: str) -> pd.DataFrame:
-        return self.get_table(f'{self.table_name}__{table_name}')
+    def get_logtable(self, logtable_name: str) -> pd.DataFrame:
+        return self.get_table(f'{self.table_name}__{logtable_name}')
 
     def get_table(self, table_name: Optional[str] = None) -> pd.DataFrame:
         connection = self.connect()

py_experimenter/result_processor.py

@@ -31,8 +31,7 @@ def __init__(self, _config: dict, credential_path, table_name: str, result_field
         self._timestamp_on_result_fields = utils.timestamps_for_result_fields(self._config)
 
         self._experiment_id = experiment_id
-        self._experiment_id = experiment_id
-        self._experiment_id_condition = f'ID = {experiment_id}'
+        self._experiment_id_condition = f'ID = {self._experiment_id}'
 
         if _config['PY_EXPERIMENTER']['provider'] == 'sqlite':
             self._dbconnector: DatabaseConnector = DatabaseConnectorLITE(_config)

pyproject.toml

@@ -1,11 +1,11 @@
 [tool.poetry]
 name = "py-experimenter"
-version = "1.1.0"
+version = "1.2.0"
 description = "The PyExperimenter is a tool for the automatic execution of experiments, e.g. for machine learning (ML), capturing corresponding results in a unified manner in a database."
 authors = [
     "Tanja Tornede <t.tornede@ai.uni-hannover.de>",
     "Alexander Tornede <a.tornede@ai.uni-hannover.de>",
-    "Lukas Fehring <fehring2@mail.uni-paderborn.de>",
+    "Lukas Fehring <lukas.fehring@stud.uni-hannover.de>",
     "Lukas Gehring",
     "Helena Graf <h.graf@ai.uni-hannover.de>",
     "Jonas Hanselle <jonas.hanselle@upb.de>",